OlammaAPI
Menu

Update change

Change a change. Only what you send changes; pull requests, tasks and reporters replace their lists. Once a release is published, only its leads can change what customers read.

PATCH/v1/w/{workspace}/changes/{changeId}

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

Path parameters

workspacestringrequired

Your workspace’s address name.

changeIdstringrequired

The change, like cc_….

Headers

Idempotency-Keystring

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

Body

typeenum

new, improved or fixed.

audienceenum

public (customers read it) or internal.

titlestring

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[]
releaseIdstring | null

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

Response

changeobjectrequired

Details

Change a recorded change: its words, type, who sees it, release, pull requests, tasks or reporters. Only the fields you send change; pullRequests, tasks and reporters replace the lists. In a published release, what customers read (a public change's words and type, who sees a change, moving one in or out) is for its leads in Olamma; you can still change notes, pull requests, tasks and reporters.

Since 2026-12. Errors are listed in Errors.