Update

Description

Update an existing element in a block. Currently, note elements and file elements can be updated.

Request

HTTP Method: PUT

Note Element Parameters

Parameter Description
content Optional The content of the note.
color Optional The color of the note - options: white, gold, magenta, green, blue.

File Element Parameters

Parameter Description
annotation Optional The annotation text for the file.
Path Parameter Description
case_id The ID of the case.
block_id The ID of the block.
element_id The ID of the element.

Sample request for updating a note element

curl -X PUT \
  https://<<META.tenant.domain>>/api/v2/cases/<<case_id>>/blocks/<<block_id>>/elements/<<element_id>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
        "content": "This is an updated note element",
        "color": "blue"
      }'

Sample request for updating a file annotation

curl -X PUT \
  https://<<META.tenant.domain>>/api/v2/cases/<<case_id>>/blocks/<<block_id>>/elements/<<element_id>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
        "annotation": "This is an annotation for the attached file"
      }'

Response

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

Field description

Common Element Parameters

Parameter Description
element_id The unique ID of this element within the current block.
id The original/source ID of the element.
element_type The type of the element - options: note, file.
author Details of the author of the element.
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).

Note Element Parameters

Parameter Description
content The content of the note.
note_type The type of note - currently only "text" is supported.
color The color of the note - options: white, gold, magenta, green, blue.

File Element Parameters

Parameter Description
file Object containing file information.
annotation The annotation text associated with the file, if one is present.
File parameter Description
filename The name of the file.
url The URL to download the file.

Sample response for a note element

{
  "element_id": 456,
  "id": 123,
  "element_type": "note",
  "content": "This is an updated note element",
  "note_type": "text",
  "color": "blue",
  "author": {
    "user_id": "1",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@tines.io",
    "avatar_url": "example.com/avatar",
    "is_service_account": false
  },
  "created_at": "2025-01-07T11:42:58Z",
  "updated_at": "2025-01-08T10:15:30Z"
}

Sample response for a file element with annotation

{
  "element_id": 789,
  "id": 456,
  "element_type": "file",
  "file": {
    "filename": "report.pdf",
    "url": "https://example.com/api/v2/cases/123/files/456/download"
  },
  "annotation": "This is an annotation for the attached file",
  "author": {
    "user_id": "1",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@tines.io",
    "avatar_url": "example.com/avatar",
    "is_service_account": false
  },
  "created_at": "2025-01-07T11:42:58Z",
  "updated_at": "2025-01-08T10:15:30Z"
}
Was this helpful?