|
Key |
Label |
Type |
Description |
|
id |
Booking ID |
integer |
Unique booking identifier. |
|
id_venue |
Venue ID |
integer |
Identifier of the venue where the booking was created. |
|
active |
Active |
integer/boolean |
Indicates if the booking is active (1) or inactive (0). |
|
name |
Name |
string |
Name of the event associated with the booking. |
|
descr |
Description (HTML) |
string |
Full HTML description of the booking or event. |
|
last_modified |
Last Modified |
datetime |
Date and time when the booking was last updated, in ISO 8601 format. |
|
url |
Public URL |
string |
Public storefront link to view booking details. |
|
Name (key) |
Label |
Type |
Required |
Description |
|
booking_id |
Booking ID |
integer/string |
true |
Provide the Booking ID to filter performances. |
|
Key |
Label |
Type |
Description |
|
id |
Performance ID |
integer |
Unique identifier of the performance. |
|
datetime |
Date/Time |
string/datetime |
Date and time when the performance is scheduled, in ISO 8601 format. |
|
active |
Active |
integer/boolean |
Indicates if the performance is active (1) or inactive (0). |
|
location |
Location |
string |
Venue or location where the performance will take place. |
|
url |
Public URL |
string |
Public storefront link where the performance details can be viewed online. |
|
Name (key) |
Label |
Type |
Required |
Description |
|
booking_id |
Booking ID |
integer/string |
true |
The unique ID of the booking. Usually mapped directly from the New Booking trigger output. |
|
Key |
Label |
Type |
Description |
|
id |
Performance ID |
integer |
Unique identifier of the performance. |
|
datetime |
Date/Time |
string/datetime |
Date and time when the performance is scheduled, in ISO 8601 format. |
|
active |
Active |
integer/boolean |
Indicates if the performance is active (1) or inactive (0). |
|
location |
Location |
string |
Venue or location where the performance will take place. |
|
url |
Public URL |
string |
Public storefront link where the performance details can be viewed online. |
|
Key |
Label |
Type |
Description |
|
id |
Contact ID |
integer/string |
Unique identifier of the contact. |
|
fname |
First Name |
string |
Contact’s first name. |
|
lname |
Last Name |
string |
Contact’s last name. |
|
|
|
string |
Primary email address of the contact. |
|
phone |
Phone |
string |
Contact phone number. |
|
notes |
Notes |
string |
Free-form notes for the contact. |
|
health |
Health |
integer |
Health score of the contact. |
|
subscribed |
Subscribed |
integer/boolean |
1 if subscribed to marketing, 0 otherwise. |
|
active |
Active |
integer/boolean |
1 if contact is active, 0 otherwise. |
|
timestamp |
Updated At |
datetime |
Last update datetime in ISO 8601 format. |
|
created |
Created At |
datetime |
Creation datetime in ISO 8601 format. |
|
custom_field_1–12 |
Custom Field 1–12 |
object |
Each custom text field as an object with name and value. |
|
custom_datetime_1 |
Custom Datetime 1 |
object |
Custom datetime field (name / value as ISO 8601 datetime). |
|
custom_date_1 |
Custom Date 1 |
object |
Custom date field (name / value as YYYY-MM-DD). |
|
custom_date_2 |
Custom Date 2 |
object |
Second custom date field (name / value). |
|
addresses |
Addresses |
array / null |
Array of address objects or null if no addresses are stored. |
|
meta.statusCode |
Meta Status Code |
integer |
Status code for the contacts list response. |
|
meta.since |
Meta Since |
datetime |
Effective since filter used for the query. |
|
meta.nextPage |
Meta Next Page |
integer |
Next page number, if available. |
|
meta.totalRowCount |
Meta Total Row Count |
integer |
Total number of contacts available for the query. |
|
Name (key) |
Label |
Type |
Required |
Description |
|
fname |
First Name |
string |
true |
Contact’s first name. |
|
lname |
Last Name |
string |
true |
Contact’s last name. |
|
|
|
string |
true |
Primary email address. |
|
phone |
Phone |
string |
false |
Contact phone number. |
|
notes |
Notes |
string |
false |
Free-form notes. |
|
health |
Health |
integer |
false |
Health score value. |
|
subscribed |
Subscribed |
integer/boolean |
false |
1 if subscribed, 0 otherwise. |
|
active |
Active |
integer/boolean |
false |
1 if active, 0 otherwise. |
|
custom_field_1–12 |
Custom Field 1–12 |
string |
false |
Custom text fields. |
|
custom_datetime_1 |
Custom Datetime 1 |
datetime |
false |
Custom datetime (ISO 8601). |
|
custom_date_1 |
Custom Date 1 |
date |
false |
Custom date (YYYY-MM-DD). |
|
custom_date_2 |
Custom Date 2 |
date |
false |
Second custom date. |
|
addresses |
Addresses |
line item group |
false |
List of address objects for the contact. |
|
Key |
Label |
Type |
Description |
|
statusCode |
Status Code |
integer |
Operation status code (e.g., 200 on success). |
|
message |
Message |
string |
Human-readable description of the result. |
|
contactId |
Contact ID |
integer |
ID of the newly created contact. |
|
Name (key) |
Label |
Type |
Required |
Description |
|
contact_id |
Contact ID |
integer/string |
true |
ID of the contact to update. |
|
fname |
First Name |
string |
false |
Updated first name. |
|
lname |
Last Name |
string |
false |
Updated last name. |
|
|
|
string |
false |
Updated email address. |
|
phone |
Phone |
string |
false |
Updated phone number. |
|
notes |
Notes |
string |
false |
Updated notes. |
|
health |
Health |
integer |
false |
Updated health score. |
|
subscribed |
Subscribed |
integer/boolean |
false |
Updated subscription flag. |
|
active |
Active |
integer/boolean |
false |
Updated active flag. |
|
custom_field_1–12 |
Custom Field 1–12 |
string |
false |
Updated custom text fields. |
|
custom_datetime_1 |
Custom Datetime 1 |
datetime |
false |
Updated custom datetime. |
|
custom_date_1 |
Custom Date 1 |
date |
false |
Updated custom date. |
|
custom_date_2 |
Custom Date 2 |
date |
false |
Second custom date. |
|
addresses |
Addresses |
line item group |
false |
Full updated address list for the contact. |
|
Key |
Label |
Type |
Description |
|
statusCode |
Status Code |
integer |
Operation status code (e.g., 200 on success). |
|
message |
Message |
string |
Human-readable description of the result. |
|
contactId |
Contact ID |
integer |
ID of the updated contact. |
|
Name (key) |
Label |
Type |
Required |
Description |
|
contact_id |
Contact ID |
integer/string |
true |
ID of the contact to be deleted. |
|
Key |
Label |
Type |
Description |
|
statusCode |
Status Code |
integer |
Operation status code (e.g., 200 on success). |
|
updatedRows |
Updated Rows |
integer |
Number of rows affected (typically 1). |
|
message |
Message |
string |
Human-readable description of the result. |