segmentCreate
mutation

Choose a version:

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

Creates a segment.

Anchor to section titled 'Arguments'

Arguments

Anchor to name name String! required: The name of the segment to be created. Segment names must be unique.
Anchor to query query 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 section titled 'SegmentCreatePayload returns'

SegmentCreatePayload returns

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

Was this section helpful?

Code examples for MUTATION: segmentCreate

Query Reference for MUTATION: segmentCreate

"mutation segmentCreate($name: String!, $query: String!) {\n  segmentCreate(name: $name, query: $query) {\n    segment {\n      # Segment fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: segmentCreate

"{\n  \"name\": \"<your-name>\",\n  \"query\": \"<your-query>\"\n}"

Schema Reference for MUTATION: segmentCreate

""

Display Examples for MUTATION: segmentCreate

[]

segmentCreatemutation

Arguments

SegmentCreatePayload returns

segmentCreate
mutation