Developers
Developers
Ticket
Tickets in Planhat are Conversations, so if you plan to send tickets to Planhat via API then you can also use that endpoint. The ticket endpoint contains a bit of convenience logic for saving tickets specifically, like setting the proper type automatically.
Most of our customers sync tickets from an external system like Zendesk or Salesforce. In case your ticketing system isn't natively supported or you have your own system for it, please let us know and we'll be happy to discuss how to best work with this API.
Property | Required | Type | Description |
|---|---|---|---|
_id | objectId | Planhat identifier. | |
source | string | The name of the system this ticket originates from. Typically "Zendesk", "Desk", etc., but since you’re reading these docs you may have your tickets in some other tool. | |
companyId | Yes | objectId | Related company id (planhat identifier). |
sourceId | Yes | string | Id of the ticket in the source system. |
Yes | string | Email of the person who submitted the ticket. Items without email will be silently dropped. | |
domains | array | Array of strings (required if companyExternalId not specified). | |
companyExternalId | string | The External Company Id. | |
title | string | If the ticket has a title or main subject. | |
description | string | Description of the ticket. | |
url | string | Url to where more information can be found about this ticket. | |
tags | array | Array of tags in string format. | |
type | string | The type of the ticket. Use as you like, but typically it could be: "bug", "feature request", "training", etc. | |
severity | string | String describing the severity, no restrictions on the scale apart from that. | |
product | string | Name of the product to which the ticket relates. | |
timeSpent | integer | Time spent on this ticket, measured in number of minutes. | |
status | string | Any status options you like. Typically "new", "pending", "open", "resolved", "closed", or something similar. | |
history | array | Array of objects containing the status history of the ticket. |
Tickets in Planhat are Conversations, so if you plan to send tickets to Planhat via API then you can also use that endpoint. The ticket endpoint contains a bit of convenience logic for saving tickets specifically, like setting the proper type automatically.
Most of our customers sync tickets from an external system like Zendesk or Salesforce. In case your ticketing system isn't natively supported or you have your own system for it, please let us know and we'll be happy to discuss how to best work with this API.
Property | Required | Type | Description |
|---|---|---|---|
_id | objectId | Planhat identifier. | |
source | string | The name of the system this ticket originates from. Typically "Zendesk", "Desk", etc., but since you’re reading these docs you may have your tickets in some other tool. | |
companyId | Yes | objectId | Related company id (planhat identifier). |
sourceId | Yes | string | Id of the ticket in the source system. |
Yes | string | Email of the person who submitted the ticket. Items without email will be silently dropped. | |
domains | array | Array of strings (required if companyExternalId not specified). | |
companyExternalId | string | The External Company Id. | |
title | string | If the ticket has a title or main subject. | |
description | string | Description of the ticket. | |
url | string | Url to where more information can be found about this ticket. | |
tags | array | Array of tags in string format. | |
type | string | The type of the ticket. Use as you like, but typically it could be: "bug", "feature request", "training", etc. | |
severity | string | String describing the severity, no restrictions on the scale apart from that. | |
product | string | Name of the product to which the ticket relates. | |
timeSpent | integer | Time spent on this ticket, measured in number of minutes. | |
status | string | Any status options you like. Typically "new", "pending", "open", "resolved", "closed", or something similar. | |
history | array | Array of objects containing the status history of the ticket. |
Tickets in Planhat are Conversations, so if you plan to send tickets to Planhat via API then you can also use that endpoint. The ticket endpoint contains a bit of convenience logic for saving tickets specifically, like setting the proper type automatically.
Most of our customers sync tickets from an external system like Zendesk or Salesforce. In case your ticketing system isn't natively supported or you have your own system for it, please let us know and we'll be happy to discuss how to best work with this API.
Property | Required | Type | Description |
|---|---|---|---|
_id | objectId | Planhat identifier. | |
source | string | The name of the system this ticket originates from. Typically "Zendesk", "Desk", etc., but since you’re reading these docs you may have your tickets in some other tool. | |
companyId | Yes | objectId | Related company id (planhat identifier). |
sourceId | Yes | string | Id of the ticket in the source system. |
Yes | string | Email of the person who submitted the ticket. Items without email will be silently dropped. | |
domains | array | Array of strings (required if companyExternalId not specified). | |
companyExternalId | string | The External Company Id. | |
title | string | If the ticket has a title or main subject. | |
description | string | Description of the ticket. | |
url | string | Url to where more information can be found about this ticket. | |
tags | array | Array of tags in string format. | |
type | string | The type of the ticket. Use as you like, but typically it could be: "bug", "feature request", "training", etc. | |
severity | string | String describing the severity, no restrictions on the scale apart from that. | |
product | string | Name of the product to which the ticket relates. | |
timeSpent | integer | Time spent on this ticket, measured in number of minutes. | |
status | string | Any status options you like. Typically "new", "pending", "open", "resolved", "closed", or something similar. | |
history | array | Array of objects containing the status history of the ticket. |
Bulk Upsert tickets
To create a ticket it's required to define a sourceId, email, and domains.
To update a ticket it is required to specify in the payload one of the following keyables, listed in order of priority: _id, sourceId.
Since this is a bulk upsert operation it's possible to create and/or update multiple tickets with the same payload.
For more details please refer to the bulk upsert section.
Note: There is an upper limit of 5,000 items per request.
Example Request
curl --location -g --request PUT 'https://api.planhat.com/tickets' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{apiToken}}' \
--data-raw '[
{
"sourceId": "119",
"source": "freshdesk",
"status": "open",
"history": [{"status": "open", "time": "2019-12-15T09:09:08.000Z"}],
"title": "Test Ticket",
"description": "Let have a chat?",
"url": "http://urltoyourticket.com/119",
"type": "ticket",
"email": "ojpsoi57pzn@gmail.com",
"name": "first-ojpsoi57pzn",
"companyId": "61006bc89a3e0b702ed8ea49",
"agentEmail": null,
"domains": ["planhat.com", "google.com"]
}
]'
Example Response
'{
"created": 1,
"updated": 0
}'
Bulk Upsert tickets
To create a ticket it's required to define a sourceId, email, and domains.
To update a ticket it is required to specify in the payload one of the following keyables, listed in order of priority: _id, sourceId.
Since this is a bulk upsert operation it's possible to create and/or update multiple tickets with the same payload.
For more details please refer to the bulk upsert section.
Note: There is an upper limit of 5,000 items per request.
Example Request
curl --location -g --request PUT 'https://api.planhat.com/tickets' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{apiToken}}' \
--data-raw '[
{
"sourceId": "119",
"source": "freshdesk",
"status": "open",
"history": [{"status": "open", "time": "2019-12-15T09:09:08.000Z"}],
"title": "Test Ticket",
"description": "Let have a chat?",
"url": "http://urltoyourticket.com/119",
"type": "ticket",
"email": "ojpsoi57pzn@gmail.com",
"name": "first-ojpsoi57pzn",
"companyId": "61006bc89a3e0b702ed8ea49",
"agentEmail": null,
"domains": ["planhat.com", "google.com"]
}
]'
Example Response
'{
"created": 1,
"updated": 0
}'
Bulk Upsert tickets
To create a ticket it's required to define a sourceId, email, and domains.
To update a ticket it is required to specify in the payload one of the following keyables, listed in order of priority: _id, sourceId.
Since this is a bulk upsert operation it's possible to create and/or update multiple tickets with the same payload.
For more details please refer to the bulk upsert section.
Note: There is an upper limit of 5,000 items per request.
Example Request
curl --location -g --request PUT 'https://api.planhat.com/tickets' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{apiToken}}' \
--data-raw '[
{
"sourceId": "119",
"source": "freshdesk",
"status": "open",
"history": [{"status": "open", "time": "2019-12-15T09:09:08.000Z"}],
"title": "Test Ticket",
"description": "Let have a chat?",
"url": "http://urltoyourticket.com/119",
"type": "ticket",
"email": "ojpsoi57pzn@gmail.com",
"name": "first-ojpsoi57pzn",
"companyId": "61006bc89a3e0b702ed8ea49",
"agentEmail": null,
"domains": ["planhat.com", "google.com"]
}
]'
Example Response
'{
"created": 1,
"updated": 0
}'
Get tickets List
When fetching tickets there are some options that can be used via query params:
companyId: Filter using company id. Multiple ids can be used separating them by commas.
limit: Limit the list length. Default as 500, max. 10000.
offset: Start the list on a specific integer index.
sort: Sort based on a specific property. Prefix the property "-" to change the sort order.
select: Select specific properties. Multiple properties can be specified separating them by commas.
status: Filter by status of tickets.
email: Filter by email.
search: Filter ticket searching for matching strings in the snippets.
Example Request
curl --location -g --request GET 'https://api.planhat.com/tickets?s=open&cid=61006bc89a3e0b702ed8ea49&l=1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{apiToken}}'
Example Response
'[
{
"_id": "60d4e139e9c01e379effa355",
"externalId": "5003X00002CDLbHQAX",
"type": "ticket",
"source": "salesforce",
"subType": "ticket",
"subject": "[00001044] SFDC Case 1",
"snippet": "Test case from SFDC",
"email": "jbacon@gmail.com",
"status": "New",
"history": [
{
"status": "New",
"time": "2021-06-24T19:47:05.084Z"
}
],
"url": "https://eu29.salesforce.com/5003X00002CDLbHQAX",
"createDate": "2021-06-24T19:38:16.000Z",
"updateDate": "2021-06-24T19:38:16.000Z",
"date": "2021-06-24T19:38:16.000Z",
"days": 18802,
"timeBucket": [
"2021",
"2021-Q2",
"2021-6",
"2021-W26"
],
"companyId": "56bccdf554d64d837d01be80",
"companyName": "Exxon",
"endusers": [
{
"id": "5f7e1a07dcd4235b544f3ce4",
"name": "John Bacon"
}
],
"inDate": "2021-06-24T19:38:16.000Z",
"custom": {
"Closed Date": null,
"Created Date": "2021-06-24T19:38:16.000+0000",
"Days in Phase": 0,
"Logins": 0,
"Renewal in days": -1,
"Activity Count": 0,
"Week No": 29.285714285714285
},
"starred": false,
"pinned": false,
"activityTags": [],
"emailTemplateIds": [],
"isOpen": false,
"tags": [],
"waitsToBeFiltered": true,
"archived": false,
"users": [],
"sender": []
},
{
"_id": "5f579260f74efb6cfda04ba3",
"externalId": "5003X00001xQsPZQA0",
"type": "ticket",
"source": "salesforce",
"subType": "ticket",
"subject": "[00001036] Case - High Prio",
"snippet": "No enduser at first",
"email": "sean@edge.com",
"status": "Closed",
"history": [
{
"status": "Escalated",
"time": "2020-09-08T14:17:04.152Z"
},
{
"status": "Escalated",
"time": "2020-10-27T12:42:15.954Z"
},
{
"status": "Escalated",
"time": "2020-11-06T10:28:39.225Z"
},
{
"status": "Escalated",
"time": "2020-12-18T11:27:07.551Z"
},
{
"status": "Closed",
"time": "2020-12-18T11:29:53.022Z"
},
{
"status": "Closed",
"time": "2020-12-18T11:31:31.557Z"
},
{
"status": "Closed",
"time": "2020-12-18T11:32:41.930Z"
},
{
"status": "Closed",
"time": "2021-02-03T09:48:37.816Z"
},
{
"status": "Closed",
"time": "2021-04-09T13:03:03.578Z"
}
],
"url": "https://eu29.salesforce.com/5003X00001xQsPZQA0",
"createDate": "2020-09-08T14:14:01.000Z",
"updateDate": "2020-12-18T11:29:35.000Z",
"date": "2020-12-18T11:29:35.000Z",
"days": 18614,
"timeBucket": [
"2020",
"2020-Q4",
"2020-12",
"2020-W51"
],
"companyId": "56ccc2d39b760ff232295792",
"companyName": "Edge Communications",
"endusers": [
{
"id": "56ccc2d49b760ff23229579c",
"name": "Sean Morty"
}
],
"inDate": "2020-12-18T11:29:35.000Z",
"starred": false,
"pinned": false,
"activityTags": [],
"emailTemplateIds": [],
"isOpen": false,
"tags": [],
"waitsToBeFiltered": true,
"archived": false,
"users": [],
"sender": [],
"comments": [],
"custom": {
"t1": 0,
"Created date": "2020-09-08T14:14:01.000+0000",
"Closed Date": "2020-12-18T11:29:35.000+0000",
"Status": "Open",
"Created Date": "2020-09-08T14:14:01.000+0000",
"HScore": 0,
"Days in Phase": 0,
"Team Attendees": [
"58e231b14246fc73139f29e8"
],
"NRR30": 0,
"t123": "undefined",
"Logins": 0,
"Renewal in days": -1,
"Activity Count": 0,
"Week No": 29.285714285714285
}
}
]'Get tickets List
When fetching tickets there are some options that can be used via query params:
companyId: Filter using company id. Multiple ids can be used separating them by commas.
limit: Limit the list length. Default as 500, max. 10000.
offset: Start the list on a specific integer index.
sort: Sort based on a specific property. Prefix the property "-" to change the sort order.
select: Select specific properties. Multiple properties can be specified separating them by commas.
status: Filter by status of tickets.
email: Filter by email.
search: Filter ticket searching for matching strings in the snippets.
Example Request
curl --location -g --request GET 'https://api.planhat.com/tickets?s=open&cid=61006bc89a3e0b702ed8ea49&l=1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{apiToken}}'
Example Response
'[
{
"_id": "60d4e139e9c01e379effa355",
"externalId": "5003X00002CDLbHQAX",
"type": "ticket",
"source": "salesforce",
"subType": "ticket",
"subject": "[00001044] SFDC Case 1",
"snippet": "Test case from SFDC",
"email": "jbacon@gmail.com",
"status": "New",
"history": [
{
"status": "New",
"time": "2021-06-24T19:47:05.084Z"
}
],
"url": "https://eu29.salesforce.com/5003X00002CDLbHQAX",
"createDate": "2021-06-24T19:38:16.000Z",
"updateDate": "2021-06-24T19:38:16.000Z",
"date": "2021-06-24T19:38:16.000Z",
"days": 18802,
"timeBucket": [
"2021",
"2021-Q2",
"2021-6",
"2021-W26"
],
"companyId": "56bccdf554d64d837d01be80",
"companyName": "Exxon",
"endusers": [
{
"id": "5f7e1a07dcd4235b544f3ce4",
"name": "John Bacon"
}
],
"inDate": "2021-06-24T19:38:16.000Z",
"custom": {
"Closed Date": null,
"Created Date": "2021-06-24T19:38:16.000+0000",
"Days in Phase": 0,
"Logins": 0,
"Renewal in days": -1,
"Activity Count": 0,
"Week No": 29.285714285714285
},
"starred": false,
"pinned": false,
"activityTags": [],
"emailTemplateIds": [],
"isOpen": false,
"tags": [],
"waitsToBeFiltered": true,
"archived": false,
"users": [],
"sender": []
},
{
"_id": "5f579260f74efb6cfda04ba3",
"externalId": "5003X00001xQsPZQA0",
"type": "ticket",
"source": "salesforce",
"subType": "ticket",
"subject": "[00001036] Case - High Prio",
"snippet": "No enduser at first",
"email": "sean@edge.com",
"status": "Closed",
"history": [
{
"status": "Escalated",
"time": "2020-09-08T14:17:04.152Z"
},
{
"status": "Escalated",
"time": "2020-10-27T12:42:15.954Z"
},
{
"status": "Escalated",
"time": "2020-11-06T10:28:39.225Z"
},
{
"status": "Escalated",
"time": "2020-12-18T11:27:07.551Z"
},
{
"status": "Closed",
"time": "2020-12-18T11:29:53.022Z"
},
{
"status": "Closed",
"time": "2020-12-18T11:31:31.557Z"
},
{
"status": "Closed",
"time": "2020-12-18T11:32:41.930Z"
},
{
"status": "Closed",
"time": "2021-02-03T09:48:37.816Z"
},
{
"status": "Closed",
"time": "2021-04-09T13:03:03.578Z"
}
],
"url": "https://eu29.salesforce.com/5003X00001xQsPZQA0",
"createDate": "2020-09-08T14:14:01.000Z",
"updateDate": "2020-12-18T11:29:35.000Z",
"date": "2020-12-18T11:29:35.000Z",
"days": 18614,
"timeBucket": [
"2020",
"2020-Q4",
"2020-12",
"2020-W51"
],
"companyId": "56ccc2d39b760ff232295792",
"companyName": "Edge Communications",
"endusers": [
{
"id": "56ccc2d49b760ff23229579c",
"name": "Sean Morty"
}
],
"inDate": "2020-12-18T11:29:35.000Z",
"starred": false,
"pinned": false,
"activityTags": [],
"emailTemplateIds": [],
"isOpen": false,
"tags": [],
"waitsToBeFiltered": true,
"archived": false,
"users": [],
"sender": [],
"comments": [],
"custom": {
"t1": 0,
"Created date": "2020-09-08T14:14:01.000+0000",
"Closed Date": "2020-12-18T11:29:35.000+0000",
"Status": "Open",
"Created Date": "2020-09-08T14:14:01.000+0000",
"HScore": 0,
"Days in Phase": 0,
"Team Attendees": [
"58e231b14246fc73139f29e8"
],
"NRR30": 0,
"t123": "undefined",
"Logins": 0,
"Renewal in days": -1,
"Activity Count": 0,
"Week No": 29.285714285714285
}
}
]'Get tickets List
When fetching tickets there are some options that can be used via query params:
companyId: Filter using company id. Multiple ids can be used separating them by commas.
limit: Limit the list length. Default as 500, max. 10000.
offset: Start the list on a specific integer index.
sort: Sort based on a specific property. Prefix the property "-" to change the sort order.
select: Select specific properties. Multiple properties can be specified separating them by commas.
status: Filter by status of tickets.
email: Filter by email.
search: Filter ticket searching for matching strings in the snippets.
Example Request
curl --location -g --request GET 'https://api.planhat.com/tickets?s=open&cid=61006bc89a3e0b702ed8ea49&l=1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{apiToken}}'
Example Response
'[
{
"_id": "60d4e139e9c01e379effa355",
"externalId": "5003X00002CDLbHQAX",
"type": "ticket",
"source": "salesforce",
"subType": "ticket",
"subject": "[00001044] SFDC Case 1",
"snippet": "Test case from SFDC",
"email": "jbacon@gmail.com",
"status": "New",
"history": [
{
"status": "New",
"time": "2021-06-24T19:47:05.084Z"
}
],
"url": "https://eu29.salesforce.com/5003X00002CDLbHQAX",
"createDate": "2021-06-24T19:38:16.000Z",
"updateDate": "2021-06-24T19:38:16.000Z",
"date": "2021-06-24T19:38:16.000Z",
"days": 18802,
"timeBucket": [
"2021",
"2021-Q2",
"2021-6",
"2021-W26"
],
"companyId": "56bccdf554d64d837d01be80",
"companyName": "Exxon",
"endusers": [
{
"id": "5f7e1a07dcd4235b544f3ce4",
"name": "John Bacon"
}
],
"inDate": "2021-06-24T19:38:16.000Z",
"custom": {
"Closed Date": null,
"Created Date": "2021-06-24T19:38:16.000+0000",
"Days in Phase": 0,
"Logins": 0,
"Renewal in days": -1,
"Activity Count": 0,
"Week No": 29.285714285714285
},
"starred": false,
"pinned": false,
"activityTags": [],
"emailTemplateIds": [],
"isOpen": false,
"tags": [],
"waitsToBeFiltered": true,
"archived": false,
"users": [],
"sender": []
},
{
"_id": "5f579260f74efb6cfda04ba3",
"externalId": "5003X00001xQsPZQA0",
"type": "ticket",
"source": "salesforce",
"subType": "ticket",
"subject": "[00001036] Case - High Prio",
"snippet": "No enduser at first",
"email": "sean@edge.com",
"status": "Closed",
"history": [
{
"status": "Escalated",
"time": "2020-09-08T14:17:04.152Z"
},
{
"status": "Escalated",
"time": "2020-10-27T12:42:15.954Z"
},
{
"status": "Escalated",
"time": "2020-11-06T10:28:39.225Z"
},
{
"status": "Escalated",
"time": "2020-12-18T11:27:07.551Z"
},
{
"status": "Closed",
"time": "2020-12-18T11:29:53.022Z"
},
{
"status": "Closed",
"time": "2020-12-18T11:31:31.557Z"
},
{
"status": "Closed",
"time": "2020-12-18T11:32:41.930Z"
},
{
"status": "Closed",
"time": "2021-02-03T09:48:37.816Z"
},
{
"status": "Closed",
"time": "2021-04-09T13:03:03.578Z"
}
],
"url": "https://eu29.salesforce.com/5003X00001xQsPZQA0",
"createDate": "2020-09-08T14:14:01.000Z",
"updateDate": "2020-12-18T11:29:35.000Z",
"date": "2020-12-18T11:29:35.000Z",
"days": 18614,
"timeBucket": [
"2020",
"2020-Q4",
"2020-12",
"2020-W51"
],
"companyId": "56ccc2d39b760ff232295792",
"companyName": "Edge Communications",
"endusers": [
{
"id": "56ccc2d49b760ff23229579c",
"name": "Sean Morty"
}
],
"inDate": "2020-12-18T11:29:35.000Z",
"starred": false,
"pinned": false,
"activityTags": [],
"emailTemplateIds": [],
"isOpen": false,
"tags": [],
"waitsToBeFiltered": true,
"archived": false,
"users": [],
"sender": [],
"comments": [],
"custom": {
"t1": 0,
"Created date": "2020-09-08T14:14:01.000+0000",
"Closed Date": "2020-12-18T11:29:35.000+0000",
"Status": "Open",
"Created Date": "2020-09-08T14:14:01.000+0000",
"HScore": 0,
"Days in Phase": 0,
"Team Attendees": [
"58e231b14246fc73139f29e8"
],
"NRR30": 0,
"t123": "undefined",
"Logins": 0,
"Renewal in days": -1,
"Activity Count": 0,
"Week No": 29.285714285714285
}
}
]'Delete tickets
To delete a ticket it's required to pass the _id in the request URL as a parameter.
Example Request
curl --location -g --request DELETE 'https://api.planhat.com/tickets/:_id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{apiToken}}'
Example Response
'{
"starred": false,
"pinned": false,
"autoTags": [],
"activityTags": [],
"emailTemplateIds": [],
"isOpen": false,
"tags": [],
"waitsToBeFiltered": true,
"timeBucket": [
"2021",
"2021-Q2",
"2021-6",
"2021-W26"
],
"archived": false,
"_id": "60d4e139e9c01e379effa355",
"externalId": "5003X00002CDLbHQAX",
"type": "ticket",
"source": "salesforce",
"subType": "ticket",
"subject": "[00001044] SFDC Case 1",
"snippet": "Test case from SFDC",
"email": "jbacon@gmail.com",
"status": "New",
"history": [
{
"status": "New",
"time": "2021-06-24T19:47:05.084Z"
}
],
"url": "https://eu29.salesforce.com/5003X00002CDLbHQAX",
"createDate": "2021-06-24T19:38:16.000Z",
"updateDate": "2021-06-24T19:38:16.000Z",
"date": "2021-06-24T19:38:16.000Z",
"days": 18802,
"companyId": "56bccdf554d64d837d01be80",
"companyName": "Exxon",
"endusers": [
{
"id": "5f7e1a07dcd4235b544f3ce4",
"name": "John Bacon"
}
],
"inDate": "2021-06-24T19:38:16.000Z",
"custom": {
"Closed Date": null,
"Created Date": "2021-06-24T19:38:16.000+0000",
"Days in Phase": 0,
"Logins": 0,
"Renewal in days": -1,
"Activity Count": 0,
"Week No": 29.285714285714285
},
"users": [],
"sender": []
}'Delete tickets
To delete a ticket it's required to pass the _id in the request URL as a parameter.
Example Request
curl --location -g --request DELETE 'https://api.planhat.com/tickets/:_id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{apiToken}}'
Example Response
'{
"starred": false,
"pinned": false,
"autoTags": [],
"activityTags": [],
"emailTemplateIds": [],
"isOpen": false,
"tags": [],
"waitsToBeFiltered": true,
"timeBucket": [
"2021",
"2021-Q2",
"2021-6",
"2021-W26"
],
"archived": false,
"_id": "60d4e139e9c01e379effa355",
"externalId": "5003X00002CDLbHQAX",
"type": "ticket",
"source": "salesforce",
"subType": "ticket",
"subject": "[00001044] SFDC Case 1",
"snippet": "Test case from SFDC",
"email": "jbacon@gmail.com",
"status": "New",
"history": [
{
"status": "New",
"time": "2021-06-24T19:47:05.084Z"
}
],
"url": "https://eu29.salesforce.com/5003X00002CDLbHQAX",
"createDate": "2021-06-24T19:38:16.000Z",
"updateDate": "2021-06-24T19:38:16.000Z",
"date": "2021-06-24T19:38:16.000Z",
"days": 18802,
"companyId": "56bccdf554d64d837d01be80",
"companyName": "Exxon",
"endusers": [
{
"id": "5f7e1a07dcd4235b544f3ce4",
"name": "John Bacon"
}
],
"inDate": "2021-06-24T19:38:16.000Z",
"custom": {
"Closed Date": null,
"Created Date": "2021-06-24T19:38:16.000+0000",
"Days in Phase": 0,
"Logins": 0,
"Renewal in days": -1,
"Activity Count": 0,
"Week No": 29.285714285714285
},
"users": [],
"sender": []
}'Delete tickets
To delete a ticket it's required to pass the _id in the request URL as a parameter.
Example Request
curl --location -g --request DELETE 'https://api.planhat.com/tickets/:_id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{apiToken}}'
Example Response
'{
"starred": false,
"pinned": false,
"autoTags": [],
"activityTags": [],
"emailTemplateIds": [],
"isOpen": false,
"tags": [],
"waitsToBeFiltered": true,
"timeBucket": [
"2021",
"2021-Q2",
"2021-6",
"2021-W26"
],
"archived": false,
"_id": "60d4e139e9c01e379effa355",
"externalId": "5003X00002CDLbHQAX",
"type": "ticket",
"source": "salesforce",
"subType": "ticket",
"subject": "[00001044] SFDC Case 1",
"snippet": "Test case from SFDC",
"email": "jbacon@gmail.com",
"status": "New",
"history": [
{
"status": "New",
"time": "2021-06-24T19:47:05.084Z"
}
],
"url": "https://eu29.salesforce.com/5003X00002CDLbHQAX",
"createDate": "2021-06-24T19:38:16.000Z",
"updateDate": "2021-06-24T19:38:16.000Z",
"date": "2021-06-24T19:38:16.000Z",
"days": 18802,
"companyId": "56bccdf554d64d837d01be80",
"companyName": "Exxon",
"endusers": [
{
"id": "5f7e1a07dcd4235b544f3ce4",
"name": "John Bacon"
}
],
"inDate": "2021-06-24T19:38:16.000Z",
"custom": {
"Closed Date": null,
"Created Date": "2021-06-24T19:38:16.000+0000",
"Days in Phase": 0,
"Logins": 0,
"Renewal in days": -1,
"Activity Count": 0,
"Week No": 29.285714285714285
},
"users": [],
"sender": []
}'