Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

segmentCreate

mutation

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

Creates a segment.

Arguments

Anchor to namename • String!required: The name of the segment to be created. Segment names must be unique.
Anchor to queryquery • String!required: 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 SegmentCreatePayload returnsSegmentCreatePayload returns

Anchor to segmentsegment • Segment: The newly created segment.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?