createReferral
Create an account referral using an email address, personal link or code.This is for customers to refer other customers so it only works with friend referrals and not partner referrals.
Arguments
Input fields for creating a referral.
Returns
CreateReferralUse a referral code to create a referral and trigger a referral reward. This is for customers to refer other customers so it only works with friend referrals and not partner referrals. This will try to find a user with given referral code as their personal referral code. If found, it will create an AccountReferral instance for the given account number.
Possible Errors
Allowed Viewers
Customer
Partner User
Third party
Required Permissions
Can access customer queriesCan create referrals
Rate Limits
| Key | Steps |
|---|---|
user |
['5/m'] |
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.
mutation CreateReferral($input: CreateReferralInput!) {
createReferral(input: $input) {
referredAccountRewardAmount
}
}
Variables
{
"input": CreateReferralInput
}
Response
{
"data": {
"createReferral": {
"referredAccountRewardAmount": 27
}
}
}