Update

Description

Update an existing case note.

Request

HTTP Method: PUT

Parameter Description
title Optional The title of the case note.
content Optional The content of the case note.
color Optional The color of the note - options: white, gold, magenta, green, blue.
position Optional The zero-indexed position of the note in the case.
Path Parameter Description
case_id The ID of the case.
note_id The ID of the note.

Sample request

curl -X PUT \
  https://<<META.tenant.domain>>/api/v2/cases/<<case_id>>/notes/<<note_id>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
        "content": "This is an updated note.",
        "position": 0
      }'

Response

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

Field description

Parameter Description
case_id The ID of the case.
id The ID of the note record attached to the case.
title The title of the note.
content The content of the note.
color The color of the note - options: white, gold, magenta, green, blue.
author Details of the author of the note.
created_at ISO 8601 Timestamp representing creation date and time.
updated_at ISO 8601 Timestamp representing last updated date and time.
Author parameter Description
user_id The user ID.
first_name The user's first name.
last_name The user's last name.
email The user's email address.
avatar_url The user's avatar url.
is_service_account Whether this user is a service account (true/false).

Sample response

{
  "case_id": 42,
  "id": 7508,
  "title": "Note title",
  "content": "This is an updated note.",
  "color": "white",
  "created_at": "2025-01-07T11:42:58Z",
  "created_at": "2025-01-07T11:42:58Z",
  "user": {
    "user_id": 1,
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@tines.io",
    "avatar_url": "example.com/avatar",
    "is_service_account": false
  }
}
Was this helpful?