AlphaAlpha Docs

Public Support Portal

Public support portal endpoints (no authentication)

Get available ticket categories for the public form

GET
/public/support/{tenantCode}/settings/categories
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/public/support/string/settings/categories"
{
  "categories": [
    {
      "active": true,
      "color": "string",
      "isActive": true,
      "name": "string"
    }
  ],
  "id": "string",
  "tenantId": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Create a ticket from the public support portal

POST
/public/support/{tenantCode}/tickets
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/public/support/string/tickets" \  -F data="{\n  \"description\": \"string\",\n  \"email\": \"string\",\n  \"name\": \"string\",\n  \"subject\": \"string\"\n}"
{
  "message": "string",
  "requiresVerification": true,
  "ticketId": "string",
  "ticketNumber": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Verify email for a public ticket

GET
/public/support/{tenantCode}/tickets/verify
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string

Query Parameters

token*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/public/support/string/tickets/verify?token=string"
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "canReply": true,
  "category": "string",
  "contactName": "string",
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "elapsedMinutes": 0,
  "id": "string",
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}