Scope requirements
Scope requirements
Create appointments
To create new appointments:- To create one appointment, make a
POSTrequest to/crm/objects/2026-03/appointments. - To create multiple appointments, make a
POSTrequest to/crm/objects/2026-03/appointments/batch/create.
properties object. You can also add an associations object to associate your new appointment with existing records (e.g., contacts, companies), or activities (e.g., meetings, notes).
For batch create actions, you can enable multi-status errors which tell you which records were successfully created and which were not. Learn more about setting up multi-status error handling.
Create appointments with property values
When creating an appointment, include appointment properties to store the appointment’s details. For example, to create a new appointment, your request may look similar to the following:GET request to /crm/properties/2026-03/appointments. Learn more about the properties API.
Create appointments with associations
When creating a new appointment, you can also associate the appointment with existing records or activities by including anassociations array.
For example, to associate a new appointment with an existing contact, your request would look like the following:
| Parameter | Description |
|---|---|
to | The record or activity you want to associate with the appointment, specified by its unique id value. |
types | The type of the association between the appointment and the record/activity. Include the associationCategory and associationTypeId. Default association type IDs are listed on the associations API guide, or you can retrieve the value for custom association types via the associations API. |
Retrieve appointments
You can retrieve appointments individually or in batches. Include the following query parameters in your request URLs to retrieve certain data.| Parameter | Description |
|---|---|
properties | A comma-separated list of the properties to be returned in the response. If a requested property isn’t defined, it won’t be included in the response. If a requested property is defined but an appointment doesn’t have a value, it will be returned as null. |
propertiesWithHistory | A comma-separated list of the current and historical properties to be returned in the response. |
associations | Supported when retrieving an individual appointment or all appointments, a comma-separated list of objects to retrieve associated IDs for. Learn more about the associations API. |
Retrieve an individual appointment
To retrieve an individual appointment by its record ID, make aGET request to /crm/objects/2026-03/appointments/{appointmentId}.
Retrieve all appointments
To request a list of all appointments, make aGET request to /crm/objects/2026-03/appointments.
You can retrieve up to 100 appointments in one request.
- To retrieve a specific amount under 100, add a value to the
limitparameter. For example,?limit=50. - To paginate through results, include the
afterparameter with theaftervalue returned from the previous request.
Retrieve a batch of appointments
To retrieve appointments in batches, make aPOST request to /crm/objects/2026-03/appointments/batch/read. Include the id values of the appointments you want to retrieve.
For example, to retrieve a batch of appointments by their record ID values:
Update appointments
You can update appointments individually or in batches.Update an individual appointment
To update an individual appointment by its record ID, make aPATCH request to /crm/objects/2026-03/appointments/{appointmentId}, and include the data you want to update.
For example:
Update a batch of appointments
To update multiple appointments, make aPOST request to /crm/objects/2026-03/appointments/batch/update. In your request body, include each appointment’s record ID as the id and include the properties you want to update.
For example:
Upsert appointments
You can batch create and update appointments at the same time using the upsert endpoint. Following the request, if the appointments already exist, they’ll be updated; if they don’t exist, they’ll be created. To upsert appointments, make aPOST request to /crm/objects/2026-03/appointments/batch/upsert.
Associate existing appointments with records or activities
To associate an appointment with other CRM records or an activity, make aPUT request to /crm/objects/2026-03/appointments/{appointmentId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.
To retrieve the
associationTypeId value, refer to the list of default values, or make a GET request to /crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels.Delete appointments
You can delete appointments individually or in batches, which will add the appointment to the recycling bin in HubSpot. You can later restore the record within HubSpot.- To delete an individual appointment, make a
DELETErequest to/crm/objects/2026-03/appointments/{appointmentId}. - To delete appointments in batches, make a
POSTrequest to/crm/objects/2026-03/appointments/batch/archive.