Change a partner group

PATCH /program/affiliates/groups/{group_id}


Scope	`program:write`
Customer session token	Not accepted: call from your server with an API key
Rate limit class	`write_shopify` (limits)
Idempotency key	Required (idempotency)
MCP tool	`charm_update_affiliate_group`

Changes a group’s name, rates or buyer discount; members’ live codes follow a new discount.

Parameters

Name	In	Type	Description
`group_id`	path	string	The group’s `id`.

Request body

Field	Type	Description
`name`	string	(optional)
`commission`	object or null	The group’s own rates; null = the programme’s. A null rate inherits that channel. (optional, nullable)
`customer_discount`	object or null	The group’s buyer discount; null = the programme’s. (optional, nullable)
`dry_run`	boolean	(optional)

Response `200`

Returns AffiliateGroupWriteResult.

Field	Type	Description
`dry_run`	boolean
`group`	AffiliateGroup
`members_detached`	integer	Deleting: partners who fall back to the programme’s rates. (optional)
`partner_codes_sync_failed`	boolean	(optional)

{
  "dry_run": false,
  "group": {
    "id": "id",
    "name": "Gold",
    "commission": {
      "type": "percent",
      "code_rate": 1,
      "link_rate": 1
    },
    "customer_discount": {
      "type": "percentage",
      "value": 1
    },
    "member_count": 1
  },
  "members_detached": 1,
  "partner_codes_sync_failed": false
}

Example

curl -X PATCH "https://charm.appfleece.app/api/v1/program/affiliates/groups/<group_id>" \
  -H "Authorization: Bearer chrm_live_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Errors

unauthorized · invalid_token · insufficient_scope · access_required · not_found · validation_error · rate_limited · idempotency_conflict · shopify_unavailable

Every error body carries code, message, request_id and a doc_url pointing at the matching entry in the error catalog.