Update a note

client.note.update(, , ?): NoteUpdateResponse { id, createdAt, fields, 4 more }

POST/v1/notes/{id}

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

Both $account and $opportunity relationships can be modified via add or remove operations.

Supports idempotency via the Idempotency-Key header.

Required scope: notes:update

Rate limit category: Write

ParametersExpand Collapse

id: string

Unique identifier of the note to update.

body: NoteUpdateParams { fields, relationships }

fields?: Fields

Field values to update — only provided fields are modified; omitted fields are left unchanged. See Fields and relationships for value type details.

"$content"?: string | null

Content of the note as markdown formatted text.

"$title"?: string | null

Title of the note.

relationships?: Relationships

Relationship operations to apply. System relationships use a $ prefix (e.g. $account, $opportunity). Each value is an operation object with add or remove.

"$account"?: Add { add } | Remove { remove }

Operation to modify associated accounts.

Accepts one of the following:

Add { add }

add: string | Array<string>

Entity ID(s) to add to the relationship.

Accepts one of the following:

string

Array<string>

Remove { remove }

remove: string | Array<string>

Entity ID(s) to remove from the relationship.

Accepts one of the following:

string

Array<string>

"$opportunity"?: Add { add } | Remove { remove }

Operation to modify associated opportunities.

Accepts one of the following:

Add { add }

add: string | Array<string>

Entity ID(s) to add to the relationship.

Accepts one of the following:

string

Array<string>

Remove { remove }

remove: string | Array<string>

Entity ID(s) to remove from the relationship.

Accepts one of the following:

string

Array<string>

ReturnsExpand Collapse

NoteUpdateResponse { id, createdAt, fields, 4 more }

id: string

Unique identifier for the entity.

createdAt: string

ISO 8601 timestamp of when the entity was created.

fields: Record<string, Fields>

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

value: string | number | boolean | 3 more | null

The field value, or null if unset.

Accepts one of the following:

string

number

boolean

Array<string>

Address { city, country, latitude, 5 more }

city?: string | null

City name.

country?: string | null

2-letter ISO 3166-1 alpha-2 country code.

latitude?: number | null

Latitude coordinate.

longitude?: number | null

Longitude coordinate.

postalCode?: string | null

Postal or ZIP code.

state?: string | null

State or province.

street?: string | null

Street address line 1.

street2?: string | null

Street address line 2.

FullName { firstName, lastName }

firstName?: string | null

The contact's first name.

lastName?: string | null

The contact's last name.

valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more

The data type of the field.

Accepts one of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

httpLink: string | null

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

relationships: Record<string, Relationships>

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

cardinality: string

Whether the relationship is has_one or has_many.

objectType: string

The type of the related object (e.g. account, contact).

values: Array<string>

IDs of the related entities.

updatedAt: string | null

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

externalId?: string | null

External identifier for the entity, or null if unset.

Update a note

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const noteUpdateResponse = await client.note.update('id');

console.log(noteUpdateResponse.id);

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}

Returns Examples

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}