Skip to main content
mutation

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

Creates a segment.

•String!
required

The name of the segment to be created. Segment names must be unique.

•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

•Segment

The newly created segment.

•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?