Skip to main content
POST
Contracts / Cancel

Authorizations

Authorization
string
header
required

OAuth2 Bearer Authorization

Scopes

crm:contracts

Headers

Accept-Language
string

BCP 47 language tag for content negotiation (e.g. en, de-DE).

Example:

"en"

Path Parameters

uuid
string
required

Identifies the contract to cancel. It must belong to the client of the API key; otherwise 404.

Maximum string length: 36

Body

application/json

Terminates a contract using the strategy selected via cancel_type and returns the resulting end date. Required permission: crm:contracts:cancel. Available contexts: API Key.

filing_cancel_date
string<date>
required

Filing date of the cancellation (YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-03-15"

cancel_type
enum<string>
required

Cancellation strategy. Allowed values: deadlineDate (earliest legal cancellation date, auto-calculated, no extra date required); extraOrdinaryDate (immediate termination, requires extra_ordinary_date); cancelDate (scheduled termination, requires cancel_date); moveAtDate (relocation, requires move_at_date).

Available options:
deadlineDate,
extraOrdinaryDate,
cancelDate,
moveAtDate
Example:

"deadlineDate"

cancellation_tech_key
string
required

Technical key identifying the cancellation reason; validated against the client's registered presets. Common values: DUNNINGLEVEL3CANCELLED, CANCELEDBYPROVIDER, MOVEOUT, CLOSEDOWN, RELOCATION.

extra_ordinary_date
string<date>

Extraordinary cancellation date (YYYY-MM-DD). Required when cancel_type = extraOrdinaryDate.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-03-20"

cancel_date
string<date>

Scheduled cancellation date (YYYY-MM-DD). Required when cancel_type = cancelDate.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-04-01"

move_at_date
string<date>

Relocation move-out date (YYYY-MM-DD). Required when cancel_type = moveAtDate.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-05-01"

Response

Cancellation confirmation including the resulting contract end date.

message
string
required

Human-readable confirmation of the cancellation.

cancelled_at_date
string<date>

Effective contract end date after cancellation (YYYY-MM-DD). For cancel_type deadlineDate this is auto-calculated; for the other strategies it equals the input date. Null when the service did not resolve an end date.

Pattern: ^\d{4}-\d{2}-\d{2}$