Skip to content
Lightfield Lightfield
API Reference
Note

Create a note

client.note.create(NoteCreateParams { fields, relationships } body, RequestOptionsoptions?): NoteCreateResponse { id, createdAt, fields, 4 more }
POST/v1/notes

Creates a new note record.

The note author is automatically set to the API key owner.

Supports idempotency via the Idempotency-Key header.

Required scope: notes:create

Rate limit category: Write

ParametersExpand Collapse
body: NoteCreateParams { fields, relationships }
fields: Fields

Field values for the new note. $title is required; $content is optional. See Fields and relationships for value type details.

"$title": string

Title of the note.

"$content"?: string | null

Content of the note as markdown formatted text.

relationships?: Relationships

Relationships to set on the new note. System relationships use a $ prefix (e.g. $account, $opportunity). Each value is a single entity ID or an array of IDs. The note author is automatically set to the API key owner.

"$account"?: string | Array<string>

ID(s) of accounts to associate with this note.

Accepts one of the following:
string
Array<string>
"$opportunity"?: string | Array<string>

ID(s) of opportunities to associate with this note.

Accepts one of the following:
string
Array<string>
ReturnsExpand Collapse
NoteCreateResponse { 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"
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.

Create a note

import Lightfield from 'lightfield';

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

const noteCreateResponse = await client.note.create({ fields: { $title: '$title' } });

console.log(noteCreateResponse.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"
}