getReferralCodeStatus
Get the status of a referral code.
Arguments
The referral code to check.
Returns
ReferralCodeStatusTypePossible Errors
Allowed Viewers
Required Permissions
(No)Rate Limits
| Key | Steps |
|---|---|
ip |
['3/d'] |
Query Complexity
1Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
query GetReferralCodeStatus($code: String!) {
getReferralCodeStatus(code: $code) {
codeType
description
descriptionInSpanish
isValid
maxRecurrence
}
}
Variables
{
"code": "several-too-personal-share-war"
}
Response
{
"data": {
"getReferralCodeStatus": {
"codeType": "REFERRAL_CODE",
"description": "lawyer-mention-thousand-quality-everybody",
"descriptionInSpanish": "operation-should-such-candidate-cold",
"isValid": true,
"maxRecurrence": "reach-respond-role-majority-himself"
}
}
}