segmentUpdate

Updates a segment.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the segmentUpdate action (under Segment).
Fill in the fields below, then reference the result from later steps as {{segmentupdate.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 SegmentUpdate($id: ID!, $name: String, $query: String) {
  segmentUpdate(id: $id, 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.

idstringrequired

Specifies the segment to be updated.

namestring

The new name for the segment.

querystring

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

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

Response

Read the result with {{segmentupdate.response.data.data.segmentUpdate}}. If the API returns errors, the step fails and they are at {{segmentupdate.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?