Skip to main content
POST
/
sign
/
envelopes
/
{envelopeID}
/
participants:batch-delete
Delete Participants by Participant IDs
curl --request POST \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/participants:batch-delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "type": "https://developers.gonitro.com/docs/build-nitro/errors#401-unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Missing or invalid Authorization header",
  "instance": "/sign/envelopes"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelopeID
string<uuid>
required

A unique UUIDv4 string that identifies the envelope in the Nitro system.

Body

application/json

A set of unique UUIDv4 strings that identify the participants in the Nitro system.

​
items
string<uuid>[]

An array of participant IDs to be deleted from the envelope.

Response

Participants deleted successfully