Creating a note

Notes consist of two things:

1. A body, which is the text content of the note.
2. Metadata, which is a structured key-value blob that you can use to store arbitrary data on the object.
3. A reference to the object the note is attached to, which consists of a model_type and a model_id. Model types are as follows:

By creating a note programmatically, you can unlock a lot of interesting use cases and functionality. Here are some examples:

1. Add a note to a given subscriber whenever they upgrade or churn from a paid plan.
2. Add notes to emails when you mutate them with new data for provenance tracking.

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/notes"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
data = {
  "body": "This subscriber upgraded to a paid plan.",
  "model_type": "email",
  "model_id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3"
}

response = requests.request("POST", url, headers=headers, json=data)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "creation_date": "2000-01-01T00:00:00+00:00",
    "body": "This person rocks :)",
    "model_type": "subscriber",
    "model_id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
    "metadata": {},
    "source": "user",
    "user_id": "cd4db23f-052d-425a-8e5b-73e51c1c9b85",
    "user": null
}

Body parameters

All parameters are optional unless explicitly specified.