Accept a suggestion
/v1/suggestions/{suggestion}/accept in the Imports API.
curl -X POST https://api.example.test/v1/suggestions/$SUGGESTION_ID/accept \ -H "Authorization: Bearer $TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "payload": { "title": "Spend points at checkout", "as_a": "returning shopper", "i_want": "to pay part of my order with points", "so_that": "my loyalty is worth something at the till", "description": "<p>Points are applied after every discount and before payment.</p>", "criteria": [ "Given a shopper with 500 points, when they apply 200 points, then the total falls by their value" ] } }'Writes the record the suggestion proposes through the record's own create action, as proposed when the body is empty or with the fields in payload when it is sent; unknown fields are dropped and a list field is an array of strings. The record's first version is written with the reason import, by Heimdall and accepted by the token's holder, and the record's own created event goes out beside import.suggestion_accepted. A story accepted after its epic hangs under the epic the parent suggestion wrote. An improvement is kept as a note without a record. The suggestion is marked accepted or edited, and a batch with no pending suggestion left is marked accepted.
Requires ability
The token must hold this ability, or the call is refused with 403.
Fires one event
Delivered to every endpoint subscribed to it once the change is made.
MCP tool
Runs the same action from an agent, behind the same ability.
Idempotent
Send the header on every call; the same key replays the original response for 24 hours.
Authorization
bearerToken A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.
In: header
Path Parameters
The suggestion, bound by the middleware.
uuidHeader Parameters
A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.
uuidRequest body
JSONWhat the request carriesOptionalapplication/json
Accept a suggestion: send nothing to write the record as Heimdall proposed it, or payload with the fields changed to write it with those edits. Unknown fields are dropped; the fields of each kind are the ones the suggestion carries.
Responses
200OKapplication/json
The suggestion, decided, with the record it wrote.
400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json
Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description.
On this endpoint: FORBIDDEN: when the token is a client guest's, or the holder's role on the project does not carry import:update and the record's own create permission.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
On this endpoint: RESOURCE_NOT_FOUND: when the suggestion is hidden from the token or missing.
409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json
The key was already used in the last 24 hours with a different request body.
422Validation failedVALIDATION_FAILEDapplication/json
The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a role code already taken or a team the caller does not own, uses the same code with error.message saying why and no fields.
On this endpoint: VALIDATION_FAILED: when the suggestion was already decided, its batch is not ready, payload is not an object, or the fields fail the record's own rules (a missing title, for one).
425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json
The first request with this key is still running; retry in a few seconds and the original response is replayed.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on