v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

Contacts

Update a contact

Update a contact. Currently supports updating custom field values.

patch/v1/contacts/{id}

Path parameters

idstring required

The contact ID

Request body

custom_fieldsobject

Custom field values as key-value pairs. Keys must match custom field keys defined for the Contact entity type.

Example request

{
  "custom_fields": {
    "referral_source": "Conference"
  }
}

Response

successful

idstring required

The contact ID

book_idstring required

The book ID

custom_fieldsobject

Custom field values as key-value pairs

created_atstring date-time required

When the contact was created

updated_atstring date-time required

When the contact was last updated

Example response

{
  "id": "abc123xyz",
  "book_id": "book123xyz",
  "person": {
    "id": "abc123xyz",
    "book_id": "book123xyz",
    "household_id": "xyz789abc",
    "contact_id": "cnt456def",
    "role_type": "client",
    "first_name": "John",
    "middle_name": "Robert",
    "last_name": "Doe",
    "salutation": "Mr.",
    "suffix": "Jr.",
    "maiden_name": "Smith",
    "gender": "male",
    "designations": "CPA, CFP",
    "household_role": "head_of_household",
    "preferred_name": "Johnny",
    "date_of_birth": "1985-06-15",
    "job_title": "Software Engineer",
    "ssn": "***-**-6789",
    "drivers_license_number": "******7890",
    "email_addresses": [
      {
        "email": "john.doe@example.com",
        "email_type": "personal",
        "is_primary": true
      }
    ],
    "phone_numbers": [
      {
        "phone_number": "+15555551234",
        "extension": "1234",
        "phone_type": "mobile",
        "is_primary": true
      }
    ],
    "addresses": [
      {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country_code": "US",
        "address_type": "home",
        "is_primary": true
      }
    ],
    "employments": [
      {
        "id": "emp123xyz",
        "person_id": "abc123xyz",
        "business_name": "Acme Corp",
        "role": "Software Engineer",
        "start_date": "2023-01-15",
        "end_date": "2024-12-31",
        "actively_employed": true
      }
    ],
    "custom_fields": {
      "preferred_contact_method": "Email",
      "risk_tolerance": "Moderate"
    }
  },
  "custom_fields": {
    "referral_source": "Conference"
  }
}