PATCH/api/v2/referrals/links/{linkId}

Status only: ACTIVE, PAUSED or ARCHIVED. Pausing stops new attribution and leaves existing relationships untouched.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
Field	Type	Required	Description
linkId (path)	string (uuid)	Yes

Request body

application/json

Request body fields
Field	Type	Required	Description
Status	string	Yes

Responses

200 — OK

Response 200 fields
Field	Type	Required
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/referrals/links/{linkId}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"Status":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.