Create Note

POST 
/notes/

Create Note

Request

Version stringrequired

API Version

Available options2021-04-15

locationId stringrequired

Location Id

application/json

application/json

Body

Bodyrequired

bodystringrequired

The body content of the note

relationsobject[]required

Records this note is attached to — e.g. a custom object record, a contact, or a business. At least one relation is required.

Possible values: >= 1

userIdstringrequired

The ID of the user creating the note

Example (auto)

{
  "body": "lorem ipsum",
  "relations": [
    {
      "objectKey": "custom_objects.pet",
      "recordId": "632c34b4c9b7da3358ac9891"
    }
  ],
  "userId": "TUcmRxWrjqzJS8EjkxNK"
}

application/json

Successful response

application/json

Schema

Schema

noteobject

The note object

Example (auto)

{
  "note": {
    "id": "HGPcayliwcdoUFzvbTok",
    "body": "lorem ipsum",
    "userId": "TUcmRxWrjqzJS8EjkxNK",
    "dateAdded": "2021-07-08T12:02:11.285Z",
    "title": "Follow-up summary",
    "color": "#FFAA00",
    "pinned": false
  }
}