Skip to main content

Choose a version:

segmentUpdate

mutation

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

Updates a segment.

Arguments

Anchor to idid •ID!required: Specifies the segment to be updated.
Anchor to namename •String: The new name for the segment.
Anchor to queryquery •String: 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 SegmentUpdatePayload returnsSegmentUpdatePayload returns

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

Was this section helpful?