Skip to main content
PATCH
Update a contact

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The contact ID.

Minimum string length: 1

Body

application/json
firstName
string

First name.

Minimum string length: 1
lastName
string

Last name.

Minimum string length: 1
accountId
string | null

ID of the account the contact belongs to. null removes the contact from its account.

Minimum string length: 1
emails
string<email>[]

The contact's email address, as a list that replaces the current one; [] removes it. A contact has at most one address for now, and an address can belong to only one contact.

Maximum array length: 1
projectIds
object

Links to projects to add or remove. Links you don't mention are left unchanged. Each project must be one you can edit. If the contact belongs to an account, that account must be linked to each project too; a project with no accounts gets it linked along with the contact.

fields
object

Custom field values to set on the contact, keyed by field name or ID. A value replaces the current one, null clears it, and fields you don't mention are left alone. Each value must match its field's type: a string for text, long_text, email, url, single_select (one of the field's options), and user (the id of an active user in the organization); a number; true or false; an ISO 8601 date-time or YYYY-MM-DD date; a list of strings for collection ([] clears it); or { streetAddress, cityTown, state, country } for address. At most 50 fields.

Response

OK

id
string
required

The contact ID.

Minimum string length: 1
firstName
string
required

First name. Empty for some contacts created from email.

lastName
string
required

Last name. Empty for some contacts created from email.

emails
string[]
required

Email addresses, lowercased. A contact has at most one address for now.

account
object | null
required

The account the contact belongs to, or null.

projectCount
integer
required

How many projects you can see are linked to the contact. List them by filtering projects by contactId. Linking or unlinking a project doesn't change the contact's updatedAt.

Required range: 0 <= x <= 9007199254740991
createdAt
string<date-time>
required

When the contact was created.

updatedAt
string<date-time>
required

When the contact was last updated, including changes to its email address. Links to projects and field value changes do not change it.

fields
object
required

Custom field values, keyed by field name, with a key for every field defined for contacts (null when unset). The value's shape follows the field's type.