Skip to main content

Modify Case

Request

Adds a note and optional attachments to an existing case. To include attachments, first upload each file with the Attachments File endpoint, then reference the returned values in the attachments array: attachmentId maps to id and attachmentName maps to name. Do not set the purpose query parameter on the upload request; it is not used for support cases. Use this operation to provide additional information, updates, or supporting details related to the case.

Security
BearerAuth
Path
idstring, [ 8 .. 100 ] characters(CaseOrOrderNumber)required

Case or Order Number.

Example:11150929
Examples:
Case number
11150929
Order number
1-204976070710
Bodyapplication/json
textstring, [ 1 .. 4000 ] charactersrequired

Enter any modification details/additional notes to the technician.

Example:"This is a notes!"
attachmentsArray of objects, [ 0 .. 5 ] items(Attachments)

File(s) attached to the case. e.g. picture of broken device, scanning of a bill or charge, etc...

Payload
{ "attachments": [ { … } ], "text": "This is a test notes!" }

Responses

OK

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

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

Example:"11150929"
successboolean

Indicates whether the modification or reply was successful.

Example:true
Response
{ "ticketId": "11150929", "success": true }
Was this page helpful?