Send reminders to one or more signers

Send manual reminders to signers on a PENDING document.

If signerIds is omitted, a reminder is sent to every signer that has not yet signed (and is eligible — has email, has been sent the document, etc.).

Rate limiting: Each signer can only receive one reminder per 24 hours. Signers that are rate-limited or otherwise not eligible are returned in the response with status: SKIPPED and a reason.

POST /api/v1/documents/{id}/reminders

Send reminders to one or more signers

cURL

curl --request POST \
  --url https://app.sajn.se/api/v1/documents/{id}/reminders \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "signerIds": [
    "<string>"
  ]
}
'

200

{
  "sent": 0,
  "skipped": 0,
  "failed": 0,
  "results": [
    {
      "signerId": "<string>",
      "signerEmail": "<string>",
      "signerName": "<string>",
      "reason": "<string>"
    }
  ]
}

Headers

authorization · string · required

Bearer token for API authentication

Path Parameters

id · string · required

Body

application/json

Body

signerIds · string[]

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

Response

200

application/json

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

Show child attributes