Hermos API

Update Affiliate

Pauses (status suspended) or resumes (status active) an affiliate, edits the merchant's private notes, or changes the handle. A paused affiliate resumes only from suspended; other statuses are 409. The old handle stops resolving at once (its 90-day redirect arrives with affiliate links). Cookie members require Hms-Company and Hms-Livemode; Idempotency-Key returns 400 invalid_request with idempotency_not_supported_for_member_routes. Bearer callers require Idempotency-Key. Agents cannot write affiliate records.

PATCH/affiliates/{id}

Pauses (status suspended) or resumes (status active) an affiliate, edits the merchant's private notes, or changes the handle. A paused affiliate resumes only from suspended; other statuses are 409. The old handle stops resolving at once (its 90-day redirect arrives with affiliate links). Cookie members require Hms-Company and Hms-Livemode; Idempotency-Key returns 400 invalid_request with idempotency_not_supported_for_member_routes. Bearer callers require Idempotency-Key. Agents cannot write affiliate records.

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Opaque affiliate ID.

Match^aff_[0-7][0-9abcdefghjkmnpqrstvwxyz]{25}$(?![\s\S])

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/affiliates/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "string",    "livemode": true,    "handle": "string",    "status": "invited",    "display_name": "string",    "email": "string",    "notes": "string",    "identity_attached": true,    "listed_in_combined_view": true,    "customer": {      "id": "string",      "name": "string",      "email": "string"    },    "memberships": [      {        "program_id": "string",        "status": "pending",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      }    ],    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}