Getting started
Essentials
Calls
Contact Custom Fields
Contacts
Conversations
Phone Numbers
Contacts
Create a contact
Create a contact for a workspace.
POST
/
v1
/
contacts
Copy
Ask AI
curl --request POST \
--url https://api.openphone.com/v1/contacts \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"defaultFields": {
"company": "OpenPhone",
"emails": [
{
"name": "company email",
"value": "[email protected]"
}
],
"firstName": "John",
"lastName": "Doe",
"phoneNumbers": [
{
"name": "company phone",
"value": "+12345678901"
}
],
"role": "Sales"
},
"customFields": [
{
"key": "inbound-lead",
"value": [
"<string>"
]
}
],
"createdByUserId": "US123abc",
"source": "public-api",
"sourceUrl": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec",
"externalId": "664d0db69fcac7cf2e6ec"
}'
Copy
Ask AI
{
"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",
"id": "66d0d87d534de8fd1c433cec3",
"type": "multi-select",
"value": [
"<string>"
]
}
],
"createdAt": "2022-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"createdByUserId": "US123abc"
}
}
Authorizations
Body
application/json
Response
201
application/json
Success
The response is of type object
.
Was this page helpful?
Copy
Ask AI
curl --request POST \
--url https://api.openphone.com/v1/contacts \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"defaultFields": {
"company": "OpenPhone",
"emails": [
{
"name": "company email",
"value": "[email protected]"
}
],
"firstName": "John",
"lastName": "Doe",
"phoneNumbers": [
{
"name": "company phone",
"value": "+12345678901"
}
],
"role": "Sales"
},
"customFields": [
{
"key": "inbound-lead",
"value": [
"<string>"
]
}
],
"createdByUserId": "US123abc",
"source": "public-api",
"sourceUrl": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec",
"externalId": "664d0db69fcac7cf2e6ec"
}'
Copy
Ask AI
{
"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",
"id": "66d0d87d534de8fd1c433cec3",
"type": "multi-select",
"value": [
"<string>"
]
}
],
"createdAt": "2022-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"createdByUserId": "US123abc"
}
}
Assistant
Responses are generated using AI and may contain mistakes.