Vertrag - Vertrag anlegen

POST/gdpr/contracts/

API version

v1

Request method

POST

Operation ID

createGDPRContract

---

Legt einen Vertrag mit den angegebenen Daten an

Request

Responses

Format

application/json

Beschreibung

Vertrag erfolgreich angelegt

Schema-Dokumentation

• creationDatestring (datetime)

  Das Erstelldatum im UTC Format

• tomobject
• clientobject
• recipientobject
• htmlstring

  Der Inhalt des Vertrages in Form von HTML

• confirmationDatestring (datetime)

  Das Datum (im UTC Format), zu dem der Vertrag angenommen wurde

• sentDatestring (datetime)

  Das Datum (im UTC Format), zu dem der Vertrag zuletzt via E-Mail versendet wurde

• reminderSentDatestring (datetime)

  Das Datum (im UTC Format), zu dem automatisiert eine Erinnerungsmail versendet wurde

• isPartnerContractboolean
• contractSignerstring

  Der vollständige Name des Vertragsunterzeichners

Beispiel

Content-Type: application/json

{
  "creationDate": "string",
  "tom": {},
  "client": {},
  "recipient": {},
  "html": "string",
  "confirmationDate": "string",
  "sentDate": "string",
  "reminderSentDate": "string",
  "isPartnerContract": true,
  "contractSigner": "string"
}

JSON Schema

{
  "title": "GDPRContract",
  "type": "object",
  "properties": {
    "creationDate": {
      "type": "string",
      "description": "Das Erstelldatum im UTC Format",
      "format": "datetime"
    },
    "tom": {
      "type": "object",
      "properties": {}
    },
    "client": {
      "type": "object",
      "properties": {}
    },
    "recipient": {
      "type": "object",
      "properties": {}
    },
    "html": {
      "type": "string",
      "description": "Der Inhalt des Vertrages in Form von HTML"
    },
    "confirmationDate": {
      "type": "string",
      "description": "Das Datum (im UTC Format), zu dem der Vertrag angenommen wurde",
      "format": "datetime"
    },
    "sentDate": {
      "type": "string",
      "description": "Das Datum (im UTC Format), zu dem der Vertrag zuletzt via E-Mail versendet wurde",
      "format": "datetime"
    },
    "reminderSentDate": {
      "type": "string",
      "description": "Das Datum (im UTC Format), zu dem automatisiert eine Erinnerungsmail versendet wurde",
      "format": "datetime"
    },
    "isPartnerContract": {
      "type": "boolean"
    },
    "contractSigner": {
      "type": "string",
      "description": "Der vollständige Name des Vertragsunterzeichners"
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"html":"string","tom":"string","client":"string","recipient":"string","isPartnerContract":true}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v1/gdpr/contracts