Update Affiliate Program
Edits a program's name and rules, or archives/unarchives it. The default program cannot be archived; a program holding products cannot be archived. 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.
/affiliate_programs/{id}Edits a program's name and rules, or archives/unarchives it. The default program cannot be archived; a program holding products cannot be archived. 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.
In: header
Path Parameters
Opaque affiliate program ID.
^prg_[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/affiliate_programs/string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "string", "livemode": true, "reference": "string", "name": "string", "status": "active", "is_default": true, "attribution_rule": "locked_at_signup", "click_window_days": 1, "hold_days": 0, "join_policy": "auto", "self_referral_policy": "block", "show_referrer_at_checkout": true, "max_bindings_per_click": 1, "tier_drops_within_month": true, "allowed_hosts": [ "string" ], "archived_at": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}Update Affiliate PATCH
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.
Update Api Key PATCH
Next Page