Skip to main content
POST
Send reminders to one or more signers

Authorizations

Authorization
string
header
required

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Scopes

documents:write

Create documents and edit the documents the user created.

Headers

Sajn-Version
enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:
2026-09,
2026-10
Sajn-Workspace
string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Path Parameters

id
string
required

The document ID.

Body

application/json

Body

partyIds
string[]

Specific party IDs to remind. Omit to remind every pending party on the document.

channel
enum<string>

Channel for the reminder. Defaults to each party's delivery method. A party without an address for the channel is skipped with reason MISSING_EMAIL or MISSING_PHONE. SMS reminders are billed like SMS invites.

Available options:
EMAIL,
SMS

Response

200

sent
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
skipped
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
failed
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
results
object[]
required