Update envelope recipients

POST

/envelope/recipient/update-many

curl --request POST \
  --url https://app.legaldoc.com/api/v2/envelope/recipient/update-many \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "envelopeId": "example", "data": [ { "id": 1, "email": "", "name": "example", "role": "CC", "signingOrder": 1, "accessAuth": [], "actionAuth": [] } ] }'

Update multiple recipients for an envelope

Authorizations

• apiKey

Request Body^required

Media typeapplication/json

object

envelopeId

required

string

data

required

Array<object>

object

id

required

number

email

Any of:

string

string

Allowed values: ""

string

string

<= 254 characters /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\u{0080}-\u{FFFF}-]+@[a-zA-Z0-9\u{0080}-\u{FFFF}](?:[a-zA-Z0-9\u{0080}-\u{FFFF}-]{0,61}[a-zA-Z0-9\u{0080}-\u{FFFF}])?(?:\.[a-zA-Z0-9\u{0080}-\u{FFFF}](?:[a-zA-Z0-9\u{0080}-\u{FFFF}-]{0,61}[a-zA-Z0-9\u{0080}-\u{FFFF}])?)*$/

name

string

<= 255 characters

role

string

Allowed values: CC SIGNER VIEWER APPROVER ASSISTANT

signingOrder

number

accessAuth

Array<string>

default:

Allowed values: ACCOUNT TWO_FACTOR_AUTH

actionAuth

Array<string>

default:

Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH PASSWORD EXPLICIT_NONE

Responses

200

Successful response

Media typeapplication/json

object

data

required

Array<object>

object

envelopeId

required

string

role

required

string

Allowed values: CC SIGNER VIEWER APPROVER ASSISTANT

readStatus

required

string

Allowed values: NOT_OPENED OPENED

signingStatus

required

string

Allowed values: NOT_SIGNED SIGNED REJECTED

sendStatus

required

string

Allowed values: NOT_SENT SENT

id

required

number

email

required

string

name

required

string

token

required

string

documentDeletedAt

required

string | null

expired

required

string | null

expiresAt

required

string | null

expirationNotifiedAt

required

string | null

signedAt

required

string | null

authOptions

required

object

accessAuth

required

Array<string>

Allowed values: ACCOUNT TWO_FACTOR_AUTH

actionAuth

required

Array<string>

Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH PASSWORD EXPLICIT_NONE

signingOrder

required

number | null

rejectionReason

required

string | null

documentId

number | null

templateId

number | null

Example

{
  "data": [
    {
      "role": "CC",
      "readStatus": "NOT_OPENED",
      "signingStatus": "NOT_SIGNED",
      "sendStatus": "NOT_SENT",
      "authOptions": {
        "accessAuth": [
          "ACCOUNT"
        ],
        "actionAuth": [
          "ACCOUNT"
        ]
      }
    }
  ]
}

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