ghl_affiliate_validate_referral_id
Checks whether a referral ID is available before use, accounting for location-wide uniqueness so taken IDs report as unavailable even if from another campaign.
Instructions
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. Endpoint: GET /affiliate-manager/affiliate-campaign/{locationId}/referral-id/validate (Version header: v3; source: v3/affiliate-manager-v3.json) Requires a Sub-Account (location) token. OAuth scopes: affiliate-manager.readonly
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"locationId": "<locationId>",
"referralId": "<referralId>"
},
"name": "ghl_affiliate_validate_referral_id"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| locationId | Yes | Location Id | |
| referralId | Yes | Referral id to check, as it would appear in a referral link |