API reference

Version 1.3.0-m4. Base URL https://signenvoystaging.fly.dev/v1. Rendered from the OpenAPI 3.1 document, the same file the official clients are generated from.

Authenticate with Authorization: Bearer <api key>. Every response carries X-SignEnvoy-Envelopes-Remaining and the X-RateLimit-* headers; every error is an application/problem+json document whose docs_url points into the error reference. Send an Idempotency-Key on any POST you may retry.

Account

GET /v1/me Me

API keys

GET /v1/keys List Keys
POST /v1/keys Create Key
POST /v1/keys/{key_id}/revoke Revoke Key

Documents

GET /v1/documents List Documents
POST /v1/documents Create Document
GET /v1/documents/{doc_id} Get Document
PATCH /v1/documents/{doc_id} Patch Document
PUT /v1/documents/{doc_id}/content Upload Document Content
GET /v1/documents/{doc_id}/download Download Document
POST /v1/documents/{doc_id}/duplicate Duplicate Document
GET /v1/documents/{doc_id}/events Document Events
PUT /v1/documents/{doc_id}/fields Put Fields
POST /v1/documents/{doc_id}/finalize Finalize Document
PUT /v1/documents/{doc_id}/recipients Put Recipients
POST /v1/documents/{doc_id}/send Send Document
POST /v1/documents/{doc_id}/void Void Document

Templates

GET /v1/templates List Templates
POST /v1/templates Create Template
GET /v1/templates/{tpl_id} Get Template
PATCH /v1/templates/{tpl_id} Patch Template
DELETE /v1/templates/{tpl_id} Delete Template
POST /v1/templates/{tpl_id}/duplicate Duplicate Template
POST /v1/templates/{tpl_id}/use Use Template

Webhook endpoints

GET /v1/webhooks List Webhooks
POST /v1/webhooks Create Webhook
PATCH /v1/webhooks/{webhook_id} Patch Webhook
DELETE /v1/webhooks/{webhook_id} Delete Webhook
GET /v1/webhooks/{webhook_id}/deliveries List Deliveries
POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver Redeliver
POST /v1/webhooks/{webhook_id}/disable Disable Webhook
POST /v1/webhooks/{webhook_id}/ping Ping Webhook
POST /v1/webhooks/{webhook_id}/rotate-secret Rotate Secret

auth

POST /v1/device/code Device Code
POST /v1/device/token Device Token

bulk-sends

GET /v1/bulk-sends List Bulk Sends
POST /v1/bulk-sends Create Bulk Send
GET /v1/bulk-sends/{bulk_send_id} Get Bulk Send
POST /v1/bulk-sends/{bulk_send_id}/cancel Cancel Bulk Send
POST /v1/bulk-sends/{bulk_send_id}/dispatch Dispatch Bulk Send

events

GET /v1/events/stream Event Stream

folders

GET /v1/folders List Folders
POST /v1/folders Create Folder
PATCH /v1/folders/{folder_id} Patch Folder
DELETE /v1/folders/{folder_id} Delete Folder

Schemas

Request and response object definitions.