removeSegmentMembers

mutation · in the family Pricing

What it does

Remove up to 48 shoppers from a segment in one call.

Remove up to 48 Consumers from a STATIC segment in ONE transaction. Requires the unrestricted capability. Template class (v80).

What happens

Deletes membership rows; absent shoppers are skipped.

Who may call it

Capability area: Pricing — Prices, price schedules, promotions, coupons and the money rules of selling.

• Owner
• Manager
• An API key whose scope allows api:removeSegmentMembers

Arguments

Returns

RemoveSegmentMembersResult RemoveSegmentMembersResult! — The removeSegmentMembers result — deletes are idempotent (absent shoppers SKIP).

Example request

mutation ExampleRemoveSegmentMembers($segmentId: ID!, $consumerIds: [ID!]!) {
  removeSegmentMembers(segmentId: $segmentId, consumerIds: $consumerIds) {
    removed
    skippedAbsent
    memberCount
  }
}

Variables:

{
  "segmentId": "01900000-0000-7000-8000-243b225b0000",
  "consumerIds": [
    "01900000-0000-7000-8000-a64ad04d0000"
  ]
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "removeSegmentMembers": {
      "removed": 1,
      "skippedAbsent": 1,
      "memberCount": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• NOT_FOUND/* — That record could not be found. (NOT_FOUND)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)