Update release

Draft a release’s headline and summary. Changing what customers already read on a published release waits for a person to approve.

PATCH/v1/w/{workspace}/releases/{releaseId}

Send an Idempotency-Key. This may answer 202 while it waits for approval.

Path parameters

workspacestringrequired

Your workspace’s address name.

releaseIdstringrequired

The release, like cr_….

Headers

Idempotency-Keystring

8–100 characters. Repeat the same key and body to get the first outcome back instead of writing twice.

Body

headlinestring

One line for customers, like “Pay fees in instalments”.

summarystring

A short paragraph for customers.

Response

releaseobject

Details

Edit a release headline and summary. Published text changes by agents require project lead approval; does not publish.

Since 2026-12. Errors are listed in Errors.

cURL

curl -X PATCH "https://api.olamma.sh/v1/w/your-workspace/releases/{releaseId}" \
  -H "Authorization: Bearer $OLAMMA_KEY" \
  -H "Idempotency-Key: <unique key>" \
  -H "content-type: application/json" \
  -d '{
    "headline": "Faster card payments"
  }'

Response 200

{
  "release": {
    "id": "<string>",
    "changelog": {
      "id": "<string>",
      "name": "<string>",
      "product": "<string>"
    },
    "version": "<string>",
    "headline": "<string>",
    "status": "<string>",
    "deployedAt": "2026-12-01T09:30:00Z",
    "publishedAt": "2026-12-01T09:30:00Z",
    "url": "<string>"
  }
}