post https://api.supportbench.com/case
Creating and updating a case from the API can be done by posting your case object to Supportbench.
The only difference between case creations and updates is including a case id within the case object.
When creating or updating a case, the below fields are available to you.
Name | Required | Limit | Default | Availability | Summary |
---|---|---|---|---|---|
id_prefix | no | 5 characters | "C" | New | The prefix of the case. You can assign new case prefix's within the API administration section. |
id_source | no | 25 characters | - | New | The source id of the case. You can assign custom ID's from existing systems or importing them into Supportbench. |
id | no - when creating yes - when updating | 30 characters | - | Update | The full case id including the prefix. |
division_id | yes | Integer | - | New / Update | The case category id. |
status_id | no | Integer | 1 | New / Update | The case status id. |
min_to_close | no | Integer | - | New / Update | If the case status is set to closed (0), then this sets when to close the case from now. i.e. 1440 min or 1 day from now. This allows cases not to have a re-opened statistic if closed accidentally. |
owner_id | no | Integer | - | New / Update | The agent id of the case owner. |
priority_id | yes | Integer | - | New / Update | The priority id of the case. |
issue_id | no | Integer | - | New / Update | The issue id of the case. |
outcome_id | no | Integer | - | New / Update | The case outcome id. Used when closing the case. |
asset_id | no | 30 characters | - | New / Update | The asset id assigned to the case. |
company_id | no | 30 characters | - | New / Update | The company id of the company assigned to the case. |
contact_id | no | 30 characters | - | New / Update | The contact id of the company assigned to the case. |
subject | yes | 250 characters | - | New / Update | The subject of the case. |
summary | no | 2500 characters | - | New / Update | The summary of the case. |
tags | no | 100 characters per tag | - | New / Update | A tag array assigned to the case. If updating, the tags defined here will overwrite any existing tags. |
fields | no | See field object | - | New / Update | A field array of custom fields to insert or update. Please see the field object below. |
Field Object
Name | Required | Limit | Default | Summary |
---|---|---|---|---|
id | yes | Integer | - | The field id of the field you wish to update. The field id must map to a valid field in the case. |
value | yes | Dropdown list - Integer Checkbox - Boolean Text box - Unlimited | - | The value of the custom field. The value is dependent on the field type. |