post
https://api.suresend.ai/api/partner/referrals
Send one of your team's contacts to another Sure Send team.
personIdmust be a contact already on your team. This endpoint does not
create contacts; create one first withPOST /api/partner/people.receivingTeamIdmust be another team with active billing. Your own team, or a
team without active billing, returns404. See the Referrals section for how
to get a team's id.sharedFieldspicks what the receiving team sees, and must name at least one of
emails,phones,addresses,notes,tags,stage,custom_fields. Unknown names are dropped. The
contact's name is always shared.- When your team requires approval and the API key's user isn't an owner or admin
(a member's personal key), the referral is created aspending_approvalinstead
ofpending. - A contact can be referred to a given team only once, whatever the earlier
referral's status.
404 starts Couldn't find Person when personId is missing or not on your team,
and Couldn't find Team when receivingTeamId is missing, your own team, or a team
without active billing.
422 messages you can get:
errorMessage | Cause |
|---|---|
sharedFields must include at least one valid field (…) | sharedFields is missing or has no allowed field. |
Refer a Lead is turned off for this team. A team owner or admin can turn it on in Settings > Referral Settings. | Refer a Lead is turned off for your team. |
A referral already exists for this person to this team | This contact was already referred to this team. |
Referral fee type is not included in the list | referralFeeType isn't percentage or flat. |
Referral fee percentage is required for percentage fee type | percentage without referralFeePercentage. |
Referral fee amount is required for flat fee type | flat without referralFeeAmount. |
Referral fee percentage must be greater than 0 / … less than or equal to 100 | Out of range. |
Referral fee amount must be greater than 0 / … less than or equal to 99999999 | Out of range. |
Fee agreement document is required when a referral fee is set | Your team requires a signed fee agreement for referral fees. The API can't attach one, so send the referral without a fee, or send it from the app. |
Update frequency is not included in the list | updateFrequency isn't weekly, monthly or none. |
Referral notes is too long (maximum is 10000 characters) | referralNotes is too long. |
The saved defaults from GET /api/partner/referralDefaults are not applied
automatically. Send the fee fields you want on each referral.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…