Update a case

patch

https://api.dotfile.com/v1/cases/{id}

Update case properties.

See also

Learn more about Cases
Learn more about Templates

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

id

uuid

required

Id of the case

Body Params

name

string

length between 1 and 180

Update the name of the case (at most 180 characters).

status

string

enum

Update the status of the case to draft or open. To set the status to approved, rejected or closed, use the Create a case review endpoint.

Allowed:

external_id

string

Update the external id of the case. Must be unique if set. Set to null to clear it.

template_key

string | null

Update the template of the case using template key. Set to null to detach template.

template_id

uuid | null

deprecated

Prefer using template_key instead.
Update the template of the case. Set to null to detach template. Cannot be set at the same time as template_key.

assignee_id

uuid | null

Update the user assignee of the case. Set to null to un-assign.

custom_properties

object

Optional partial custom properties object in a format of key (string) / value (string | boolean | string[] | number | null) to update the case.

Archived custom properties are not accepted.

metadata

object | null

Update all the metadata in a format of key (string) / value (string) of the case. Set to null to remove all metadata.

Responses

400

The request is either malformed or contain invalid parameters.

Make sure the identifier specified in the URL is a valid UUID
Make sure the body payload matches the expected schema

404

No case can be found.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json