Create / Update a Case

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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.

NameRequiredLimitDefaultAvailabilitySummary
id_prefixno5 characters"C"NewThe prefix of the case. You can assign new case prefix's within the API administration section.
id_sourceno25 characters
NewThe source id of the case. You can assign custom ID's from existing systems or importing them into Supportbench.
idno - when creating
yes - when updating
30 characters
UpdateThe full case id including the prefix.
division_idyesInteger
New / UpdateThe case category id.
status_idnoInteger1New / UpdateThe case status id.
min_to_closenoInteger
New / UpdateIf 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_idnoInteger
New / UpdateThe agent id of the case owner.
priority_idyesInteger
New / UpdateThe priority id of the case.
issue_idnoInteger
New / UpdateThe issue id of the case.
outcome_idnoInteger
New / UpdateThe case outcome id. Used when closing the case.
asset_idno30 characters
New / UpdateThe asset id assigned to the case.
company_idno30 characters
New / UpdateThe company id of the company assigned to the case.
contact_idno30 characters
New / UpdateThe contact id of the company assigned to the case.
subjectyes250 characters
New / UpdateThe subject of the case.
summaryno2500 characters
New / UpdateThe summary of the case.
tagsno100 characters per tag
New / UpdateA tag array assigned to the case. If updating, the tags defined here will overwrite any existing tags.
fieldsnoSee field object
New / UpdateA field array of custom fields to insert or update. Please see the field object below.

Field Object

NameRequiredLimitDefaultSummary
idyesInteger
The field id of the field you wish to update. The field id must map to a valid field in the case.
valueyesDropdown list - Integer
Checkbox - Boolean
Text box - Unlimited
The value of the custom field. The value is dependent on the field type.
Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json