API reference

Reminders

Automatic reminder emails to signers who haven’t signed yet.

Endpoints · 4

GET Get a document’s reminders
PUT Set a document’s reminders
GET Get the workspace default
PUT Set the workspace default

The object

Field	Type	Description
`every_days`	integer or null	Remind every this many days (1 to 30) while someone hasn’t signed, or null for no automatic reminders.

GET/documents/{id}/reminders

Get a document’s reminders

Request

bash

curl "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/reminders" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{ "object": "reminder_schedule", "every_days": 3 }

PUT/documents/{id}/reminders

Set a document’s reminders

Works on drafts and on documents that are out for signature.

Parameter	Type		Description
`every_days`	integer or null	required	1 to 30, or null to stop.

Request

bash

curl -X PUT "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/reminders" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "every_days": 2 }'

Response

json

{ "object": "reminder_schedule", "every_days": 2, "document_id": "doc_3y9Pf34qY6Nb3wWD25RQ4F" }

GET/workspaces/{id}/reminder-defaults

Get the workspace default

Used for new documents.

Request

bash

curl "https://api.esorasign.com/v1/workspaces/wsp_16lLlGUriAX1DyyXN9iYw1/reminder-defaults" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{ "object": "reminder_defaults", "every_days": 3 }

PUT/workspaces/{id}/reminder-defaults

Set the workspace default

Parameter	Type		Description
`every_days`	integer or null	required	1 to 30, or null.

Request

bash

curl -X PUT "https://api.esorasign.com/v1/workspaces/wsp_16lLlGUriAX1DyyXN9iYw1/reminder-defaults" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "every_days": 3 }'

Response

json

{ "object": "reminder_defaults", "every_days": 3 }