Signings

Add a note to a signing

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.

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)

Path parameters

signingIdstring uuid required

Request body

bodystring required
authorLabelstring

Your own name for whoever wrote it. Echoed back.

Response

The stored comment.

commentIdstring uuid
author'client' | 'tvarka'
authorLabelstring nullable
bodystring
createdAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.