Skip to main content
POST
/
api
/
v1
/
businesses
/
{businessId}
/
contacts
Error
A valid request URL is required to generate request examples
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "Jane",
    "lastName": "Doe",
    "name": "Jane Doe",
    "email": "jane@example.com",
    "phone": "+14155551234",
    "company": "Acme Inc",
    "website": "https://acme.com",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipCode": "<string>",
    "ianaTimezone": "America/New_York",
    "source": "<string>",
    "note": "<string>",
    "emailDND": true,
    "smsDND": true,
    "callDND": true,
    "whatsappDND": true,
    "secondaryEmails": [
      "jsmith@example.com"
    ],
    "secondaryPhones": [
      "<string>"
    ],
    "isTestContact": true,
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "VIP",
        "displayOrder": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key prefixed with sk-ak-. Pass as Authorization: Bearer sk-ak-...

Path Parameters

​
businessId
string<uuid>
required

The business ID

Body

application/json

Contact data. At least one of email, phone, or firstName is required.

At least one of email, phone, or firstName is required.

​
firstName
string
Maximum string length: 255
​
lastName
string
Maximum string length: 255
​
name
string
Maximum string length: 255
​
email
string<email>
Maximum string length: 255
​
phone
string
Maximum string length: 30
​
company
string
Maximum string length: 255
​
website
string
Maximum string length: 500
​
address
string
Maximum string length: 1000
​
city
string
Maximum string length: 255
​
state
string
Maximum string length: 255
​
country
string
Maximum string length: 255
​
zipCode
string
Maximum string length: 20
​
ianaTimezone
string
Maximum string length: 100
​
source
string
Maximum string length: 255
​
note
string
Maximum string length: 5000
​
message
string
Maximum string length: 5000
​
emailDND
boolean
default:false
​
smsDND
boolean
default:false
​
callDND
boolean
default:false
​
whatsappDND
boolean
default:false
​
secondaryEmails
string<email>[]
Maximum array length: 10
​
secondaryPhones
string[]
Maximum array length: 10
​
isTestContact
boolean
default:false

Response

Contact created

​
data
object