Skip to main content
PATCH
Update an account

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The account ID.

Minimum string length: 1

Body

application/json
name
string

Account name.

Minimum string 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.

fields
object

Custom field values to set on the account, 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 account ID.

Minimum string length: 1
name
string
required

Account name.

Minimum string length: 1
contactCount
integer
required

How many contacts belong to the account. List them by filtering contacts by accountId.

Required range: 0 <= x <= 9007199254740991
projectCount
integer
required

How many projects you can see are linked directly to the account. Filtering projects by accountId also returns the projects linked through the account's contacts. Linking or unlinking a project doesn't change the account's updatedAt.

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

When the account was created.

updatedAt
string<date-time>
required

When the account itself was last updated. Contacts joining or leaving the account, 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 accounts (null when unset). The value's shape follows the field's type.