Version: API v1

Kündigung einleiten

POST/v1/cancellations

API-Version

Request-Methode

POST

Operation-ID

cancelContract

Leitet die Kündigung für einen bestimmten Tarif ein

Request

Format

application/json

contractintegerrequired
domainsArray von object
- Array[
  - *object
    - domainstring
    - transferboolean
    - transitboolean
    - cancellationDateinteger
  ]
messagestring
Eine persönliche Nachricht zur Kündigung
callboolean
Wahr, wenn der Kunde noch einmal angerufen werden möchte
reasoninteger
ID des Kündigungsgrundes

Content-Type: application/json

{
  "contract": 123,
  "domains": [
    {
      "domain": "string",
      "transfer": true,
      "transit": true,
      "cancellationDate": 123
    }
  ],
  "message": "string",
  "call": true,
  "reason": 123
}

{
  "title": "CancellationRequest",
  "required": [
    "contract"
  ],
  "type": "object",
  "properties": {
    "contract": {
      "type": "integer"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string"
          },
          "transfer": {
            "type": "boolean"
          },
          "transit": {
            "type": "boolean"
          },
          "cancellationDate": {
            "type": "integer"
          }
        }
      }
    },
    "message": {
      "type": "string",
      "description": "Eine persönliche Nachricht zur Kündigung"
    },
    "call": {
      "type": "boolean",
      "description": "Wahr, wenn der Kunde noch einmal angerufen werden möchte"
    },
    "reason": {
      "type": "integer",
      "description": "ID des Kündigungsgrundes"
    }
  }
}

Responses

Format

application/json

Beschreibung

Wenn kein Zugriff zu diesem Vertrag gewährt wird

messagestring

Content-Type: application/json

{
  "message": "string"
}

{
  "title": "Message",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

Nutzungsbeispiele

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"contract":123,"domains":[{"domain":"string","transfer":true,"transit":true,"cancellationDate":123}],"message":"string","call":true,"reason":123}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v1/cancellations

Kündigung einleiten

Request​

Request-Bodyrequired

Responses​

No Content204

Forbidden403

Nutzungsbeispiele​

Auf dieser Seite

Request

Responses

Nutzungsbeispiele