Sign in

v4

latestOpenAPI 3.1.0MIT2026-08-02128224900.7 KB
Notes

Create Note Endpoint

Create a new note

post/notes

Request body

bodystring required

The text content of the note.

model_type'automation' | 'comment' | 'conversation' | 'email' | 'external_feed' | 'invitation' | 'socialmention' | 'stripe_customer' | 'subscriber' | 'survey' | 'tag' | 'webmention' required

The type of object this note is attached to (e.g., 'email', 'subscriber').

model_idstring required

The UUID or TypeID of the object this note is attached to.

metadataobject

A structured key-value blob that you can use to store arbitrary data on the object. Metadata can be nested — you can store objects and arrays within your metadata. (You can read more about metadata.)

Example request

{
  "body": "This subscriber upgraded to a paid plan.",
  "model_type": "email",
  "model_id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3"
}

Response

Created

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

bodystring required

The text content of the note.

model_type'automation' | 'comment' | 'conversation' | 'email' | 'external_feed' | 'invitation' | 'socialmention' | 'stripe_customer' | 'subscriber' | 'survey' | 'tag' | 'webmention' required

The type of object this note is attached to (e.g., 'email', 'subscriber').

model_idstring required

The UUID or TypeID of the object this note is attached to.

metadataobject required
source'admin' | 'user' required

The source of the note. If the note was created by a Buttondown admin, this will be 'admin'; otherwise, it will be 'user'.

user_idstring nullable

Example response

{
  "body": "This subscriber upgraded to a paid plan.",
  "model_type": "email",
  "model_id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
  "source": "admin"
}