createSegment

mutation · in the family Segment

What it does

Create a customer segment for marketing — a named group of shoppers you add members to.

Create a Segment in the caller's org group; requires the unrestricted capability. static = explicit membership (addSegmentMembers fills it); dynamic REQUIRES a predicate (refs gated in-tenant + active; unknown tier names refuse teaching the program's ladder) and materializes membership at refreshSegment.

What happens

Creates a record; membership starts empty.

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:createSegment

Arguments

Returns

Segment Segment! — A Segment: a merchant-authored CONSUMER grouping for marketing. segmentType is IMMUTABLE at birth — static (explicit membership: batched adds/removes of ≤48 consumers per call, the one-transaction law; the pair key dedupes structurally) or dynamic (membership DERIVED from the stored predicate — the member ops refuse; edit the predicate/exclusions and call refreshSegment to re-materialize; evaluatedAt shows the staleness honestly, refreshProblem words a queued refresh that could not complete, and a scheduled sweep re-refreshes stale ACTIVE dynamics ~daily). memberCount meters live membership (bounded ≤100000 — the add/refresh refuses past it naming the figure). MARKETING-ONLY-OVER-CONSENTED is the CONSUMING lane's law when campaigns/exports arrive — the definition stores membership only. NOT searchable (a membership register); inactive = staging (membership edits stay legal while building).

Example request

mutation ExampleCreateSegment($input: NewSegmentInput!) {
  createSegment(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    segmentType
    memberCount
    excludedConsumerIds
    evaluatedAt
    refreshProblem
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "segmentType": "static"
  }
}

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

Example response

{
  "data": {
    "createSegment": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "SE-EXMP-0000-000F",
      "type": "Segment",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "segmentType": "static",
      "memberCount": 1,
      "excludedConsumerIds": [
        "01900000-0000-7000-8000-2fe46bb30000"
      ],
      "evaluatedAt": "2027-01-31T00:00:00.000Z",
      "refreshProblem": "<refresh problem>"
    }
  },
  "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)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

• Group shoppers into segments for marketing