Skip to main content
POST
Merge two people

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The person to keep.

Body

application/json
loser_id
string
required

The person to fold in and archive. Not the same as the one in the path.

Response

The person you kept. tags is not included here.

roles
enum<string>[]
required

Replaced whole when you change it.

Available options:
adopter,
donor,
volunteer,
foster
address
object
required

Every part is optional, and a key not listed here is refused. An empty or null part is removed.

status
enum<string>
required

A merged-away person is archived.

Available options:
active,
inactive,
archived
preferred_contact
enum<string>[]
required

How they like to be reached, each way once. Replaced whole when you change it.

Available options:
email,
phone,
text,
mail,
in_person
custom_fields
object
required

Values for the custom fields, keyed by field key (see List custom fields). A key that is not a field is refused, and each value must suit its field: text; long text of 5,000 characters at most; a number; true or false; a date; one of a select's options; a list of a multi-select's options; a phone number; an email address; a web address starting http:// or https://; { "country": "US", "state": "ME" } for a country and state; an ID for an organization or person field; a list of volunteer role keys. null clears a value.

id
string
required
display_name
string
required

The whole name, built from the prefix, first name, last name and suffix: Dr Robin Fields Jr. Empty when there is no name. It cannot be set.

created_at
string<date-time>
required
updated_at
string<date-time>
required
name_prefix
string | null

Such as Dr or Ms.

first_name
string | null
last_name
string | null
name_suffix
string | null

Such as Jr or PhD.

email
string | null

Their primary email address. It must look like an email address.

phone
string | null

Their primary phone number. Everything that is not a digit is removed, so (207) 555-0142 is kept as 2075550142. At most 15 digits together with the calling code.

phone_country
string | null

The calling code for the phone, one to three digits: 1 for the US and Canada, 44 for the UK.

date_of_birth
string<date> | null

A real date, not in the future. Volunteer roles with a minimum age check it.

tenant_id
string

Your organization's ID.

photo_file_id
string | null

Their photo's file ID.

avatar_key
string | null

A built-in picture shown when there is no photo. It cannot be set here.

tags
string[]

The person's tags, in alphabetical order. Present everywhere except in the duplicates list and the answer to a merge.