OlammaAPI
Menu

Record change

Record one thing that changed, usually from a pull request. It goes into the changelog’s open release. A pull request that already has a change is refused, unless you say it makes a second, separate change.

POST/v1/w/{workspace}/changes

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

Path parameters

workspacestringrequired

Your workspace’s address name.

Headers

Idempotency-Keystring

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

Body

changelogIdstring

The changelog, like cl_…; or give product instead.

productstring

The product’s key, like APP; each product has one changelog.

typeenumrequired

new, improved or fixed.

audienceenumrequired

public (customers read it) or internal.

titlestringrequired

For public changes, in customers’ words: “Receipts load faster”, not “Cache receipt PDFs”.

detailsstring

More detail, shown under the title.

notestring

Internal note, never shown to customers.

pullRequestsobject[]

The pull requests it came from: [{ "repo": "owner/name", "number": 415 }].

tasksstring[]

Task ids it closes, like APP-12. Their reporters are added so they can be told when it ships.

reportersobject[]

People to tell when it ships: team members { "kind": "member", "id": email } or customers { "kind": "customer", "name", "email" }.

releaseIdstring

Only to add it to a release that already shipped; new changes go into the open release.

bystring

Who to credit, like “Codex”.

anotherboolean

true when this pull request makes a second, separate change.

Response

changeobjectrequired
warningsstring[]

Details

Record one change in a product's changelog, usually one per pull request: what changed, for whom, and who reported it. It goes into the changelog's open release, which the next deploy ships; give releaseId only to add it to a release that has shipped but isn't published (customers already read a published release, so only its leads, in Olamma, add public changes to it). Refuses a pull request that already has a change (use update_change). A lead publishes releases in Olamma; agents can't.

Since 2026-12. Errors are listed in Errors.