Passer au contenu

Cancel an existing EviSign

Requête

Requests cancellation of a previously submitted EviSign for the authenticated site/user context. Cancellation is accepted and processed asynchronously.

Sécurité
basicAuth
Corpsapplication/jsonobligatoire

UniqueId is required and must not be the empty UUID. Comments is a required, nonblank cancellation reason (maximum 2048 characters). Quietly defaults to false.

UniqueIdstring, (uuid)obligatoire

Unique identifier of the EviSign to cancel.

Commentsstring, [ 1 .. 2048 ] characters\Sobligatoire

Required, nonblank reason for cancelling. Maximum 2048 characters.

Quietlyboolean

Indicates whether cancellation should be processed without notifying parties.

curl -i -X POST \
  -u '<username>:<password>' \
  https://api.evicertia.com/v1/evisign/cancel \
  -H 'Content-Type: application/json' \
  -d '{
    "UniqueId": "d11caec2-70bd-4739-afd5-aa7600920538",
    "Comments": "Contract superseded by a revised version.",
    "Quietly": false
  }'

Réponses

Cancellation request accepted and queued for processing.

Corpsapplication/json
uniqueIdstring or null^[0-9a-fA-F]{32}$

Unique identifier of the cancelled EviSign. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

Réponse
{ "uniqueId": "string" }