Anchor to section titled 'undefined'

segmentDelete
mutation

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

Deletes a segment.

Anchor to section titled 'Arguments'

Arguments

Anchor to id
id
ID!
required

Specifies the segment to delete.

Was this section helpful?
Anchor to section titled 'SegmentDeletePayload returns'

SegmentDeletePayload returns

Anchor to SegmentDeletePayload.deletedSegmentId
deletedSegmentId
ID

ID of the deleted segment.

Anchor to SegmentDeletePayload.userErrors
userErrors
[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation segmentDelete($id: ID!) {
  segmentDelete(id: $id) {
    deletedSegmentId
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "id": "gid://shopify/<objectName>/10079785100"
}