POST
/api/v2/referrals/programs/{programId}/community/members/{userId}/revokePOST /api/v2/referrals/programs/{programId}/community/members/{userId}/revoke
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 |
|---|---|---|---|
| Reason | string | Yes |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Id | string (uuid) | Yes | |
| UserId | unknown | Yes | |
| Plan | string | Yes | |
| ParentUserId | unknown | Yes | |
| PlanRevision | unknown | Yes | |
| L2Bps | unknown | Yes | |
| L3Bps | unknown | Yes | |
| EnabledAt | string (date-time) | Yes | |
| ExpiresAt | string (date-time) | Yes | |
| RevokedAt | string (date-time) | Yes | |
| Status | string | Yes | |
| AgreementReference | string | Yes | |
| Notes | string | Yes |
Example request
curl -X POST "https://{base_url}/api/v2/referrals/programs/{programId}/community/members/{userId}/revoke" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"Reason":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.