v1

latestOpenAPI 3.0.22026-07-2441902.6 MB

Case API

Creating a case

Creating a case.

post/cm/core/va/cases

Request body

titlestring required

Case subject on the interface.

descriptionstring required

When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case.

parent_idstring

Case id of parent case.

owner_idstring

Assignee id.

priority'LOW' | 'NORMAL' | 'HIGH' | 'URGENT'

Case priority. For details, please see Overview.

custom_fieldsobject

Fields which added by users.

requester_emailstring

Case requester email.

requester_type'Contact'

requester_namestring

Case requester name.

Response

Success, return the case details after created.

idstring required

Case id, the unique numeric identifiers given to each case. Starting from 1.

titlestring required

Case subject on the interface.

descriptionstring required

When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case.

parent_idstring

Case id of parent.

owner_idstring

Assignee id.

statusstring required

Case status. For details, please see Overview.

typestring

Case type. For details, please see Overview.

prioritystring

Case priority. For details, please see Overview.

custom_fieldsobject

Fields which added by users.

requester_idstring required

Case requester id.

requester_namestring required

Case requester name.

requester_emailstring required

Case requester email.

requester_typestring

Default value is Contact.