Aller au contenu

POST /v1/signature/envelopes/{id}/reactivate

POST
/v1/signature/envelopes/{id}/reactivate
curl --request POST \
--url https://api.asap.cool/v1/signature/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/reactivate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "expires_at": "example" }'
id
required
string format: uuid

Envelope identifier.

Media type application/json

Optional body of POST …/reactivate: a new expiry deadline (RFC3339). When omitted, a fresh default token lifetime from now is applied.

object
expires_at

New expiry deadline for the envelope and its tokens (RFC3339). Omitted = default token lifetime from now.

string | null
Example generated
{
"expires_at": "example"
}

Expired envelope reactivated, fresh tokens issued.

Media type application/json

Body of a successful reactivation.

object
expires_at
required

The new expiry deadline applied to the envelope (RFC3339).

string
reactivated
required

Always true on a 200 response.

boolean
recipients
required

Number of fresh access links dispatched (one per still-pending signer).

integer
Example generated
{
"expires_at": "example",
"reactivated": true,
"recipients": 1
}

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

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

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

Envelope is not expired (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"
}

Invalid expires_at.

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