Skip to content
Lightfield Lightfield
API Reference
Note

Create a note

note.create(NoteCreateParams**kwargs) -> NoteCreateResponse
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
fields: Fields

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

title: str

Title of the note.

content: Optional[str]

Content of the note as markdown formatted text.

relationships: Optional[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: Optional[Union[str, Sequence[str]]]

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

One of the following:
str
Sequence[str]
opportunity: Optional[Union[str, Sequence[str]]]

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

One of the following:
str
Sequence[str]
ReturnsExpand Collapse
class NoteCreateResponse: …
id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, 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: Optional[FieldsValue]

The field value, or null if unset.

One of the following:
str
float
bool
List[str]
class FieldsValueAddress: …
city: Optional[str]

City name.

country: Optional[str]

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

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class FieldsValueFullName: …
first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]

The data type of the field.

One of the following:
"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"
relationships: Dict[str, Relationships]

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

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

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

values: List[str]

IDs of the related entities.

updated_at: Optional[str]

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

external_id: Optional[str]

External identifier for the entity, or null if unset.

Create a note

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
note_create_response = client.note.create(
    fields={
        "title": "$title"
    },
)
print(note_create_response.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"
}