Validate Referral Id

GET 
/affiliate-manager/affiliate-campaign/:locationId/referral-id/validate

Check whether a referral id is free to use. Referral ids are unique across a location, so a taken id reports as unavailable even when it belongs to a different campaign.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location Id

referralId stringrequired

Referral id to check, as it would appear in a referral link

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

application/json

Successful response

application/json

Schema

Schema

availablebooleanrequired

Whether the referral id is free to use in this location

Example (auto)

{
  "available": true
}