PUT
/api/v2/referrals/programs/{programId}/members/{userId}PUT /api/v2/referrals/programs/{programId}/members/{userId}
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| programId (path) | string (uuid) | Yes | |
| userId (path) | integer (int32) | Yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| Active | boolean | No | False revokes. True creates as PENDING (or keeps the current status); set Approve to activate. |
| ExpiresAt | string (date-time) | No | |
| AgreementReference | string | No | |
| EffectiveFrom | string (date-time) | No | |
| EffectiveUntil | string (date-time) | No | |
| CampaignOwnerUserId | unknown | No | |
| Channels | array of string | No | |
| FundingAllocation | unknown | No | |
| Notes | string | No | |
| Approve | boolean | No | Approves the partner: status becomes ACTIVE and approved_by/approved_at are recorded. |
Responses
200 — OK
Example request
curl -X PUT "https://{base_url}/api/v2/referrals/programs/{programId}/members/{userId}" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'This page is generated from the live OpenAPI specification and always matches the current API.