Contracts

Cancel contract

Cancels (deactivates) a contract. Active contracts cannot be deleted; cancel is the terminal operation.

post/customers/{customerID}/contracts/{contractID}/cancel

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/customers/{customerID}/contracts/{contractID}/cancel
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

customerIDstring required
contractIDstring required

Request body

reasonstring

Optional cancellation reason.

Response

OK - Contract cancelled.

contractIdstring

The contract identifier.

status'active' | 'scheduled' | 'cancelled'

The contract status after the operation (active, scheduled, or cancelled).

Changes

No recorded changes to this operation across all 1 revision of this API.