Skip to main content
POST
/
v1
/
notes
Create
curl --request POST \
  --url https://{defaultHost}/v1/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": {
    "body": "This is some text!",
    "notable_id": "418771fd-185d-4639-82aa-175a24237413",
    "notable_type": "Customer"
  }
}
'
{
  "id": "3bb24fc2-b93c-40bf-8ec8-2c58289ff86d",
  "object": "note",
  "body": "This is some text!",
  "metadata": {},
  "notable_id": "418771fd-185d-4639-82aa-175a24237413",
  "notable_type": "customer",
  "created_at": 1767909725,
  "updated_at": 1767909725
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
note
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
notable_type
string

The type of object that this note belongs to – one of customer, order, or subscription.

​
notable_id
string

The ID of the object that this note belongs to.

​
body
string

The body of the note.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.