Skip to main content
POST
Update a note

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required

Headers

Carrier
string
required

Carrier ID the request is scoped to.

Body

application/json
content
string

New markdown body. Replaces the prior content. May contain inline reference tokens like <<ref:equipment:54321:BNSF 54321>>. Whenever you change <<ref:...>> tokens in content, also send the new references array and set update_references=true so the sidecar rows stay in sync with the inline tokens.

note_id
string

ID of the note to edit (returned by CreateNote).

references
object[]

Replacement set of references. Only honored when update_references=true. Maximum 100 entries.

update_references
boolean

If true, the references array fully replaces the prior set. If false (the default), the existing references are left untouched — use this when only the prose changes and the <<ref:...>> tokens are the same as before.

uploads
object[]

Reserved for future inline upload support; currently a no-op.

Response

A successful response.

note
object

A single note in a thread. Threaded notes are anchored to an (entity_type, entity_id) pair and ordered by created_at.