Redistribute envelope

POST

/envelope/redistribute

curl --request POST \
  --url https://app.legaldoc.com/api/v2/envelope/redistribute \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "envelopeId": "example", "recipients": [ 1 ] }'

Redistribute the envelope to the provided recipients who have not actioned the envelope. Will use the distribution method set in the envelope. This also refreshes the signing-link expiration for the targeted unsigned recipients, renewing any expired links.

Authorizations

• apiKey

Request Body^required

Media typeapplication/json

object

envelopeId

required

string

recipients

required

Array<number>

>= 1 items

Example^generated

{
  "envelopeId": "example",
  "recipients": [
    1
  ]
}

Responses

200

Successful response

Media typeapplication/json

object

success

required

boolean

id

required

string

recipients

required

Array<object>

object

id

required

number

name

required

string

email

required

string

token

required

string

role

required

string

Allowed values: CC SIGNER VIEWER APPROVER ASSISTANT

signingOrder

required

number | null

signingUrl

required

string

Example

{
  "recipients": [
    {
      "role": "CC"
    }
  ]
}

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"
    }
  ]
}