v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB

Cases

Update a case

Update case properties.

Path parameters

idstring required

Update a case by its Dotfile internal id first and if not found, by its external_id.

Request body

namestring

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

status'draft' | 'open'

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.

external_idstring

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

template_keystring nullable

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

template_idstring uuid nullable

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_idstring uuid nullable

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

custom_propertiesobject

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.

metadataobject nullable

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

Example request

{
  "custom_properties": {
    "custom_text": "Custom properties text",
    "custom_boolean": true,
    "custom_date": "2012-12-12",
    "custom_countries": [
      "FR"
    ],
    "custom_choices": [
      "option1",
      "option2"
    ],
    "custom_numeric": 12.3,
    "custom_property": null
  },
  "metadata": {
    "custom_key": "true",
    "my_data": "this is important",
    "count": "42"
  }
}

Response

ℹ️ Click to see full payload

idstring uuid required

namestring required

status'draft' | 'open' | 'approved' | 'rejected' | 'closed' required

external_idstring nullable required

assignee_idstring nullable required

space_slugstring nullable required

template_idstring uuid nullable required

Prefer using template.key instead.

contact_has_actionsboolean required

reviewer_has_actionsboolean required

flagsstring[] required

all_checks_approved for_review for_first_collect for_recollection first_collect_completed

tagsstring[] required

custom_propertiesobject required

Custom properties object in a format of key (string) / value (string | boolean | string[] | number | null) to read the case.

Archived custom properties are omitted.

metadataobject nullable required

Object in a format of key (string) / value (string)

last_activity_atstring date-time required

Latest activity date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

last_contact_action_atstring date-time nullable required

Latest contact action date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

created_atstring date-time required

Creation date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

updated_atstring date-time required

Latest update date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

Example response

{
  "custom_properties": {
    "custom_text": "Custom properties text",
    "custom_boolean": true,
    "custom_date": "2012-12-12",
    "custom_countries": [
      "FR"
    ],
    "custom_choices": [
      "option1",
      "option2"
    ],
    "custom_numeric": 12.3,
    "custom_property": null
  }
}

v1