createAffiliate

mutation · in the family Affiliate

What it does

Create a new affiliate — a commission-earning referral partner at your organization.

Create an Affiliate in the caller's org group.

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

Arguments

Returns

Affiliate Affiliate! — An Affiliate — the MERCHANT's affiliate/influencer promoter, rewarded for driving retail sales (≠ the platform affiliate, 's note). Org participation is the canned-pool selection (≤ 32; ABSENT = every org). The referral and coupon namespaces are INDEPENDENT: couponId is an INFORMATIONAL link (validated live, same-group) — registering the SAME string in both, linked, is the influencer pattern (use CODE for 10% off — the coupon discounts, the referral attributes). Cancel claws in full; returns claw pro-rata with the cumulative floor (the arm class); payouts are PERIOD reports. SEARCHABLE (the merchant-curated book is name-found — the law); at most 128 ACTIVE per group.

Example request

mutation ExampleCreateAffiliate($input: NewAffiliateInput!) {
  createAffiliate(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationIds
    ratePpm
    consumerId
    handle
    bio
    socialLinks
    audienceSize
    nicheTags
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans"
  }
}

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

Example response

{
  "data": {
    "createAffiliate": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "AF-EXMP-0000-000F",
      "type": "Affiliate",
      "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",
      "organizationIds": [
        "01900000-0000-7000-8000-60e064dc0000"
      ],
      "ratePpm": 1,
      "consumerId": "01900000-0000-7000-8000-6e8c92ec0000",
      "handle": "<handle>",
      "bio": "<bio>",
      "socialLinks": [
        "<social links>"
      ],
      "audienceSize": 1,
      "nicheTags": [
        "<niche tags>"
      ]
    }
  },
  "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

• Pay the people who sell for you — staff commissions and referral partners