Validate Referral Id

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.

Authorizations

Authorizationstringheaderrequired

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

Scope:affiliate-manager.readonly

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

Query Parameters

referralIdstringrequired

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}$

Example:john122

Response

200

application/json

Successful response

availablebooleanrequired

Whether the referral id is free to use in this location

Example:true