segmentUpdate
mutation

Choose a version:

Requires write_customers access scope. Also: The user must not have restricted access.

Updates a segment.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: Specifies the segment to be updated.
Anchor to name name String: The new name for the segment.
Anchor to query query String: A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers such as email_subscription_status = 'SUBSCRIBED' with this syntax.

Was this section helpful?

Anchor to section titled 'SegmentUpdatePayload returns'

SegmentUpdatePayload returns

Anchor to SegmentUpdatePayload.segment segment Segment: The updated segment.
Anchor to SegmentUpdatePayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: segmentUpdate

Query Reference for MUTATION: segmentUpdate

"mutation segmentUpdate($id: ID!) {\n  segmentUpdate(id: $id) {\n    segment {\n      # Segment fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: segmentUpdate

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\",\n  \"name\": \"<your-name>\",\n  \"query\": \"<your-query>\"\n}"

Schema Reference for MUTATION: segmentUpdate

""

Display Examples for MUTATION: segmentUpdate

[]

segmentUpdatemutation

Arguments

SegmentUpdatePayload returns

segmentUpdate
mutation