PAparley
Contacts

Create a contact

Changed on

Create a contact (a person), optionally belonging to an account and linked to projects. An email address can belong to only one contact, so a second contact with the same address returns 409 EMAIL_TAKEN.

post/contacts

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/contacts
  • Auth
    HTTP bearer

Request body

firstNamestring required

First name.

lastNamestring required

Last name.

accountIdstring

ID of the account the contact belongs to.

emailsstring[]

The email address, as a list. A contact has at most one address for now, and an address can belong to only one contact.

projectIdsstring[]

IDs of projects to link. At most 100. 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.

fieldsobject

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

Created.

idstring required

The contact ID.

firstNamestring required

First name. Empty for some contacts created from email.

lastNamestring required

Last name. Empty for some contacts created from email.

emailsstring[] required

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

projectCountinteger 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.

createdAtstring date-time required

When the contact was created.

updatedAtstring 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.

fieldsobject 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.

Example response

{
  "id": "cmf2x7z3e0002abcd",
  "firstName": "Ada",
  "lastName": "Lovelace",
  "emails": [
    "ada@acme.example"
  ],
  "account": {
    "type": "account",
    "id": "cmf2x7r1p0000abcd",
    "name": "Acme Corp"
  },
  "projectCount": 1,
  "createdAt": "2026-09-12T10:05:00.000Z",
  "updatedAt": "2026-09-12T10:05:00.000Z",
  "fields": {
    "Contact Type": "Beneficiary",
    "Country of Birth": "United Kingdom"
  }
}

Changes

  • 6b78aeee07bcRevision changes
    • breaking

      added the pattern ^[^\p{Cc}\p{Bidi_Control}]*$ to the request property

    • breaking

      added the pattern ^[^\p{Cc}\p{Bidi_Control}]*$ to the request property