Skip to main content
PATCH
Update note

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Note sid (cr_nt_…).

Required string length: 18
Pattern: ^cr_nt_

Body

application/json

Request body of update_note.

body
string

Replacement text (full replace, plain text). 1..65535 chars on a person or company note; a sticker may be emptied ("").

Maximum string length: 65535
step_id
integer | null

A sticker only: move it beside another step of its workflow (null = the workflow as a whole).

Required range: x >= 1
position
object | null

A sticker only: where a person dragged it; null hands its place back to the canvas. A model leaves it out.

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.