Accept a referral

The receiving team takes the referral. Only a pending referral can be accepted.

Accepting creates a new contact on your team from personSnapshot, assigned to
the API key's user, and returns its id as receivedPersonId. Shared notes are
copied unless skipNotes is true. Shared custom fields are copied (and created on
your team if missing) unless you narrow them with customFieldIds.

The sending team gets a referralsAccepted webhook.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Referral ID

Body Params
boolean
Defaults to false

Don't copy the shared notes onto the new contact.

customFieldIds
array of strings

Copy only these custom fields. Despite the name, these are the field names from personSnapshot.custom_fields[].name, not ids. Omit to copy them all.

customFieldIds
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json