PUT /v1/signature/envelopes/{id}/requested-documents

PUT

/v1/signature/envelopes/{id}/requested-documents

curl --request PUT \
  --url https://api.asap.cool/v1/signature/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/requested-documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "documents": [ { "label": "example", "position": 1, "required": true, "signer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ] }'

• Production

Authorizations

• api_key
  signature:write
• session

Parameters

Path Parameters

id

required

string format: uuid

Envelope identifier.

Request Body ^required

Media type application/json

Body of PUT …/requested-documents: the full set, replacing any prior one.

object

documents

required

The documents to request (replaces the existing set).

Array<object>

One requested document in a PUT …/requested-documents body.

object

label

required

Human label shown to the signer (required, non-blank).

string

position

Display order among the requested pieces (>= 0).

integer format: int32

required

Whether the upload blocks signing (defaults to true).

boolean

signer_id

The signer to request it from; null = any signer may upload it.

string | null format: uuid

Example ^generated

{
  "documents": [
    {
      "label": "example",
      "position": 1,
      "required": true,
      "signer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ]
}

Responses

200

Requested documents replaced.

Media type application/json

Array<object>

Public projection of a [RequestedDocument].

object

id

required

Stable identifier.

string format: uuid

label

required

Human label shown to the signer.

string

position

required

Display order.

integer format: int32

required

required

Whether the upload blocks signing.

boolean

signer_id

The signer it is requested from; null = any signer.

string | null format: uuid

Example ^generated

[
  {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "label": "example",
    "position": 1,
    "required": true,
    "signer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
]

401

No active org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

403

Missing signature:write scope.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

404

Not found or cross-org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

409

Not a draft, or a target signer is outside the envelope (signature_conflict).

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

422

A document has a blank label or a negative position.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}