v1

latestOpenAPI 3.1.02026-07-14460151.1 KB

Create a contact

Add a new contact to your account. Use this endpoint to store identity details, assign tags, and set the contact type for future filtering and management

post/v2/contacts

Request body

typestring required

The classification of the contact (e.g., employee,, or client).

first_namestring required

The contact's legal first name

last_namestring required

The contact's legal last name

emailstring required

A valid email address for communication and identification

phone_numberstring

The contact's primary telephone number.

genderstring

The gender identity of the contact. Available values: male or female

shirt_sizestring

Preferred clothing size for corporate merch or gifting. Available options: XS,SM,MD,LG,XL,2XL,3XL.

birthdaystring date

The contact's date of birth (Format: YYYY-MM-DD).

countrystring required

The country of residence or business operation. Only 2 digit country code with uppercase letters is allowed.

addressstring required

Street address information

unitstring

Apartment, suite, or unit number.

citystring required

The city name for the contact's location.

statestring required

The state, province, or region. If the country is either US or CA, then state code is applicable, otherwise state name will be used.

zip_codestring required

The postal or zip code.

departmentstring

The specific internal department (e.g., "Engineering").

positionstring

The contact's official job title.

employment_typestring

Status of employment (e.g., full-time, contractor).

start_datestring date

The date the contact joined the organization or project.

company_namestring

The name of the organization the contact belongs to.

wedding_anniversarystring date

The contact's anniversary date for personal milestones.

address_validatedboolean

Boolean flag indicating if the address has been checked against a validation service.

address_forcedboolean

Boolean flag to bypass validation errors and save the address as entered.

address_verifiedboolean

Boolean flag confirming the address is accurate and deliverable.

Response

201

Example response

{
  "data": {
    "id": 5,
    "contact_type": "employee",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+1-555-123-4567",
    "email": "john.doe@example.com",
    "address1": "123 Main Street",
    "address2": "Suite 200",
    "country": "US",
    "city": "New York",
    "state": "NY",
    "zip_code": "10001",
    "company": "Acme Corp",
    "status": "Full-Time",
    "created_at": "2026-04-28T23:30:14-04:00",
    "size": "LG",
    "gender": "male",
    "department": "Engineering",
    "birthday_date": "1990-05-15T00:00:00-04:00",
    "start_date": "2024-01-15T00:00:00-05:00",
    "address_verified": true,
    "address_validated": true
  }
}