ROrocketlane
Companies

Create a note for a company

Changed on

Creates a note on a NOTE-type custom field for a company.

post/1.0/companies/{companyId}/add-notes

Request

Path parameters

companyIdinteger required

The company's unique, system-generated identifier, which can be used to identify the company globally.

Request body

fieldIdinteger required

ID of the note-type field this note belongs to.

noteTitlestring

Optional title for the note.

noteTextstring required

Plain text content of the note.

tagIdsinteger[]

Optional tag IDs from the field's available tag options.

Example request

{
  "fieldId": 44,
  "noteTitle": "Q1 Planning Discussion",
  "noteText": "This is a note",
  "tagIds": [
    1,
    2
  ]
}

Response

The resource was successfully created in the database.

noteIdinteger

Unique identifier of the note.

fieldIdinteger

ID of the note-type custom field this note belongs to.

fieldLabelstring

Display name of the note-type field.

noteTitlestring

Optional title of the note.

noteTextstring

Plain text content of the note.

createdAtinteger

Unix timestamp in milliseconds when the note was created.

updatedAtinteger

Unix timestamp in milliseconds when the note was last updated.

Example response

{
  "noteId": 1,
  "fieldId": 44,
  "fieldLabel": "Account Notes",
  "noteTitle": "Q1 Planning Discussion",
  "noteText": "Initial contact: discussed Q1 roadmap and pricing",
  "tags": [
    {
      "tagId": 1,
      "label": "sales",
      "color": "blue"
    }
  ],
  "createdAt": 1750343334605,
  "updatedAt": 1750343334570
}

Changes