Update case

Change what a case is about, or its metadata. The case keeps its type and status, and nothing is sent to the counterparty: the change is only recorded on your side, and announced with a case.updated event.
related_objects is the full list of objects the case is about, and replaces the current one: an object left out is unlinked, and an object not yet on the case is linked as manual. An object the case is already linked to keeps its match_source and linked_at, and takes the link_role sent. metadata is merged into the case's metadata instead. A field left out of the body is left as it is, and a body with neither changes nothing.

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

The ID of the case.

Body Params

The body of POST /cases/{id}. Both fields are optional: a field left out is left as it is.

metadata
object

Additional client data in JSON format, merged into the case's metadata: a key sent overwrites the stored value, a key sent as null is removed, and a key left out is kept. See Metadata.

Responses

404

The specified resource was not found.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json