Neues Support-Ticket

POST/tickets/

API version

v1

Request method

POST

Operation ID

createSupportTicket

---

Erstellt ein neues Support-Ticket

Request

Responses

Format

application/json

Description

Das neu erstellte Ticket

Schema documentation

• uidinteger

  required
• subjectstring

  required
• messagestring

  required
• createdAtstring (datetime)

  required
• updatedAtstring (datetime)

  required
• statusstring (one of: open, in-progress, feedback, information, answered, done)

  required
• publicStatusstring (one of: open, in-progress, feedback, information, answered, done)

  required
• authorobject

  required
  • namestring

    required
  • emailstring (email)

    required
  • telephonestring

    required
  • isMittwaldAuthorboolean

    required
• accountobject
  • uidinteger

    required
  • namestring

    required
• customerobject
  • customernumberinteger

    required
• answersCountinteger

  required
• filesarray of string (uuid)
  • Array[
  • *string (uuid)
  ]

Example

{
  "uid": 123,
  "subject": "string",
  "message": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "status": "open",
  "publicStatus": "open",
  "author": {
    "name": "string",
    "email": "email@mittwald.example",
    "telephone": "string",
    "isMittwaldAuthor": true
  },
  "account": {
    "uid": 123,
    "name": "string"
  },
  "customer": {
    "customernumber": 123
  },
  "answersCount": 123,
  "files": [
    "f0f86186-0a5a-45b2-aa33-502777496347"
  ]
}

JSON Schema

{
  "title": "Ticket",
  "required": [
    "answersCount",
    "author",
    "createdAt",
    "updatedAt",
    "message",
    "status",
    "publicStatus",
    "subject",
    "uid"
  ],
  "type": "object",
  "properties": {
    "uid": {
      "type": "integer"
    },
    "subject": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "status": {
      "title": "TicketStatus",
      "type": "string",
      "enum": [
        "open",
        "in-progress",
        "feedback",
        "information",
        "answered",
        "done"
      ]
    },
    "publicStatus": {
      "title": "TicketStatus",
      "type": "string",
      "enum": [
        "open",
        "in-progress",
        "feedback",
        "information",
        "answered",
        "done"
      ]
    },
    "author": {
      "required": [
        "email",
        "name",
        "telephone",
        "isMittwaldAuthor"
      ],
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string",
          "format": "email"
        },
        "telephone": {
          "type": "string"
        },
        "isMittwaldAuthor": {
          "type": "boolean"
        }
      }
    },
    "account": {
      "required": [
        "name",
        "uid"
      ],
      "type": "object",
      "properties": {
        "uid": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "customer": {
      "required": [
        "customernumber"
      ],
      "type": "object",
      "properties": {
        "customernumber": {
          "type": "integer"
        }
      }
    },
    "answersCount": {
      "type": "integer"
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"subject":"string","message":"string","author":{"name":"string","email":"email@mittwald.example","telephone":"string","notify":true},"account":{"name":"string"},"customer":{"customernumber":123},"files":[{"id":"f0f86186-0a5a-45b2-aa33-502777496347","type":"string","name":"string"}]}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v1/tickets