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"
}| Field | Type | Description |
|---|---|---|
object | string | Always "publication". |
id | string | Unique identifier. |
title | string | The publication's name. |
slug | string | URL slug. Immutable. |
description | string | null | A short description of the publication. |
logo_url | string | null | URL of the publication's logo. |
sender_name | string | null | The "from" name shown on outgoing emails. |
reply_to | string | null | The reply-to address for outgoing emails. |
url | string | The public URL of the publication. |
created_at | string | ISO 8601 creation timestamp. |
updated_at | string | ISO 8601 timestamp of the last update. |
Retrieve the publication
GET /publicationcurl 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 /publicationSend only the fields you want to change. The slug and url are immutable.
| Body field | Type | Description |
|---|---|---|
title | string | The publication's name. |
description | string | A short description. |
sender_name | string | The "from" name on outgoing emails. |
reply_to | string | The 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 /meGET /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"