Update Affiliate Referral Id

PUT 
/affiliate-manager/affiliate-campaign/:locationId/affiliate/:affiliateId/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.

Request

Version stringrequired

API Version

Available options2023-02-21

locationId stringrequired

Location Id

affiliateId stringrequired

Affiliate Id

application/json

application/json

Body

Bodyrequired

campaignIdstringrequired

Campaign the affiliate is enrolled in

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 (auto)

{
  "campaignId": "6385d230f6d19db03eef6fb2",
  "referralId": "john122"
}

application/json

Successful response

application/json

Schema

Schema

referralIdstringrequired

The referral id now stored for this affiliate

referralLinkstringrequired

Referral link carrying the new referral id

campaignIdstringrequired

Campaign the referral id belongs to

Example (auto)

{
  "referralId": "john122",
  "referralLink": "https://link.example.com/campaign?am_id=john122",
  "campaignId": "6385d230f6d19db03eef6fb2"
}