segmentCreate

Creates a segment.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the segmentCreate action (under Segment).
Fill in the fields below, then reference the result from later steps as {{segmentcreate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation SegmentCreate($name: String!, $query: String!) {
  segmentCreate(name: $name, query: $query) {
    segment {
      creationDate
      id
      lastEditDate
      name
      query
    }
    userErrors {
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

namestringrequired

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

querystringrequired

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](https://shopify.dev/api/shopifyql/segment-query-language-reference).

json

{
  "name": "string",
  "query": "string"
}

Response

Read the result with {{segmentcreate.response.data.data.segmentCreate}}. If the API returns errors, the step fails and they are at {{segmentcreate.response.data.errors}}.

segmentobject

creationDatestring

idstring

lastEditDatestring

namestring

querystring

userErrorsarray<object>

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?