The cancel endpoint is used when a user wants to recall an esign. Upsales calls it in two cases:
- The user clicks Revoke e-sign on the esign.
- The user deletes the esign. The esign is removed from Upsales before /cancel is called.
Right after a successful /cancel, Upsales calls your app's /delete endpoint with the same body, so your app must implement both. Upsales only calls /cancel when the esign has a documentId (one that is not "0").
Endpoint POST https://yourapp.com/cancel
The endpoint must use HTTPS.
Body
Request body.data contains documentId of the esign to cancel (body.data.documentId).
Response
Respond with status 200 or 201. The response body is not used. By default, Upsales waits 30 seconds for the response.
Any other status, or no response in time, stops the flow: Upsales does not call /delete, and a revoked esign keeps its current status in Upsales.