Post a comment
/v1/projects/{project}/comments in the Comments API.
curl -X POST https://api.example.test/v1/projects/$PROJECT_ID/comments \ -H "Authorization: Bearer $TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "artefact_type": "work-item", "artefact_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "body": "<p>After the discount: the rule CRM-BR-7 says the voucher comes last.</p>", "parent_id": "e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a81" }'Writes a comment on an artefact of the project as the token's holder, who becomes a follower of the artefact. body is HTML or plain text, sanitised on read. parent_id names the first comment of the thread the comment answers; it must be on the same artefact. internal keeps the comment from client guests and needs comment:internal; a reply to an internal comment is internal whatever is sent. The people named and the other followers are told.
Answers 201 with the comment and emits comment.created.
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 project.
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 carriesRequiredapplication/json
A comment to post: the artefact by type and id, the words, whether the comment is internal and, for a reply, the first comment of the thread it answers. People named with @ and their full name, or their first name when it is unambiguous, are told.
Responses
201Createdapplication/json
The comment, 201.
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 holder's role on the project does not carry comment:create, the holder is a client guest on a project whose guest_can_comment setting is off, or the comment is internal and the role does not carry comment:internal.
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 artefact is hidden from the token, missing or of another project.
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 type is unknown, an id is not a uuid, the body is empty or over 20,000 characters, or the parent is missing, a reply itself or on another artefact.
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