Revoke a previously created invitation

Request

Revoke a single invitation so its signing URL stops working immediately.

Each invitation has its own signing URL; revoking one invitation does not affect other invitations for the same participant. Use this when a message was sent to the wrong recipient or the link must otherwise be invalidated.

Revoking an already-revoked invitation returns 409 Conflict.

Security

APIKey

Path

session_idstring, (uuid)required

The UUID of the signing session.

Example:0196ae5b-2e9d-729f-aba5-fa4db6f881fd

participant_idstring, (uuid)required

The UUID of the participant.

Example:0196ae5b-2e9d-729f-aba5-fa4db6f88211

invitation_idstring, (uuid)required

The UUID of the invitation.

Example:0196ae5b-2e9d-729f-aba5-fa4db6f88311

Acceptstringrequired

Specify the response format.

Value:"application/json"

curl -i -X DELETE \
  https://api.embed.docue.com/sign/sessions/0196ae5b-2e9d-729f-aba5-fa4db6f881fd/participants/0196ae5b-2e9d-729f-aba5-fa4db6f88211/invitations/0196ae5b-2e9d-729f-aba5-fa4db6f88311 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>'

Responses

Successfully revoked the invitation. No content is returned.

Response

No content