Create

Description

Add a field to a case.

Request

HTTP Method: POST

Parameter Description
input_id The ID of the case input to the used with the field.
value The value of the field.
Path Parameter Description
case_id The ID of the case.

Sample request

curl -X POST \
  https://<<META.tenant.domain>>/api/v2/cases/<<case_id>>/fields \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
        "input_id": 1,
        "value": "This is a field on a case"
      }'

Response

A successful request will return a JSON object describing the updated case

Field description

Parameter Description
case_id The ID of the case.
field Details of the field.
Field parameter Description
id The field ID.
value The value of the field.
case_input An object containing the ID, name, key, validation_type, and validation_options of the case input.

Sample response

{
  "case_id": 42,
  "field": {
    "id": 1,
    "value": "high",
    "case_input": {
      "id": 1,
      "key": "priority",
      "name": "Priority",
      "validation_type": "options",
      "validation_options": {
        "options": ["low", "medium", "high", "critical"]
      }
    }
  }
}
Was this helpful?