Update Affiliate Referral Id

Set the referral id an affiliate is tracked by on a campaign. The referral link is rebuilt around the new id, and the id must be unused across the location.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:affiliate-manager.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

affiliateIdstringrequired

Affiliate Id

Example:6385d230f6d19db03eef6fb2

Body

application/json

campaignIdstringrequired

Campaign the affiliate is enrolled in

Example:6385d230f6d19db03eef6fb2

referralIdstringrequired

New referral id. Must be unused across the location.

Possible values: >= 3 characters and <= 64 characters, Value must match regular expression ^[A-Za-z0-9_]{3,64}$

Example:john122

Response

200

application/json

Successful response

referralIdstringrequired

The referral id now stored for this affiliate

Example:john122

referralLinkstringrequired

Referral link carrying the new referral id

Example:https://link.example.com/campaign?am_id=john122

campaignIdstringrequired

Campaign the referral id belongs to

Example:6385d230f6d19db03eef6fb2