Decline or revoke an acknowledgement

post

https://api.wingspan.app/v3/onboarding/acknowledgements/{acknowledgementName}/revoke

Explicitly records that the caller declines the named agreement or withdraws a prior acceptance. The result is Revoked with revokedAt set, whether or not the agreement was previously accepted. The policy version is required so the withdrawal remains auditable.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

acknowledgementName

string

enum

required

The canonical name of the acknowledgement

Body Params

Request body for explicitly declining an agreement or revoking a prior acceptance. The resulting status is Revoked in both cases.

version

string

required

Version of the agreement being declined or revoked

Headers

X-Wingspan-Account

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).

Idempotency-Key

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

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Acknowledgement declined or revoked

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error

503A downstream dependency is temporarily unavailable; retryable. Body carries code: ServiceUnavailable and may include extensions.retryAfter.