The contact object

object

string

String representing the object’s type. Objects of the same type share the same value. The type here is contact.

id

string

Unique identifier for the object.

creation_time

datetime

The date and time when the contact was created.

last_updated_time

datetime

The date and time when the contact was last updated. This can happen from any OnceHub product.

last_interacted_time

datetime

The date and time when the contact last interacted with a OnceHub product.

owner

string

The ID of the OnceHub user that is assigned ownership of the contact.

company

string

The name of the company that the contact works for.

city

string

The city where the contact is based.

company_size

string

If 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.

country

string

The country where the contact is based.

email

string

The email of the contact.

first_name

string

The first name of the contact.

last_name

string

The last name of the contact.

job_title

string

The job title of the contact.

has_consent

boolean

A 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_phone

string

The mobile phone number for the contact.

phone

string

The phone number for the contact. This field is typically used for a work landline.

employees

number

If 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_code

string

The post code for the contact.

salutation

string

The salutation given to the contact if no name has been provided for the contact yet. A typical value populated here will be website visitor.

state

string

The state that the contact is based in. In countries that do not have states, this field can be used for provinces.

street_address

string

Street address of the contact. This is typically a work or office address.

terms_of_service

boolean

A field specific to ScheduleOnce where a contact accepts your company's terms of service when making a booking.

timezone

string

The 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).

bot

string

Unique identifier for the chatbot that captured the contact. Will be null if the contact was captured by another object type.

form

string

Unique identifier for the form that captured the contact. Will be null if the contact was captured by another object type.

custom_fields

array of hash

Any 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.name

string

Name of the custom field.

custom_fields.value

string

Value of the custom field.