---
title: "Add a note to a signing"
method: POST
path: "/v1/signings/{signingId}/comments"
tags: ["Signings"]
---

# Add a note to a signing

`POST /v1/signings/{signingId}/comments`

## Request

- Base URL: `https://sign-api.tvarka.pro`
- URL: `https://sign-api.tvarka.pro/v1/signings/{signingId}/comments`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
  - OAuth 2 (authorization code, authorization URL `https://sign-api.tvarka.pro/oauth/authorize`, token URL `https://sign-api.tvarka.pro/oauth/token`, scopes: `sign.read`, `sign.signings`)

Comments provide a private communication record for the integration
and its audit trail. Access is limited to the integration; signer
communications are handled through the signing ceremony.

## Path parameters

- `signingId` string, uuid, required

## Request body

- object
  - `body` string, required
  - `authorLabel` string: Your own name for whoever wrote it. Echoed back.

## Response `201`

The stored comment.

- Comment
  - `commentId` string, uuid
  - `author` 'client' | 'tvarka'
  - `authorLabel` string, nullable
  - `body` string
  - `createdAt` string, date-time

## Other responses

- `400`: An RFC 9457 problem document.
- `401`: An RFC 9457 problem document.
- `402`: An RFC 9457 problem document.
- `403`: An RFC 9457 problem document.
- `404`: An RFC 9457 problem document.
- `413`: An RFC 9457 problem document.
- `429`: An RFC 9457 problem document.
- `503`: An RFC 9457 problem document.

---

[API](https://skmtc.dev/tvarka/apis/tvarka-sign-api.md) · [All operations](https://skmtc.dev/tvarka/apis/tvarka-sign-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tvarka/apis/tvarka-sign-api/revisions/e3fdd995c013?raw)
