Skip to main content
PATCH
Update a project

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The project ID.

Minimum string length: 1

Body

application/json
name
string

Project name.

Minimum string length: 1
accountIds
object

Links to accounts to add or remove. Links you don't mention are left unchanged. An account can't be unlinked while contacts that belong to it stay linked: unlink them in the same call.

contactIds
object

Links to contacts to add or remove. Links you don't mention are left unchanged. A contact that belongs to an account can only be linked along with that account. Link both in the same call, or link the contact to a project with no accounts and its account is linked too.

fields
object

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

Minimum string length: 1
name
string
required

Project name.

Minimum string length: 1
access
object
required

Who can see the project: everyone in the organization, or only its members.

accounts
object[]
required

The accounts linked to the project. Direct links only: the accountId filter on the project list also matches projects linked through one of the account's contacts.

contacts
object[]
required

The contacts linked to the project.

createdAt
string<date-time>
required

When the project was created.

updatedAt
string<date-time>
required

When the project was last updated, including changes to its linked accounts and contacts. 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 projects (null when unset). The value's shape follows the field's type.