Field | Type | Description |
---|---|---|
| string | String representing the object’s type. Objects of the same type share the same value. The type here is |
| string | Unique identifier for the object. |
| datetime | The date and time when the contact was created. |
| datetime | The date and time when the contact was last updated. This can happen from any OnceHub product. |
| datetime | The date and time when the contact last interacted with a OnceHub product. |
| string | The ID of the OnceHub user that is assigned ownership of the contact. |
| string | The name of the company that the contact works for. |
| string | The city where the contact is based. |
| 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 |
| string | The country where the contact is based. |
| string | The email of the contact. |
| string | The first name of the contact. |
| string | The last name of the contact. |
| string | The job title of the contact. |
| 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. |
| string | The mobile phone number for the contact. |
| string | The phone number for the contact. This field is typically used for a work landline. |
| 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 |
| string | The post code for the contact. |
| 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. |
| string | The state that the contact is based in. In countries that do not have states, this field can be used for provinces. |
| string | Street address of the contact. This is typically a work or office address. |
| boolean | A field specific to ScheduleOnce where a contact accepts your company's terms of service when making a booking. |
| 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). Displayed in IANA timezone format . |
| string | Unique identifier for the chatbot that captured the contact. Will be null if the contact was captured by another object type. |
| string | Unique identifier for the form that captured the contact. Will be null if the contact was captured by another object type. |
| array of hash | Any custom fields that have been added to the field library for the contact object type on your account will be listed in the array of custom fields. |
| string | Name of the custom field. |
| any | Value 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 },
{
"name": "attachments",
"value": [
{
"fileName": "BKNG-46K9MB0ZFTN5",
"link": "https://app.oncehub.com/download/attachment?trackingId=BKNG-46K9MB0ZFTN5"
}
]
}
]
}