Update

Description

Use a HTTP PUT request to update a case.

Request

HTTP Method: PUT

Parameter Description
name Optional The case name.
description Optional The case description.
priority Optional The case priority - high, medium or low.
status Optional The case status - open or closed. A case re-opened email will be sent to case assignees upon reopening a case.
add_assignee_emails Optional An array of user email addresses to assign to the case.
remove_assignee_emails Optional An array of user email addresses to remove from the case.
add_tag_names Optional An array of tag names to add to the case.
remove_tag_names Optional An array of tag names to remove from the case.
add_record_ids Optional An array of record IDs to add to the case.
remove_record_ids Optional An array of record IDs to remove from the case.
author_email Optional The email of the user updating the case.
opened_at Optional ISO 8601 Timestamp representing the date and time the case was opened at.
resolved_at Optional ISO 8601 Timestamp representing the date and time the case was resolved at.
metadata Optional Case related metadata represented as key-value pairs.
team_case_buttons Optional An array of team case buttons for downstream actions associated with the case.
Path Parameter Description
case_id ID of the case.

Sample request

curl -X PUT \
  https://<<META.tenant.domain>>/api/v1/cases/<<case_id>> \
  -H 'content-type: application/json' \
  -H 'x-user-token: <api-token>' \
  -d '{
        "name": "Updated case name"
      }'

Response

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

Field description

Parameter Description
case_id The case ID.
team The team the case is within - ID & name.
name The case name.
description The case description.
status The case status - open or closed.
priority The case priority - high, medium or low.
assignees An array of users assigned to the case.
tags An array of tags associated with the case.
records An array of records associated with the case.
team_case_actions An array of team case actions taken within the case.
metadata Case related metadata represented as key-value pairs.
team_case_buttons An array of team case buttons for downstream actions associated with the case.
linked_cases An array of cases linked to this case (IDs only).

Sample response

{
  "case_id": 42,
  "name": "Updated case name",
  "description": "This is a high priority case created via the API",
  "status": "OPEN",
  "priority": "HIGH",
  "assignees": [
    {
      "id":1,
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@tines.io"
    }
  ],
  "tags": [
    {
      "id":4,
      "name": "login"
    }
  ],
  "team_case_actions": [
    {
      "id":7508,
      "action": "CREATED",
      "value": "42",
      "user": {}
    }
  ],
  "team": {
    "id":2,
    "name": "Team 1"
  },
  "records": [
    {
      "id":187,
      "results": [
        {
          "id":1871,
          "name": "Story name",
          "value": "Cases API"
        },
      ]
    }
  ],
  "metadata": {
    "key": "value"
  },
  "team_case_buttons": [
    {
      "id": 8,
      "button_type": "webhook",
      "url": "http://tenant.tines.com/webhook/e840b4e8cf60437196d9a4bcb85d2de0/61441bc05fddfa4c09924b23fcf72b91",
      "label": "Isolate host"
    },
        {
      "id": 9,
      "button_type": "page",
      "url": "https://tenant.tines.com/pages/55e94b9b4e26175051c0287f4259363f/",
      "label": "Isolate host and submit reason"
    }
  ]
},
Was this helpful?