Palmframe API

Publication

Read and update your publication's settings.

Your publication holds the settings that define your newsletter: its name, description, sending identity, and public URL. Each API key belongs to exactly one publication.

The publication object

{
  "object": "publication",
  "id": "pub_9f8e7d6c",
  "title": "The Weekly Frame",
  "slug": "weekly-frame",
  "description": "A newsletter about building in public.",
  "logo_url": "https://palmframe.com/logos/weekly-frame.png",
  "sender_name": "Alexis",
  "reply_to": "hello@weekly-frame.com",
  "url": "https://weekly-frame.palmframe.com",
  "created_at": "2026-01-04T12:00:00.000Z",
  "updated_at": "2026-07-10T08:15:00.000Z"
}
FieldTypeDescription
objectstringAlways "publication".
idstringUnique identifier.
titlestringThe publication's name.
slugstringURL slug. Immutable.
descriptionstring | nullA short description of the publication.
logo_urlstring | nullURL of the publication's logo.
sender_namestring | nullThe "from" name shown on outgoing emails.
reply_tostring | nullThe reply-to address for outgoing emails.
urlstringThe public URL of the publication.
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 timestamp of the last update.

Retrieve the publication

GET /publication
curl https://palmframe.com/api/v1/publication \
  -H "Authorization: Bearer pf_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"

Returns the publication object for the key's publication.

Update the publication

PATCH /publication

Send only the fields you want to change. The slug and url are immutable.

Body fieldTypeDescription
titlestringThe publication's name.
descriptionstringA short description.
sender_namestringThe "from" name on outgoing emails.
reply_tostringThe reply-to address on outgoing emails.
curl -X PATCH https://palmframe.com/api/v1/publication \
  -H "Authorization: Bearer pf_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "The Weekly Frame",
    "reply_to": "hello@weekly-frame.com"
  }'

Returns the updated publication object.

Get the current context

GET /me

GET /me returns the publication your API key is scoped to — the same shape as GET /publication. It is a convenient way to confirm which publication a key belongs to and to verify that a key is valid.

curl https://palmframe.com/api/v1/me \
  -H "Authorization: Bearer pf_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"

On this page