v1

latestOpenAPI 3.1.02026-07-14460151.1 KB

Update a contact

Modify an existing Contact entry by its unique identifier. Use this to sync updated user profiles, refresh address validation flags, or record changes in employment status and contact classification.

put/v2/contacts/{id}

Path parameters

idstring required

ID of the contact

Request body

first_namestring required

The contact's first name.

last_namestring required

The contact's last name.

emailstring required

The contact's email address. Must be a valid email format.

phone_numberstring

The contact's phone number.

genderstring

The contact's gender. Allowed values: male, female.

shirt_sizestring

The contact's preferred shirt size. Allowed values: XS, SM, MD, LG, XL, 2XL, 3XL.

birthday_datestring date

The contact's date of birth. Format: yyyy-mm-dd (e.g., 1990-01-15).

countrystring required

The 2-letter ISO country code (e.g., US, CA, DE).

addressstring

The primary street address. Required if address2 is not provided.

address2string

The secondary address line (e.g., apartment, suite). Required if address is not provided.

citystring required

The city name.

statestring required

The state or province. For US: must be a valid 2-letter US state code (e.g., NY, CA, TX). For CA: must be a valid 2-letter Canadian province/territory code (e.g., ON, BC, AB). For other countries: any string value is accepted.

zip_codestring required

The postal/zip code.

company_namestring

The name of the contact's company.

departmentstring

The department the contact belongs to within their organization.

positionstring

The contact's job title or position.

employee_statusstring

The current employment status of the contact (e.g., active, inactive).

contact_typestring required

The type of contact. Allowed values: employee, client.

employment_typestring

The type of employment (e.g., Full-Time, Part-Time, Contract).

start_datestring date

The contact's employment or engagement start date. Format: yyyy-mm-dd (e.g., 2024-01-15).

anniversarystring date

The contact's wedding or work anniversary date. Format: yyyy-mm-dd (e.g., 2018-06-20).

client_sincestring date

The date since the contact has been a client. Format: yyyy-mm-dd (e.g., 2020-03-01).

contact_classificationstring

A classification label for the contact (e.g., VIP, Regular).

address_validatedboolean

Indicates whether the address has been validated. Accepts true or false.

address_forcedboolean

Indicates whether the address was force-accepted despite validation issues. Accepts true or false.

address_verifiedboolean

Indicates whether the address has been verified. Accepts true or false.

listsinteger[]

An array of list IDs to associate the contact with. Each ID must be a valid, existing list ID.

labelsinteger[]

An array of label IDs to tag the contact with. Each ID must be a valid, existing contact label ID.

Response

200

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": "active",
    "created_at": "2026-04-28T23:30:14-04:00",
    "size": "LG",
    "gender": "male",
    "department": "Engineering",
    "title": "Software Developer",
    "birthday_date": "1990-05-15T00:00:00-04:00",
    "start_date": "2024-01-15T00:00:00-05:00",
    "anniversary": "2018-06-20T00:00:00-04:00",
    "client_since": "2020-03-01T00:00:00-05:00",
    "contact_classification": "VIP",
    "address_verified": true,
    "address_validated": true,
    "labels": [
      {
        "id": 1,
        "name": "Wealthbox"
      }
    ],
    "lists": [
      {
        "id": 1,
        "name": "NYC Remote"
      }
    ],
    "created_by_user": {
      "id": 5,
      "name": "Daniel Spirgelx",
      "first_name": "Daniel",
      "last_name": "Spirgel"
    }
  }
}