delete
https://api-sandbox.urbanpayx.com/api/v1/contracts/workflows/
Delete contract flow
Permanently deletes a contract flow. Returns 404 if it does not exist,
and 400 if it is linked to any contract request.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Permanently deletes a contract flow belonging to your client, regardless of its status (draft, published, or archived). This is irreversible. The only thing that blocks deletion is being linked to an existing contract request. 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 not be linked to any contract requests. If at least one contract request references it, deletion is rejected with
400. Status (draft, published, or archived) is not checked.
Response
204 No Content— the archived contract flow was permanently deleted. The response body is empty.
Error responses
| Status | When |
|---|---|
400 | The flow 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.
Successful Response