Contact

The Contact object

Attributes

external_idstring · min: 1 · max: 100Required

Your system's unique identifier for this contact. Can be set on create or updated if the current value is null.

Example: CRM123456

first_namestring · min: 1 · max: 100Required

Contact's first name

Example: Alex

last_namestring · min: 1 · max: 100Required

Contact's last name

Example: Lee

address_1string · min: 1 · max: 100Optional

Primary address line

Example: 1215 19th St

address_2string · min: 1 · max: 100 · nullableOptional

Secondary address line

Example: Suite 100

birth_datestring · enumOptional

Contact's date of birth

Example: 01/15/1955Possible values:

citystring · min: 1 · max: 100Optional

City name

Example: Sacramento

emailstring · emailOptional

Contact's email address

Example: [e-mail]

extra_helpboolean,string · enum · nullableOptional

Whether the contact receives Extra Help

Example: falsePossible values:

medicaid_eligibleboolean,string · enum · nullableOptional

Whether the contact is eligible for Medicaid

Example: falsePossible values:

medicaid_numberstringOptional

Contact's Medicaid number

Example: MED123456

medicare_numberstring · min: 1 · max: 1000Optional

Contact's Medicare number

Example: 1EG4TE5MK73

medicare_part_a_effective_datestring · enumOptional

Medicare Part A effective date

Example: 01/01/2024Possible values:

medicare_part_b_effective_datestring · enumOptional

Medicare Part B effective date

Example: 01/01/2024Possible values:

notesstring[] · min: 1 · max: 50Optional

Array of notes about the contact. Each item in the notes array will be added as a note on the contact record. When updating, it will append to the existing notes and not overwrite any of the existing notes.

Example: ["Initial contact made on 03/20/2024"]

phonestringOptional

Contact's phone number

Example: 8557722663

sexstring · enumOptional

Contact's sex

Example: malePossible values:

statusstring · enumOptional

Contact's workflow status. Defaults to new when omitted on create; unsupported values are also treated as new.

Example: in_progressPossible values:

statestringOptional

Two-letter state code

Example: CA

typestring · enumOptional

Contact type

Example: clientPossible values:

zipstringOptional

ZIP code

Example: 95811

authorized_representative_namestring · min: 1 · max: 100Optional

Name of the authorized representative

Example: Jane Doe

authorized_representative_relationshipstring · enumOptional

Relationship of the authorized representative to the contact

Example: spousePossible values:

authorized_representative_phone_numberstringOptional

Phone number of the authorized representative

Example: 8557722663

authorized_representative_emailstring · emailOptional

Email address of the authorized representative

Example: [e-mail]

authorized_representative_addressstring · min: 1 · max: 100Optional

Street address of the authorized representative

Example: 456 Oak Ave

authorized_representative_citystring · min: 1 · max: 100Optional

City of the authorized representative

Example: Sacramento

authorized_representative_statestringOptional

Two-letter state code of the authorized representative

Example: CA

authorized_representative_zip_codestringOptional

ZIP code of the authorized representative

Example: 95811

mailing_address_streetstring · min: 1 · max: 100Optional

Street address for mailing

Example: 789 Mailing Ln

mailing_address_unit_numberstring · min: 1 · max: 100 · nullableOptional

Unit number for mailing address

Example: Apt 2B

mailing_address_citystring · min: 1 · max: 100Optional

City for mailing address

Example: Sacramento

mailing_address_statestringOptional

Two-letter state code for mailing address

Example: CA

mailing_address_zip_codestringOptional

ZIP code for mailing address

Example: 95811

The Contact object

{
  "external_id": "CRM123456",
  "first_name": "Alex",
  "last_name": "Lee",
  "address_1": "1215 19th St",
  "address_2": "Suite 100",
  "birth_date": "01/15/1955",
  "city": "Sacramento",
  "email": "[e-mail]",
  "extra_help": false,
  "medicaid_eligible": false,
  "medicaid_number": "MED123456",
  "medicare_number": "1EG4TE5MK73",
  "medicare_part_a_effective_date": "01/01/2024",
  "medicare_part_b_effective_date": "01/01/2024",
  "notes": [
    "Initial contact made on 03/20/2024"
  ],
  "phone": "8557722663",
  "sex": "male",
  "status": "in_progress",
  "state": "CA",
  "type": "client",
  "zip": "95811",
  "authorized_representative_name": "Jane Doe",
  "authorized_representative_relationship": "spouse",
  "authorized_representative_phone_number": "8557722663",
  "authorized_representative_email": "[e-mail]",
  "authorized_representative_address": "456 Oak Ave",
  "authorized_representative_city": "Sacramento",
  "authorized_representative_state": "CA",
  "authorized_representative_zip_code": "95811",
  "mailing_address_street": "789 Mailing Ln",
  "mailing_address_unit_number": "Apt 2B",
  "mailing_address_city": "Sacramento",
  "mailing_address_state": "CA",
  "mailing_address_zip_code": "95811"
}