Skip to main content
POST
Request a void on an agreement

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
void_reason
string

Internal reason recorded with the request; the provider carries the void out.

Maximum string length: 2000

Response

200 - application/json

Default Response

uuid
string
required
partnership_uuid
string
required

The partnership this agreement belongs to. The subject of every v1 agreement.

agreement_template_uuid
string | null
required

The provider template this agreement was created from, or null once the template is deleted.

name
string
required

Document name shown to signers.

status
enum<string>
required

requested after create; the provider's installation moves it through sent/viewed to signed, or to a terminal declined, voided, expired or failed. Never settable by a person.

Available options:
requested,
sent,
viewed,
signed,
declined,
voided,
expired,
failed
provider_key
string
required

The provider app's name (installations.app_id -> apps.name), stamped by the server — identifies which provider owns this agreement.

external_ref
string | null
required

The provider's object id for this agreement (e.g. the envelope id), set by the installation on send.

failure_reason
string | null
required

The provider's own error text when status is failed.

requested_by_user_uuid
string | null
required

User who created the agreement, when the creating credential identifies one.

signed_asset_uuid
string | null
required

Asset holding the signed document, once uploaded (JOU-961).

certificate_asset_uuid
string | null
required

Asset holding the completion certificate, once uploaded (JOU-961).

sent_at
string | null
required
viewed_at
string | null
required
completed_at
string | null
required
declined_at
string | null
required
voided_at
string | null
required
expired_at
string | null
required
failed_at
string | null
required
expires_at
string | null
required

Provider-reported signing deadline.

void_requested_at
string | null
required

Set when a person requested a void; the provider's installation carries it out and then patches status to voided.

void_reason
string | null
required

Optional reason recorded with the void request. Internal — never shown to the partner.

created_at
string
required
updated_at
string
required
signers
object[]
required