Delete envelope recipient

POST

/envelope/recipient/delete

curl --request POST \
  --url https://app.legaldoc.com/api/v2/envelope/recipient/delete \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "recipientId": 1 }'

Delete an envelope recipient

Authorizations

• apiKey

Request Body^required

Media typeapplication/json

object

recipientId

required

number

Example^generated

{
  "recipientId": 1
}

Responses

200

Successful response

Media typeapplication/json

object

success

required

boolean

Example^generated

{
  "success": true
}

400

Invalid input data

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

401

Authorization not provided

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

403

Insufficient access

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

500

Internal server error

Media typeapplication/json

object

message

required

string

code

required

string

issues

Array<object>

object

message

required

string

Example^generated

{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}