Skip to main content
POST
/
v1
/
contacts
Create a contact
curl --request POST \
  --url https://api.example.com/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumbers": [
    "+33612345678"
  ],
  "email": "john.doe@example.com",
  "company": "Acme Inc."
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumbers": [
    "+33612345678"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lastModificationSource": "SKIPCALL",
  "email": "john.doe@example.com",
  "company": "Acme Inc."
}

Authorizations

​
Authorization
string
header
required

Enter your API Key (sk_live_xxx or sk_test_xxx)

Body

application/json
​
firstName
string
required

First name of the contact

Required string length: 1 - 100
Example:

"John"

​
lastName
string
required

Last name of the contact

Required string length: 1 - 100
Example:

"Doe"

​
phoneNumbers
string[]
required

Phone numbers in E.164 format (e.g., +33612345678)

Required array length: 1 - 20 elements
Example:
["+33612345678"]
​
email
string

Email address of the contact

Example:

"john.doe@example.com"

​
company
string

Company name

Maximum string length: 200
Example:

"Acme Inc."

Response

The created contact

​
id
string
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
firstName
string
required
Example:

"John"

​
lastName
string
required
Example:

"Doe"

​
phoneNumbers
string[]
required
Example:
["+33612345678"]
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
lastModificationSource
enum<string>
required
Available options:
SKIPCALL,
API,
HUBSPOT,
PIPEDRIVE
​
email
object
Example:

"john.doe@example.com"

​
company
object
Example:

"Acme Inc."