Skip to main content
POST
Cancel a project (with a reason)

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.

zivio-tenant-id
string
header
required

Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.

Path Parameters

id
integer
required

Project ID

Body

application/json
reason_code_id
integer

A cancellation reason code id (tenants with reason codes configured). The 422 response lists the valid codes.

Example:

12

custom_reason
string

Free-text detail accompanying the reason code.

Example:

"The requirement has been withdrawn by the budget owner."

cancellation_reason_id
integer

A cancellation reason id (tenants without reason codes). The 422 response lists the valid reasons.

Example:

3

cancellation_other_reason
string

Free-text reason, used with the "other" cancellation reason.

Example:

"Duplicate of an existing engagement."

Response

The project state after the call, with how many open proposals were eliminated

The response is of type object.