Skip to main content

Create case

Request

Creates a new case using the specified ticket code and request details. To ensure a valid request, first use GET /support/v2/tickets/codes to identify the appropriate ticket code, then use GET /support/v2/tickets/codes/{code}/schema to retrieve the fields, required values, data types, and validation rules applicable to that ticket code.

Build the request payload based on the returned request payload schema and submit it using this operation. The request schema is ticket code specific and should be treated as the source of truth for the payload structure.

Security
BearerAuth
Bodyapplication/json
codestringrequired

Ticket code. See GET /support/v2/tickets/codes for the list of valid ticket codes, and GET /support/v2/tickets/codes/{code}/schema for the required fields for a given ticket code.

Example:"0200-0000"
descriptionstring, [ 1 .. 4000 ] charactersrequired

Description of the issue.

Example:"The device is overheating and causing performance issues."
primaryIdstring, [ 1 .. 100 ] characters

Primary reference identifier.

Example:"c4d53b61-d408-41aa-a93f-24cb0bb311d9"
secondaryIdstring, [ 1 .. 100 ] characters

Secondary reference identifier.

Example:"CH1"
occurredDateTimestring, (date-time)

Date and time the issue occurred.

Example:"2020-05-22T19:23:51Z"
customerReferenceIdstring, [ 1 .. 200 ] characters

Customer or external reference number.

Example:"CustomerReference001"
attachmentsArray of objects, [ 0 .. 5 ] items(Attachment)

Supporting files to attach in the case, such as a picture of a broken device.

contactsArray of any

List of persons who will be contacted for this case.

detailsobject

Additional details or requirements for case resolution. The shape depends on the ticket code — see GET /support/v2/tickets/codes/{code}/schema for the fields applicable to a given code.

Payload
{ "code": "0007-0001", "description": "Enter description of the issue here." }

Responses

OK

Bodyapplication/json
idstring, [ 8 .. 100 ] characters(CaseOrOrderNumber)required

Unique identifier used to retrieve a case, provided as either the case number or the order number.

Example:"11150929"
typestringrequired

Support Ticket type.

Enum:"CASE""TROUBLE"
Example:"CASE"
Response
{ "id": "11150929", "type": "CASE" }
Was this page helpful?