Getting started
Essentials
Calls
Contact Custom Fields
Contacts
Conversations
Phone Numbers
Update a contact by ID
Modify an existing contact in your OpenPhone workspace using the contact’s unique identifier.
curl --request PATCH \
--url https://api.openphone.com/v1/contacts/{id} \
--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"
}
}Path Parameters
The unique identifier of the contact.
"66d0d87e8dc1211467372303"
Body
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.
1 - 75"664d0db69fcac7cf2e6ec"
Indicates how the contact was created or where it originated from.
1 - 75"public-api"
A link to the contact in the source system.
1 - 200"https://openphone.co/contacts/664d0db69fcac7cf2e6ec"
The contact's company name.
"OpenPhone"
The name for the contact's email address.
"company email"
The contact's email address. If set to null during a patch operation, it will remove the email item from the contact.
The unique identifier for the contact email field.
"acb123"
The contact's first name.
"John"
The contact's last name.
"Doe"
The name of the contact's phone number.
"company phone"
The contact's phone number. If set to null during a patch operation, it will remove the phone number item from the contact.
"+15555555555"
The unique identifier of the contact phone number field.
"acb123"
The contact's role.
"Sales"
Response
The unique identifier of the contact.
"664d0db69fcac7cf2e6ec"
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.
1 - 75"664d0db69fcac7cf2e6ec"
Indicates how the contact was created or where it originated from.
1 - 75"public-api"
A link to the contact in the source system.
1 - 200"https://openphone.co/contacts/664d0db69fcac7cf2e6ec"
The contact's company name.
"OpenPhone"
The name for the contact's email address.
"company email"
The contact's email address.
The unique identifier for the contact email field.
"acb123"
The contact's first name.
"John"
The contact's last name.
"Doe"
The name of the contact's phone number.
"company phone"
The contact's phone number.
"+12345678901"
The unique identifier of the contact phone number field.
"acb123"
The contact's role.
"Sales"
The name of the custom contact field. This name is set by users in the OpenPhone interface when the custom field is created.
"Inbound Lead"
multi-select The identifying key for contact custom field.
"inbound-lead"
Timestamp of contact creation in ISO 8601 format.
"2022-01-01T00:00:00Z"
Timestamp of last contact update in ISO 8601 format.
"2022-01-01T00:00:00Z"
The unique identifier of the user who created the contact.
"US123abc"
Was this page helpful?
curl --request PATCH \
--url https://api.openphone.com/v1/contacts/{id} \
--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"
}
}