Skip to main content
POST
Contracts / Request Deletion

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 schedule for deletion. It must be the contract of the authenticated contract token; otherwise 404.

Maximum string length: 36

Body

application/json

Registers a contract-holder deletion request to be processed asynchronously at the given future date. Requires a contract-bound token, not a partner API key. Required permission: crm:contracts:deletion-request. Available contexts: Contract.

deleteAt
string<date-time>
required

Future date and time at which the contract becomes eligible for deletion.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$
Example:

"2023-09-25T12:00:00Z"

Response

Receipt that the deletion request was registered; the actual deletion runs asynchronously.

message
string
required

Human-readable confirmation of the deletion request.

deleteAt
string<date-time>
required

Echo of the requested deletion date; marks when the contract becomes eligible for deletion.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$