Create

Description

Create new metadata key-value pairs for a specified case. If other metadata key-value pairs already exist on the case, this does not overwrite the existing values.

Request

HTTP Method: POST

Parameter Description
metadata Case related metadata represented as key-value pairs.
Path Parameter Description
case_id The ID of the case.

Sample request

curl -X POST \
  https://<<META.tenant.domain>>/api/v2/cases/<<case_id>>/metadata \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
        "metadata": {
          "new_key": "value"
        }
      }'

Response

A successful request will return a JSON object describing the updated metadata.

Field description

Parameter Description
case_id The ID of the case.
metadata Case related metadata represented as key-value pairs.

Sample response

{
  "case_id": 42,
  "metadata": {
    "new_key": "new value"
  }
}
Was this helpful?