Excuse participant from signing on started session

Request

Release a participant from the requirement to sign. Their outstanding invitations stop working immediately.

At least one participant must still sign or have signed. You cannot excuse a participant who is currently signing or who has already signed.

If nobody remains who still needs to sign, the session completes.

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

Acceptstringrequired

Specify the response format.

Value:"application/json"

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

Responses

Successfully excused the participant.

Bodyapplication/json

dataobject(SigningSessionParticipantData)required

Response body. Null when there is nothing to return.

metaobjectrequired

Response

{
  "data": {
    "id": "0196ae5b-2e9d-729f-aba5-fa4db6f88211",
    "status": "pending",
    "status_changed_at": "2019-08-24T14:15:22Z",
    "decline_reason": "Terms are not acceptable",
    "name": "John Doe",
    "external_id": "user-123",
    "ui_language": "en-GB",
    "signing_order": 0,
    "invitations": [ … ],
    "signing_methods": [ … ],
    "view_gate": { … }
  },
  "meta": {
    "status": { … },
    "pagination": { … }
  }
}