Create a contact

Create a contact for a workspace.

POST /v1/contacts

Create a contact

cURL

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

201

{
  "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",
        "id": "66d0d87d534de8fd1c433cec3"
      }
    ],
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "createdByUserId": "US123abc"
  }
}

Authorizations

Authorization · string · header · required

Body

application/json

defaultFields · object · required

Show child attributes

customFields · object[]

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

createdByUserId · string

The unique identifier of the user who created the contact.

Pattern: ^US(.*)$

Example:

"US123abc"

source · string · default: public-api

The contact's source. Defaults to null for contacts created in the UI. Defaults to public-api for contacts created via the public API. Cannot be one of the following reserved words: openphone, device, csv, zapier, google-people, other or start with one of the following reserved prefixes: openphone, csv.

Required string length: 1 - 72

Examples:

"public-api"

"custom-hubspot"

"google-calendar"

sourceUrl · string<uri>

A link to the contact in the source system.

Required string length: 1 - 200

Example:

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

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"

Response

201

application/json

Created

data · object · required

Show child attributes