API Reference

Update a signature request

patch
https://api.wingspan.app/v3/compliance/signature-requests/

Updates the caller-owned fields of a SignatureRequest. Only the fields supplied are changed.

These are the only mutable fields. The signing lifecycle is not caller-driven — status, signers, completedFileId and every timestamp are written by the e-signature provider's own progress — and templateId is fixed at the moment the request was opened.

The calling account must be the request's PAYER. externalId is unique per payer account, so a payee write would reserve a value inside the other party's namespace; a payee receives 404, not 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of a request resource

Body Params

Patch body for a SignatureRequest. Only the fields supplied are changed.

These two are the only mutable fields, and both belong to the caller rather than to the signing lifecycle. status, signers, completedFileId and every timestamp are written by the e-signature provider's own progress, and templateId is fixed at the moment the request was opened.

The calling account must be the request's PAYER. externalId is unique per payer account, so a payee write would reserve a value inside the other party's namespace; a payee receives 404, not 403.

string

Caller-supplied reconciliation id, unique per payer account. A duplicate returns 409 ResourceConflict. This is your own id, not the e-signature provider's.

metadata
object

Keys supplied are set; keys left out are left alone. Sending {} is a no-op rather than a clear — there is no way to remove a key once set.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 14 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 14 days ago

Did this page help you?