OnceHub
App · 25 actions
Manage OnceHub Booking Calendars appointments, look up availability and scheduling links, and maintain contacts.
Actions
| Action | What it does |
|---|---|
| Book time slot | Book a time from the available time slots. |
| Cancel booking | Cancel a booking by ID |
| Create contact | Create a new contact in your OnceHub account. |
| Create one-time booking link | Create a one time link for a Booking Calendar. |
| Delete contact | Delete a contact |
| Get available time slots | Get a list of available time slots for a booking calendar. |
| Get booking | Get a single booking by ID |
| Get booking calendar | Get a single booking calendar by ID |
| Get contact | Get a single contact |
| Get scheduling availability | Get the scheduling availability for a user |
| Get team | Get a single team by ID |
| Get user | Get a single user by ID |
| Get webhook | Get a single webhook subscription by ID. |
| List booking calendars | Get a list of all booking calendars in your account Gets one page; to see more, run it again with the next page it gives. |
| List bookings | Get a list of all bookings in the account Gets one page; to see more, run it again with the next page it gives. |
| List contacts | List all contacts in your account Gets one page; to see more, run it again with the next page it gives. |
| List SMS notifications | Get a list of SMS notifications sent from your account, sorted by creation date. |
| List teams | Get a list of all teams in your account Gets one page; to see more, run it again with the next page it gives. |
| List users | Get a list of all users in your account Gets one page; to see more, run it again with the next page it gives. |
| List webhooks | Get a list of your webhook subscriptions, sorted by creation date. |
| Mark booking as no-show | Update the booking status to no-show by ID |
| Reassign booking | Reassign an existing booking to a new host by ID. |
| Request reschedule | Request to reschedule a booking by ID |
| Update contact | Update an existing contact in your OnceHub account. |
| Validate API key | Enter your API key in the headers section below and click on "Try it" to test it. |
Book time slot
Book a time from the available time slots. Use it with the "Get available time slots" action.
Inputs
- Booking calendar
booking_calendar_idtextRequired - ID of the booking calendar
- Start time
start_timedate and timeRequired - The date and time of the time slot
- Guest time zone
guest_time_zonetextRequired - The guest's timezone in IANA timezone format
- Booking form
booking_formobjectRequired - An object containing information about the guest
- Location
locationobject - The location object is optional. If omitted, the system automatically selects an available host's pre-set location (such as `virtual`, `virtual_static` or `physical`), prioritizing `virtual` whenever it is an available option. **Note:** If only a single location is available for the slot, that location will be automatically selected. To use a guest-driven location type like `in_person_by_guest` or `guest_phone`, the value must be explicitly provided.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"id": "example"
},
"has_more": false,
"next_cursor": null
}Cancel booking
Cancel a booking by ID
Inputs
- Booking ID
booking_idtextRequired - ID of the booking
- Cancellation reason
cancellation_reasontext - Reason for cancelling the meeting (optional)
- Send cancellation email
send_cancellation_emailtrue/false - Whether a cancellation email should be sent
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"attendees": [],
"booking_calendar": "example",
"cancel_reschedule_information": {
"actioned_by": "example",
"reason": "example",
"user_id": "example"
},
"cancel_url": "example",
"creation_time": "example",
"custom_fields": [],
"customer_timezone": "example",
"duration_minutes": 0,
"external_calendar": {
"event_id": "example",
"id": "example",
"name": "example",
"type": "example"
},
"form_submission": {
"company": null,
"custom_fields": [],
"email": "example",
"guests": [],
"mobile_phone": "example",
"name": "example",
"note": "example",
"phone": null
},
"ics_url": "example",
"id": "example",
"in_trash": false,
"last_updated_time": "example",
"location_description": "example",
"object": "example",
"payment_information": null,
"reschedule_url": "example",
"rescheduled_booking_id": "example",
"starting_time": "example",
"status": "example",
"subject": "example",
"tracking_id": "example",
"virtual_conferencing": {
"join_url": "example"
}
},
"has_more": false,
"next_cursor": null
}Create contact
Create a new contact in your OnceHub account. Either email or mobile phone is required; at least one must be provided.
Inputs
- Object
objecttext - String representing the object's type
- ID
idtext - Unique identifier for the contact
- Creation time
creation_timedate and time - The date and time when the contact was created
- Last updated time
last_updated_timedate and time - The date and time the contact was last updated
- Last interacted time
last_interacted_timedate and time - The date and time of the last interaction with the contact
- Owner
ownertext - The ID of the owner of the contact
- Status
statustext - The status of the contact. Accepted values are `Qualified`, `Sales qualified`, `Marketing qualified`, or `Disqualified`. If any other value is provided or no value is provided, the status will be set to null.One of:
Qualified,Sales qualified,Marketing qualified,Disqualified. - City
citytext - City of the contact
- Company size
company_sizetext - Size of the contact's company
- Company
companytext - Company name
- Country
countrytext - Country of the contact
- Email
emailtext - Email address of the contact
- Employees
employeesnumber - Number of employees
- First name
first_nametextRequired - First name of the contact
- Has consent
has_consenttrue/false - Whether the contact has given consent
- Job title
job_titletext - Job title of the contact
- Last name
last_nametextRequired - Last name of the contact
- Mobile phone
mobile_phonetext - Mobile phone number in E.164 format
- Phone
phonetext - Phone number in E.164 format
- Post code
post_codetext - Postal code
- Salutation
salutationtext - Salutation
- State
statetext - State or province
- Street address
street_addresstext - Street address
- Terms of sevice
terms_of_sevicetrue/false - Whether terms of service were accepted
- Timezone
timezonetext - Timezone of the contact
- Custom fields
custom_fieldslist - Custom fields associated with the contact
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"city": null,
"company": null,
"company_size": null,
"country": null,
"creation_time": "example",
"custom_fields": [],
"email": "example",
"employees": 0,
"first_name": null,
"has_consent": false,
"id": "example",
"job_title": null,
"last_interacted_time": null,
"last_name": null,
"last_updated_time": "example",
"mobile_phone": null,
"object": "example",
"owner": "example",
"phone": null,
"post_code": null,
"salutation": null,
"state": null,
"status": null,
"street_address": null,
"terms_of_sevice": false,
"timezone": "example"
},
"has_more": false,
"next_cursor": null
}Create one-time booking link
Create a one time link for a Booking Calendar.
Inputs
- Booking calendar
booking_calendar_idtextRequired - ID of the booking calendar
- Hide URL params
hide_url_paramstrue/false - When set to `true`, the API generates a short one-time-use link with no visible query parameters.
- Booking form
booking_formobject - An object containing information about the guest
- UTM params
utm_paramsobject - Object containing captured values for the 5 standard UTM parameters.
- Booking settings
booking_settingsobject - Settings for the booking calendar when the one-time link is used.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"creation_time": "example",
"id": "example",
"url": "example"
},
"has_more": false,
"next_cursor": null
}Delete contact
Delete a contact
Inputs
- Contact
contact_idtextRequired - ID of the contact
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"deleted": false,
"id": "example"
},
"has_more": false,
"next_cursor": null
}Get available time slots
Get a list of available time slots for a booking calendar. All datetime strings are ISO 8601 in full form.
Inputs
- Start time
start_timedate and time - The date and time from which to begin checking for available slots. If not provided, the system defaults to current time.
- End time
end_timedate and time - The date and time up to which to check for available slots. If not provided, the system defaults to one week from `start_time`.
- Booking calendar
booking_calendar_idtextRequired - ID of the booking calendar
Outputs
Result.
datalist- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null
}Get booking
Get a single booking by ID
Inputs
- Booking ID
booking_idtextRequired - ID of the booking
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"attendees": [],
"booking_calendar": "example",
"cancel_reschedule_information": null,
"cancel_url": "example",
"contact": "example",
"conversation": null,
"creation_time": "example",
"custom_fields": [],
"customer_timezone": "example",
"duration_minutes": 0,
"external_calendar": {
"event_id": "example",
"id": "example",
"name": "example",
"type": "example"
},
"form_submission": {
"company": null,
"custom_fields": [],
"email": "example",
"guests": [],
"mobile_phone": "example",
"name": "example",
"note": "example",
"phone": null
},
"ics_url": "example",
"id": "example",
"in_trash": false,
"last_updated_time": "example",
"location_description": "example",
"object": "example",
"owner": "example",
"payment_information": null,
"reschedule_url": "example",
"rescheduled_booking_id": "example",
"starting_time": "example",
"status": "example",
"subject": "example",
"tracking_id": "example",
"utm_params": null,
"virtual_conferencing": {
"join_url": "example"
}
},
"has_more": false,
"next_cursor": null
}Get booking calendar
Get a single booking calendar by ID
Inputs
- Booking calendar
booking_calendar_idtextRequired - ID of the booking calendar
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"duration_minutes": 0,
"host": "example",
"id": "example",
"name": "example",
"object": "example",
"published": false,
"subject": "example",
"url": "example"
},
"has_more": false,
"next_cursor": null
}Get contact
Get a single contact
Inputs
- Contact
contact_idtextRequired - ID of the contact
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"city": null,
"company": null,
"company_size": null,
"country": null,
"creation_time": "example",
"custom_fields": [],
"email": "example",
"employees": 0,
"first_name": null,
"has_consent": false,
"id": "example",
"job_title": null,
"last_interacted_time": null,
"last_name": null,
"last_updated_time": "example",
"mobile_phone": null,
"object": "example",
"owner": "example",
"phone": null,
"post_code": null,
"salutation": null,
"state": null,
"status": null,
"street_address": null,
"terms_of_sevice": false,
"timezone": "example"
},
"has_more": false,
"next_cursor": null
}Get scheduling availability
Get the scheduling availability for a user
Inputs
- Target user
target_user_idtextRequired - ID of the user
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get team
Get a single team by ID
Inputs
- Target team
target_team_idtextRequired - ID of the team.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"id": "example",
"name": "example",
"object": "example"
},
"has_more": false,
"next_cursor": null
}Get user
Get a single user by ID
Inputs
- Target user
target_user_idtextRequired - ID of the user
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"object": "example",
"role_name": "example",
"status": "example",
"teams": [],
"timezone": "example"
},
"has_more": false,
"next_cursor": null
}Get webhook
Get a single webhook subscription by ID.
Inputs
- Webhook
webhook_idtextRequired - ID of the webhook
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"api_version": "example",
"creation_time": "example",
"events": [],
"id": "example",
"name": "example",
"object": "example",
"secret": "example",
"url": "example"
},
"has_more": false,
"next_cursor": null
}List booking calendars
Get a list of all booking calendars in your account Gets one page; to see more, run it again with the next page it gives.
Inputs
- Host
hosttext - Filter booking calendars hosted by this user ID or team ID
- Before
beforetext - A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.
- After
aftertext - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.
- Limit
limitnumber - Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.From 1 to 100.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"data": [],
"has_more": false,
"object": "example"
},
"has_more": false,
"next_cursor": null
}List bookings
Get a list of all bookings in the account Gets one page; to see more, run it again with the next page it gives.
Inputs
- Status
statustext - Only return bookings that have the given status.One of:
requested,scheduled,rescheduled,completed,canceled,no_show. - Owner
ownertext - Only return booking owned by a user with a specific user ID.
- Contact
contacttext - Only return bookings that were scheduled with the contact with the provided ID.
- Creation time gt
creation_time_gtdate - Return bookings with creation time greater than the given date.
- Creation time lt
creation_time_ltdate - Return bookings with creation time less than the given date.
- Starting time gt
starting_time_gtdate - Return bookings with starting time greater than the given date.
- Starting time lt
starting_time_ltdate - Return bookings with starting time less than the given date.
- Last updated time gt
last_updated_time_gtdate - Return bookings with last updated time greater than the given date.
- Last updated time lt
last_updated_time_ltdate - Return bookings with last updated time less than the given date.
- Expand
expandlist - A comma separated list of fields that you want to expand. Possible values are `owner`, `contact`, `conversation`.One or more of:
owner,contact,conversation. - Before
beforetext - A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.
- After
aftertext - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.
- Limit
limitnumber - Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.From 1 to 100.
- Booking calendar
booking_calendartext - Only return bookings that were created from the booking calendar with the provided ID.
- Host
hosttext - Only return bookings hosted or co-hosted by a user with a specific user ID.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"data": [],
"has_more": false,
"object": "example"
},
"has_more": false,
"next_cursor": null
}List contacts
List all contacts in your account Gets one page; to see more, run it again with the next page it gives.
Inputs
- Email
emailtext - Filter by the contact's email address
- Creation time lt
creation_time_ltdate - Return contacts with creation time less than the given date.
- Last updated time gt
last_updated_time_gtdate - Return contacts with last updated time greater than the given date.
- Last updated time lt
last_updated_time_ltdate - Return contacts with last updated time less than the given date.
- Creation time gt
creation_time_gtdate - Return contacts with creation time greater than the given date.
- Before
beforetext - A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.
- After
aftertext - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.
- Limit
limitnumber - Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.From 1 to 100.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"data": [],
"has_more": false,
"object": "example"
},
"has_more": false,
"next_cursor": null
}List SMS notifications
Get a list of SMS notifications sent from your account, sorted by creation date. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Creation time gt
creation_time_gtdate and time - Return SMS notifications created after this date
- Creation time lt
creation_time_ltdate and time - Return SMS notifications created before this date
- Recipient
recipienttext - Filter by specific recipient ID (contact or user ID).
- Recipient type
recipient_typetext - Filter by recipient type. Valid values are `contact` or `user`.One of:
contact,user. - Before
beforetext - A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.
- After
aftertext - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.
- Limit
limitnumber - Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.From 1 to 100.
- Expand
expandlist - A comma-separated list of fields to expand. Currently supports: `recipient`.One or more of:
recipient.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"data": [],
"object": "example"
},
"has_more": false,
"next_cursor": null
}List teams
Get a list of all teams in your account Gets one page; to see more, run it again with the next page it gives.
Inputs
- User
usertext - Return all teams that the provided user is a member of.
- Before
beforetext - A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.
- After
aftertext - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.
- Limit
limitnumber - Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.From 1 to 100.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"data": [],
"has_more": false,
"object": "example"
},
"has_more": false,
"next_cursor": null
}List users
Get a list of all users in your account Gets one page; to see more, run it again with the next page it gives.
Inputs
- Email
emailtext - Filter by email address
- Before
beforetext - A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.
- After
aftertext - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.
- Limit
limitnumber - Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.From 1 to 100.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"data": [],
"has_more": false,
"object": "example"
},
"has_more": false,
"next_cursor": null
}List webhooks
Get a list of your webhook subscriptions, sorted by creation date. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Before
beforetext - A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.
- After
aftertext - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.
- Limit
limitnumber - Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.From 1 to 100.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"data": [],
"has_more": false,
"object": "example"
},
"has_more": false,
"next_cursor": null
}Mark booking as no-show
Update the booking status to no-show by ID
Inputs
- Booking ID
booking_idtextRequired - ID of the booking
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"attendees": [],
"booking_calendar": "example",
"cancel_reschedule_information": null,
"cancel_url": "example",
"contact": "example",
"conversation": null,
"creation_time": "example",
"custom_fields": [],
"customer_timezone": "example",
"duration_minutes": 0,
"external_calendar": {
"event_id": "example",
"id": "example",
"name": "example",
"type": "example"
},
"form_submission": {
"company": null,
"custom_fields": [],
"email": "example",
"guests": [],
"mobile_phone": "example",
"name": "example",
"note": "example",
"phone": null
},
"ics_url": "example",
"id": "example",
"in_trash": false,
"last_updated_time": "example",
"location_description": "example",
"object": "example",
"owner": "example",
"payment_information": null,
"reschedule_url": "example",
"rescheduled_booking_id": "example",
"starting_time": "example",
"status": "example",
"subject": "example",
"tracking_id": "example",
"utm_params": null,
"virtual_conferencing": {
"join_url": "example"
}
},
"has_more": false,
"next_cursor": null
}Reassign booking
Reassign an existing booking to a new host by ID.
Inputs
- Booking ID
booking_idtextRequired - The unique ID of the booking.
- New host
new_hosttextRequired - The OnceHub user ID for the new host. The user must belong to the same account, hold an active seat license, and cannot be the current host of the booking.
- Location
locationobject - Optional. Determines how the location is handled when a meeting is reassigned to a new host. **Case 1: When `location` object is omitted:** The system applies the following logic based on the original booking's location type: - *Online Meetings:* The system first tries to use the same Video Conference Service provider as the original host. If that specific Video Conference Service provider is not connected to the new host, it automatically selects the best available integration based on this priority: 1. Google Meet 2. Microsoft Teams 3. Zoom 4. Webex Meetings 5. GoTo Meeting - *In-person/ Phone Meetings:* The location remains unchanged for t
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"attendees": [],
"booking_calendar": "example",
"cancel_reschedule_information": null,
"cancel_url": "example",
"contact": "example",
"conversation": null,
"creation_time": "example",
"custom_fields": [],
"customer_timezone": "example",
"duration_minutes": 0,
"external_calendar": {
"event_id": "example",
"id": "example",
"name": "example",
"type": "example"
},
"form_submission": {
"company": null,
"custom_fields": [],
"email": "example",
"guests": [],
"mobile_phone": "example",
"name": "example",
"note": "example",
"phone": null
},
"ics_url": "example",
"id": "example",
"in_trash": false,
"last_updated_time": "example",
"location_description": "example",
"object": "example",
"owner": "example",
"payment_information": null,
"reschedule_url": "example",
"rescheduled_booking_id": "example",
"starting_time": "example",
"status": "example",
"subject": "example",
"tracking_id": "example",
"utm_params": null,
"virtual_conferencing": {
"join_url": "example"
}
},
"has_more": false,
"next_cursor": null
}Request reschedule
Request to reschedule a booking by ID
Inputs
- Booking ID
booking_idtextRequired - ID of the booking
- Reschedule reason
reschedule_reasontext - Reason for requesting the customer to reschedule the meeting (optional)
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"attendees": [],
"booking_calendar": "example",
"cancel_reschedule_information": {
"actioned_by": "example",
"reason": "example",
"user_id": "example"
},
"cancel_url": "example",
"creation_time": "example",
"custom_fields": [],
"customer_timezone": "example",
"duration_minutes": 0,
"external_calendar": {
"event_id": "example",
"id": "example",
"name": "example",
"type": "example"
},
"form_submission": {
"company": null,
"custom_fields": [],
"email": "example",
"guests": [],
"mobile_phone": "example",
"name": "example",
"note": "example",
"phone": null
},
"ics_url": "example",
"id": "example",
"in_trash": false,
"last_updated_time": "example",
"location_description": "example",
"object": "example",
"payment_information": null,
"reschedule_url": "example",
"rescheduled_booking_id": "example",
"starting_time": "example",
"status": "example",
"subject": "example",
"tracking_id": "example",
"virtual_conferencing": {
"join_url": "example"
}
},
"has_more": false,
"next_cursor": null
}Update contact
Update an existing contact in your OnceHub account. At least one field must be provided. Identifier fields (email, mobile phone) cannot be updated here. Only the custom fields provided are updated, so partial updates are supported.
Inputs
- Contact
contact_idtextRequired - ID of the contact to update
- First name
first_nametext - First name of the contact
- Last name
last_nametext - Last name of the contact
- Owner
ownertext - The ID of the owner of the contact
- Status
statustext - The status of the contact. Accepted values are `Qualified`, `Sales qualified`, `Marketing qualified`, or `Disqualified`. If any other value is provided or no value is provided, the status will be set to null.One of:
Qualified,Sales qualified,Marketing qualified,Disqualified. - City
citytext - City of the contact
- Company size
company_sizetext - Size of the contact's company
- Company
companytext - Company name
- Country
countrytext - Country of the contact
- Employees
employeesnumber - Number of employees
- Has consent
has_consenttrue/false - Whether the contact has given consent
- Job title
job_titletext - Job title of the contact
- Phone
phonetext - Phone number in E.164 format
- Post code
post_codetext - Postal code
- Salutation
salutationtext - Salutation
- State
statetext - State or province
- Street address
street_addresstext - Street address
- Terms of sevice
terms_of_sevicetrue/false - Whether terms of service were accepted
- Timezone
timezonetext - Timezone of the contact
- Custom fields
custom_fieldslist - Custom fields to update. Only the custom fields provided will be updated.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"city": null,
"company": null,
"company_size": null,
"country": null,
"creation_time": "example",
"custom_fields": [],
"email": "example",
"employees": 0,
"first_name": null,
"has_consent": false,
"id": "example",
"job_title": null,
"last_interacted_time": null,
"last_name": null,
"last_updated_time": "example",
"mobile_phone": null,
"object": "example",
"owner": "example",
"phone": null,
"post_code": null,
"salutation": null,
"state": null,
"status": null,
"street_address": null,
"terms_of_sevice": false,
"timezone": "example"
},
"has_more": false,
"next_cursor": null
}Validate API key
Enter your API key in the headers section below and click on "Try it" to test it.
Inputs
None.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"message": "example"
},
"has_more": false,
"next_cursor": null
}