Create a contact - OpenPhone Docs

Body

application/json

defaultFields

object

required

createdByUserId

string

The unique identifier of the user who created the contact.

customFields

object[]

externalId

string | null

An external identifier of the contact.

Required string length: 1 - 75

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, other or start with one of the following reserved prefixes: openphone, csv.

Required string length: 1 - 72

Response

201 - application/json

data

object

required

data.createdAt

string

required

Timestamp of contact creation in ISO 8601 format.

data.createdByUserId

string

required

The unique identifier of the user who created the contact.

data.customFields

object[]

required

data.defaultFields

object

required

data.externalId

string | null

required

An external identifier of the contact.

Required string length: 1 - 75

data.id

string

required

The unique identifier of the contact.

data.source

string | null

required

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

Required string length: 1 - 75

data.updatedAt

string

required

Timestamp of last contact update in ISO 8601 format.