delete
https://api-sandbox.urbanpayx.com/api/v1/contracts/workflows/
Delete archived contract flow
Permanently deletes an archived contract flow. Flows linked to contract
requests cannot be deleted.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Permanently deletes an archived contract flow belonging to your client. This is irreversible. The flow must already be in the ARCHIVED state and must not be linked to any existing contract requests. On success the endpoint returns no content.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - The caller must hold the
contracts.workflows.archivepermission and have the OWNER or OPERATIONS role. - Contract signing must be enabled for the client. If it is disabled the request returns
403.
Path parameters
workflow_id(string, required) — the ID of the contract flow to delete. It must belong to the authenticated client.
Preconditions
- The flow must be in the
ARCHIVEDstate. Flows in any other state (for exampleDRAFTorPUBLISHED) cannot be deleted and return400. Archive the flow first. - The flow must not be linked to any contract requests. If at least one contract request references it, deletion is rejected with
400.
Response
204 No Content— the archived contract flow was permanently deleted. The response body is empty.
Error responses
| Status | When |
|---|---|
400 | The flow is not ARCHIVED, or it is linked to one or more contract requests |
403 | Contract signing is disabled for the client |
404 | No contract flow with this workflow_id exists under the authenticated client |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.
204Successful Response