Update a contact by ID

Modify an existing contact in your Quo workspace using the contact’s unique identifier. This endpoint replaces the contact rather than merging into it: any defaultFields.emails, defaultFields.phoneNumbers or customFields you omit from the request body is deleted on the contact. Always send the full set of fields, emails, and phone numbers you want the contact to have, not just the ones you’re changing.

PATCH /v1/contacts/{id}

Update a contact by ID

cURL

curl --request PATCH \
  --url https://dev-public-api.openphone.dev/v1/contacts/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "664d0db69fcac7cf2e6ec",
  "source": "public-api",
  "sourceUrl": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec",
  "defaultFields": {
    "company": "Quo",
    "emails": [
      {
        "name": "company email",
        "value": "[e-mail]",
        "id": "acb123"
      }
    ],
    "firstName": "John",
    "lastName": "Doe",
    "phoneNumbers": [
      {
        "name": "company phone",
        "value": "[phone]",
        "id": "acb123"
      }
    ],
    "role": "Sales"
  },
  "customFields": [
    {
      "value": [
        "option1",
        "option2"
      ],
      "key": "inbound-lead",
      "id": "66d0d87d534de8fd1c433cec3"
    }
  ]
}
'

200

{
  "data": {
    "id": "664d0db69fcac7cf2e6ec",
    "externalId": "664d0db69fcac7cf2e6ec",
    "source": "public-api",
    "sourceUrl": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec",
    "defaultFields": {
      "company": "Quo",
      "emails": [
        {
          "name": "company email",
          "value": "[e-mail]",
          "id": "acb123"
        }
      ],
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumbers": [
        {
          "name": "company phone",
          "value": "[phone]",
          "id": "acb123"
        }
      ],
      "role": "Sales"
    },
    "customFields": [
      {
        "name": "Inbound Lead",
        "type": "multi-select",
        "value": [
          "option1",
          "option2"
        ],
        "key": "inbound-lead"
      }
    ],
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "createdByUserId": "US123abc"
  }
}

Authorizations

Authorization · string · header · required

Path Parameters

id · string · required

The unique identifier of the contact.

Pattern: ^(.*)$

Example:

"66d0d87e8dc1211467372303"

Body

application/json

externalId · string | null

A unique identifier from an external system that can optionally be supplied when creating a contact. This ID is used to associate the contact with records in other systems and is required for retrieving the contact later via the "List Contacts" endpoint. Ensure the externalId is unique and consistent across systems for accurate cross-referencing.

Required string length: 1 - 75

Example:

"664d0db69fcac7cf2e6ec"

source · string | null

Indicates how the contact was created or where it originated from.

Required string length: 1 - 75

Example:

"public-api"

sourceUrl · string<uri> | null

A link to the contact in the source system.

Required string length: 1 - 200

Example:

"https://openphone.co/contacts/664d0db69fcac7cf2e6ec"

defaultFields · object

Show child attributes

customFields · object[]

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

Response

200

application/json

OK

data · object · required

Show child attributes