PATCH
/api/v2/users/{userId}/referrals/links/{linkId}Renames, re-targets (allowlisted destination), pauses/resumes/archives or re-schedules a link. The code is immutable.
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (path) | integer (int32) | Yes | |
| linkId (path) | string (uuid) | Yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| Name | string | No | |
| Status | string | No | ACTIVE, PAUSED or ARCHIVED. Archiving is final. |
| Destination | string | No | Allowlisted destination (signup, home, cards, topup, rewards). The code never changes. |
| ExpiresAt | string (date-time) | No | |
| ClearExpiresAt | boolean | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Id | string (uuid) | Yes | |
| ProgramId | string (uuid) | Yes | |
| ProgramName | string | Yes | |
| Name | string | Yes | |
| Code | string | Yes | |
| Channel | string | Yes | |
| Locale | string | Yes | |
| Destination | string | Yes | |
| Status | string | Yes | |
| ActiveFrom | string (date-time) | Yes | |
| ExpiresAt | string (date-time) | Yes | |
| CreatedAt | string (date-time) | Yes | |
| ShareUrl | string | Yes | |
| SignupCount | unknown | Yes | |
| QualifiedCount | unknown | Yes | |
| ClickCount | unknown | Yes | |
| UniqueClickCount | unknown | Yes | |
| OfferVersionId | string (uuid) | Yes | |
| SuggestedCaption | string | Yes | |
| OwnerUserId | unknown | No | |
| OwnerName | string | No | |
| OwnerEmail | string | No |
Example request
curl -X PATCH "https://{base_url}/api/v2/users/{userId}/referrals/links/{linkId}" \
-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.