FieldTypeDescription
objectstringString representing the object’s type. Objects of the same type share the same value. The type here is contact.
idstringUnique identifier for the object.
creation_timedatetimeThe date and time when the contact was created.
last_updated_timedatetimeThe date and time when the contact was last updated. This can happen from any OnceHub product.
last_interacted_timedatetimeThe date and time when the contact last interacted with a OnceHub product.
ownerstringThe ID of the OnceHub user that is assigned ownership of the contact.
companystringThe name of the company that the contact works for.
citystringThe city where the contact is based.
company_sizestringIf a text field is used to collect information about the size of the company where the contact works, this field can store the value.
If a number field is used, see the employees field.
countrystringThe country where the contact is based.
emailstringThe email of the contact.
first_namestringThe first name of the contact.
last_namestringThe last name of the contact.
job_titlestringThe job title of the contact.
has_consent booleanA field specific to ChatOnce where a website visitor gives consent for the capture and processing of their data. This field can be used to avoid asking the same question to the same contact in the future.
mobile_phonestringThe mobile phone number for the contact.
phonestringThe phone number for the contact. This field is typically used for a work landline.
employeesnumberIf a number field is used to collect information about the size of the company where the contact works, this field can store the value.
Currently a field of type number can only be populated using ChatOnce.
If a text field is used, see the company_size field.
post_codestringThe post code for the contact.
salutationstringThe salutation given to the contact if no name has been provided for the contact yet. A typical value populated here will be website visitor.
statestringThe state that the contact is based in. In countries that do not have states, this field can be used for provinces.
street_addressstringStreet address of the contact. This is typically a work or office address.
terms_of_servicebooleanA field specific to ScheduleOnce where a contact accepts your company's terms of service when making a booking.
timezonestringThe time zone that the contact is based in. This is based of the last interaction they had with your OnceHub account (ScheduleOnce booking or ChatOnce conversation).
botstringUnique identifier for the chatbot that captured the contact. Will be null if the contact was captured by another object type.
formstringUnique identifier for the form that captured the contact. Will be null if the contact was captured by another object type.
custom_fieldsarray of hashAny custom fields that have been added to the contact fields library for your account will be listed in the array of custom fields.
custom_fields.namestringName of the custom field.
custom_fields.valuestringValue of the custom field.

CONTACT

{
  "object": "contact",
  "id": "CTC-J4FR05BKEW",
  "creation_time": "2020-03-22T09:48:48Z",
  "last_updated_time": "2020-03-22T09:48:48Z",
  "last_interacted_time": "2020-03-22T09:48:48Z",
  "owner": "USR-FSD423423",
  "city": "New York",
  "company_size": "30-50 people",
  "company": "Acme",
  "country": "USA",
  "email": "[email protected]",
  "employees": null,
  "first_name": "Carrie",
  "has_consent": true,
  "job_title": "Product manager",
  "last_name": "Customer",
  "mobile_phone": "1-2025550195",
  "phone": null,
  "post_code": null,
  "salutation": null,
  "state": null,
  "street_address": null,
  "terms_of_sevice": true,
  "timezone": "America/New_York",
  "bot": "BOT-ABC123",
  "form": null,
  "custom_fields": [
    { "name": "reason_for_contacting", "value": "I want to do business" },
    { "name": "new_to_our_tool", "value": true }
  ]
}