ts.art.update

Update artifact attributes (partial update).

Update artifact attributes (partial update).

Requires authentication

Description

Updates one or more fields of an existing artifact. Only provided fields are changed; omitted fields remain unchanged.

To archive an artifact, set status to “archived”. To unlink from an endeavour or task, pass an empty string.

Parameters

NameTypeRequiredDefaultDescription
idstringYesArtifact ID
titlestringNew title
kindstringNew kind
urlstringNew URL
summarystringNew summary
tagsarrayNew tags (replaces existing)
statusstringNew status: active, archived
endeavour_idstringNew endeavour (empty string to unlink)
task_idstringNew task (empty string to unlink)
metadataobjectMetadata to set (replaces existing)

Response

Returns the artifact ID and list of fields that were updated.

{
  "id": "art_d4e5f6a1b2c3...",
  "updated_at": "2026-02-09T12:00:00Z",
  "updated_fields": [
    "status"
  ]
}

Errors

CodeDescription
not_authenticatedNo active login for this session
not_foundArtifact with this ID does not exist
invalid_inputNo fields to update

Examples

Archive an artifact

Mark an artifact as archived.

Request:

{
  "id": "art_d4e5f6a1b2c3...",
  "status": "archived"
}

Response:

{
  "id": "art_d4e5f6a1b2c3...",
  "updated_at": "2026-02-09T12:00:00Z",
  "updated_fields": [
    "status"
  ]
}

Update tags

Replace the tag set on an artifact.

Request:

{
  "id": "art_d4e5f6a1b2c3...",
  "tags": [
    "architecture",
    "decision-record",
    "approved"
  ]
}

Response:

{
  "id": "art_d4e5f6a1b2c3...",
  "updated_at": "2026-02-09T12:00:00Z",
  "updated_fields": [
    "tags"
  ]
}