Référence de l'API

Rappels

Des courriels de rappel automatiques aux signataires qui n'ont pas encore signé.

Points de terminaison · 4

GET Obtenir les rappels d'un document
PUT Régler les rappels d'un document
GET Obtenir le réglage par défaut de l'espace de travail
PUT Régler le réglage par défaut de l'espace de travail

L'objet

Champ	Saisir	Description
`every_days`	integer ou null	Rappel tous les tant de jours (de 1 à 30) tant que quelqu'un n'a pas signé, ou null pour aucun rappel automatique.

GET/documents/{id}/reminders

Obtenir les rappels d'un document

Requête

bash

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

Réponse

json

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

PUT/documents/{id}/reminders

Régler les rappels d'un document

Fonctionne sur les brouillons et sur les documents en cours de signature.

Paramètre	Saisir		Description
`every_days`	integer ou null	obligatoire	De 1 à 30, ou null pour arrêter.

Requête

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 }'

Réponse

json

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

GET/workspaces/{id}/reminder-defaults

Obtenir le réglage par défaut de l'espace de travail

Utilisé pour les nouveaux documents.

Requête

bash

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

Réponse

json

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

PUT/workspaces/{id}/reminder-defaults

Régler le réglage par défaut de l'espace de travail

Paramètre	Saisir		Description
`every_days`	integer ou null	obligatoire	De 1 à 30, ou null.

Requête

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 }'

Réponse

json

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