Tickets

In HubSpot, tickets represents customer requests for help. Tickets are tracked through your support process in pipeline statuses until they're closed. The tickets endpoints allow you to manage create and manage ticket records, as well as sync ticket data between HubSpot and other systems. 

Learn more about objects, records, properties, and associations APIs in the Understanding the CRM guide. For more general information about objects and records in HubSpot, learn how to manage your CRM database.

To create new tickets, make a POST request to /crm/v3/objects/tickets.

In your request, include your ticket data in a properties object. You can also add an associations object to associate your new ticket with existing records (e.g., contacts, companies), or activities (e.g., meetings, notes).

Ticket details are stored in ticket properties. There are default HubSpot ticket properties, but you can also create custom properties.

When creating a new ticket, you should include the following properties in your request: subject (the ticket's name), hs_pipeline_stage (the ticket's status) and if you have multiple pipelines, hs_pipeline. If a pipeline isn't specified, the default pipeline will be used.

To view all available properties, you can retrieve a list of your account's ticket properties by making a GET request to /crm/v3/properties/tickets. Learn more about the the properties API.

For example, to create a new ticket, your request may look similar to the following:

When creating a new ticket, you can also associate the ticket with existing records or activities. In the associations object, include the following fields:

You can also include the label field to assign a defined association label that describes the association. Learn more about associating records via the associations API.

For example, to associate a new ticket with an existing contact and company, your request would look like the following:

You can retrieve tickets individually or in batches.

• To retrieve an individual ticket, make a GET request to /crm/v3/objects/tickets/{ticketId}.
• To request a list of all tickets, make a GET request to /crm/v3/objects/tickets.
• To retrieve a batch of specific tickets by record ID or a custom unique identifier property, make a POST request to crm/v3/objects/tickets/batch/read.

For these endpoints, you can include the following query parameters in the request URL: 

For the batch read endpoint, you can also use the optional idProperty parameter to retrieve tickets by a custom unique identifier property. By default, the id values in the request refer to the record ID (hs_object_id), so the idProperty parameter is not required when retrieving by record ID. To use a custom unique value property to retrieve tickets, you must include the idProperty parameter.

For example, to retrieve a batch of tickets, your request could look like either of the following:

You can update tickets individually or in batches. For existing tickets, the ticket ID is a unique value that you can use to update the ticket via API.

To update an individual ticket by its ticket ID, make a PATCH request to /crm/v3/objects/tickets/{ticketId}, and include the data you want to update.

To associate a ticket with other CRM records or an activity, make a PUT request to  /crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.

Learn more about the associations API.

To remove an association between a ticket and a record or activity, make a DELETE request to the following URL: /crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.