A valid request URL is required to generate request examples{
"post": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"body_markdown": "<string>",
"published_at": "2023-11-07T05:31:56Z"
},
"max_age_seconds": 123,
"generated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}One release note, by its address
The permalink. Same document as GET /v1/changelog/{publishable_key} and the same rules, addressed one post at a time — this is what a /changelog/{slug} page on your own site is made of, and what a link in a support reply or an email points at.
The slug is stable across a retitle. It is generated from the title when the post is written and moves only when somebody changes it deliberately, because the whole promise of a permalink is that links already sent keep working. Fixing a typo in a headline does not move the page.
A draft and a targeted post are both 404 here, with the same sentence as a slug that does not exist. That is deliberate: distinguishing them would answer “there is an unpublished post at this address” to anybody who can guess a headline, and on a public surface the guess is free. A post aimed at a segment keeps its slug and starts answering here if it is later widened to everybody.
The prefix to build these URLs with is changelog_url on GET /v1/config/{publishable_key} — resolved by us, because only this side knows whether a custom domain has been verified.
Cache-Control: public, max-age=60, stale-while-revalidate=600, stale-if-error=600, on the 404 as well as on the post: a permalink that is still a draft today answers tomorrow, and the refusal is as cacheable as the list it is missing from.
Rate limited to 240 requests per minute per IP, shared with the document above.
A valid request URL is required to generate request examples{
"post": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"body_markdown": "<string>",
"published_at": "2023-11-07T05:31:56Z"
},
"max_age_seconds": 123,
"generated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Parâmetros de caminho
uk_pk_live_… or uk_pk_test_…. Posts are per environment, like the key.
Lowercase letters, digits and single hyphens. Unique within the environment.