v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Exception

Add a comment to an exception

Use this endpoint to add a comment to a specific exception. Comments help track team discussions, decisions, and investigation notes.

post/v1/exceptions/{exceptionId}/comments

Path parameters

exceptionIdstring required

The unique identifier of the exception.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Request body

contentstring required

Comment text content

Response

Comment added successfully.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

idstring

Unique identifier of the comment

exceptionIdstring

The exception this comment belongs to

authorstring

Author of the comment

contentstring

Comment text content

createdAtstring date-time

Timestamp when the comment was created

updatedAtstring date-time

Timestamp when the comment was last updated

Example response

{
  "id": "019c96a0-2a10-7dfe-b5c1-8a1b2c3d4e5f"
}