Templates

Send a template to a list, one signing per row

Every row is checked first, exactly as a single send from the template would be; one bad row refuses the list and nothing is created. Then the rows are sent in the background (v1.14.0). A row may not carry personalCode or an access_code authentication: those signings are sent one by one. A simple e-signature list must fit today's invitation allowance in full (429 invitation-limit).

post/v1/templates/{templateId}/bulk-sends

Request

  • Base URL: https://sign-api.tvarka.pro
  • URL: https://sign-api.tvarka.pro/v1/templates/{templateId}/bulk-sends
  • 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

templateIdstring uuid required

Headers

Idempotency-Keystring

Optional tenant-and-operation-scoped create key (1-128 visible ASCII characters). Identical input replays the original response; changed input or an unresolved execution returns 409. After 90 days the response expires but the key remains reserved. Do not change keys to retry a request with an uncertain outcome.

Request body

titlestring

Every signing's title, unless a row sets its own. Defaults to the template's title.

delivery'link' | 'email'
webhookUrlstring uri
expiresInDaysinteger
softDeadlineInDaysinteger

Response

The list is accepted and queued.

bulkSendIdstring uuid
templateIdstring uuid nullable
titlestring
status'queued' | 'running' | 'finished'
rowsTotalinteger
rowsSentinteger
rowsFailedinteger
createdAtstring date-time
startedAtstring date-time nullable
finishedAtstring date-time nullable

Changes

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