Plan the scope
/v1/sprints/{sprint}/items in the Sprints API.
curl -X PUT https://api.example.test/v1/sprints/$SPRINT_ID/items \ -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \ -H "Idempotency-Key: 7a2e5f91-1c4b-4d8e-9b3a-6c7d8e9f0a13" \ -d '{"add": ["4f1c2d3e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"], "remove": []}'Moves work items into (add) and out of (remove) a planned or running sprint in one call; an item already in the sprint is left as it is, an item not in it is ignored on removal, and an item that is done or cancelled does not join. sprint.scope_changed goes out with what joined and what left. Answers with the sprint and its items as they now stand.
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.
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 sprint.
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
The work items to move into and out of a sprint in one call. Items already in the sprint are left as they are when added again, and items not in it are ignored when removed; an item that is done or cancelled does not join.
Responses
200OKapplication/json
The sprint with its items as they now stand.
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 role does not carry work-item:update.
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 an item is not this project's.
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 a list holds more than 500 ids or an id is not a UUID, the sprint takes no more items (it is with the team, completed or cancelled), or an item is done or cancelled. DEFINITION_INCOMPLETE: when the project requires the Definition of Ready and an item added does not meet it; error.context.missing names the entries still unticked.
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