update-recipient

POST

/public/envelope/update-recipient

• Enclave API server

Update recipient information in an envelope.

Request Body ^required

object

workspaceUuid

Optional. When omitted, the team’s default workspace is used.

string

>= 36 characters <= 36 characters

envelopeUuid

required

The UUID of the envelope.

string

>= 36 characters <= 36 characters

email

required

The email address of the recipient to update.

string format: email

<= 255 characters /^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

role

required

The recipient role (used to identify the recipient).

string

Allowed values: signer approver viewer

updates

required

object

firstname

string

<= 128 characters

lastname

string

<= 128 characters

phone

string

<= 32 characters

jobTitle

string

<= 255 characters

company

string

<= 255 characters

addressLine1

string

<= 255 characters

addressLine2

string

<= 255 characters

zipCode

string

<= 32 characters

city

string

<= 128 characters

country

string

<= 128 characters

role

string

Allowed values: signer approver viewer

order

number

language

string

Allowed values: en fr es it fi

verificationType

string

Allowed values: none sms email

Responses

200

Default Response

object

recipient

required

object

email

required

string

firstname

required

string

lastname

required

string

phone

required

Any of:

string

string

null

null

jobTitle

string

company

string

addressLine1

string

addressLine2

string

zipCode

string

city

string

country

string

role

required

string

Allowed values: signer approver viewer

order

required

number

associatedContact

required

boolean

status

required

string

Allowed values: pending approved signed declined canceled

language

required

string

Allowed values: en fr es it fi

verificationType

required

string

Allowed values: none sms email

colorVariant

required

string

400

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: WORKSPACE_NOT_FOUND ENVELOPE_NOT_FOUND RECIPIENT_NOT_FOUND DUPLICATE_RECIPIENT ENVELOPE_NOT_IN_DRAFT FEATURE_NOT_IN_CURRENT_PLAN INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

401

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR TUNNEL_SESSION_NOT_FOUND INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

403

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHORIZATION_ERROR FEATURE_NOT_IN_CURRENT_PLAN INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

500

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string