Skip to main content
PATCH
/
v1
/
contacts
/
{id}
Update a contact by ID
curl --request PATCH \
  --url https://api.openphone.com/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": "OpenPhone",
    "emails": [
      {
        "name": "company email",
        "value": "[email protected]",
        "id": "acb123"
      }
    ],
    "firstName": "John",
    "lastName": "Doe",
    "phoneNumbers": [
      {
        "name": "company phone",
        "value": "+15555555555",
        "id": "acb123"
      }
    ],
    "role": "Sales"
  },
  "customFields": [
    {
      "key": "inbound-lead",
      "id": "66d0d87d534de8fd1c433cec3",
      "value": [
        "<string>"
      ]
    }
  ]
}'
{
  "data": {
    "id": "664d0db69fcac7cf2e6ec",
    "externalId": "664d0db69fcac7cf2e6ec",
    "source": "public-api",
    "sourceUrl": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec",
    "defaultFields": {
      "company": "OpenPhone",
      "emails": [
        {
          "name": "company email",
          "value": "[email protected]",
          "id": "acb123"
        }
      ],
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumbers": [
        {
          "name": "company phone",
          "value": "+12345678901",
          "id": "acb123"
        }
      ],
      "role": "Sales"
    },
    "customFields": [
      {
        "name": "Inbound Lead",
        "key": "inbound-lead",
        "type": "multi-select",
        "value": [
          "<string>"
        ]
      }
    ],
    "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.

Examples:

"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
Examples:

"664d0db69fcac7cf2e6ec"

​
source
string | null

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

Required string length: 1 - 75
Examples:

"public-api"

​
sourceUrl
string<uri> | null

A link to the contact in the source system.

Required string length: 1 - 200
Examples:

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

​
defaultFields
object
​
customFields
object[]
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5

Response

Success

​
data
object
required
⌘I