v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

Update a note

Updates an existing note by ID. Only included fields and relationships are modified.

$account, $opportunity, and $contact relationships can be modified via add and/or remove operations (combined in one call or separately).

Supports idempotency via the Idempotency-Key header.

Required scope: notes:update

Rate limit category: Write

post/v1/notes/{id}

idstring required

Unique identifier of the note to update.

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

idstring required

Unique identifier for the entity.

createdAtstring required

ISO 8601 timestamp of when the entity was created.

updatedAtstring nullable required

ISO 8601 timestamp of when the entity was last updated, or null.

httpLinkstring nullable required

URL to view the entity in the Lightfield web app, or null.

externalIdstring nullable

External identifier for the entity, or null if unset.

fieldsobject required

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

relationshipsobject required

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).