Create Ticket

Requires Premium or Enterprise subscription

Overview

Create a new support ticket. The author does not need to be a workspace member unless the category requires it. Author Information:

authorUserId is required
authorAvatarUrl is required
authorUsername and authorDisplayName are optional but recommended for users not in the database

Request Body

string

required

Ticket subject/title

string

required

Category ID (must exist in workspace configuration)

string

required

Initial message content

string

Ticket priority: low, medium, high, urgent (default: medium)

integer

required

UserId of the ticket creator

string

Username of the author (used if not in database)

string

Display name of the author (used if not in database)

string

required

Avatar URL of the ticket author

Response

boolean

Whether the request was successful

object

Show properties

string

The generated ticket ID

string

MongoDB document ID

string

The workspace ID

string

Ticket subject

string

Category ID

string

Assigned department ID

string

Ticket status (always “open” for new tickets)

string

Ticket priority

object

Author information including UserId, Username, DisplayName, and AvatarUrl

string

Creation timestamp (ISO 8601)

string

Last update timestamp (ISO 8601)

Example

curl -X POST https://api.series.hr/tickets/create \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Help with ranking",
    "category": "support",
    "message": "I need help getting ranked in the group",
    "priority": "medium",
    "authorUserId": 123456789,
    "authorUsername": "player123",
    "authorDisplayName": "Player Name",
    "authorAvatarUrl": "https://tr.rbxcdn.com/avatar-url"
  }'

const response = await fetch('https://api.series.hr/tickets/create', {
  method: 'POST',
  headers: {
    'apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    subject: 'Help with ranking',
    category: 'support',
    message: 'I need help getting ranked in the group',
    priority: 'medium',
    authorUserId: 123456789,
    authorUsername: 'player123',
    authorDisplayName: 'Player Name',
    authorAvatarUrl: 'https://tr.rbxcdn.com/avatar-url'
  })
});

const data = await response.json();

local HttpService = game:GetService("HttpService")

local response = HttpService:RequestAsync({
    Url = "https://api.series.hr/tickets/create",
    Method = "POST",
    Headers = {
        ["apikey"] = "YOUR_API_KEY",
        ["Content-Type"] = "application/json"
    },
    Body = HttpService:JSONEncode({
        subject = "Help with ranking",
        category = "support",
        message = "I need help getting ranked in the group",
        priority = "medium",
        authorUserId = 123456789,
        authorUsername = "player123",
        authorDisplayName = "Player Name",
        authorAvatarUrl = "https://tr.rbxcdn.com/avatar-url"
    })
})

local data = HttpService:JSONDecode(response.Body)

import requests

response = requests.post(
    'https://api.series.hr/tickets/create',
    headers={
        'apikey': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'subject': 'Help with ranking',
        'category': 'support',
        'message': 'I need help getting ranked in the group',
        'priority': 'medium',
        'authorUserId': 123456789,
        'authorUsername': 'player123',
        'authorDisplayName': 'Player Name',
        'authorAvatarUrl': 'https://tr.rbxcdn.com/avatar-url'
    }
)

data = response.json()

Response Example

{
  "success": true,
  "data": {
    "TicketId": "TICKET-1234567890-ABCD",
    "_id": "...",
    "WorkspaceId": "a7d5339a-5531-4336-99c6-6f3249c9ac20",
    "Subject": "Help with ranking",
    "Category": "support",
    "Department": "support-dept",
    "Status": "open",
    "Priority": "medium",
    "Author": {
      "UserId": 123456789,
      "Username": "player123",
      "DisplayName": "Player Name",
      "AvatarUrl": "https://..."
    },
    "CreatedAt": "2025-01-15T10:30:00.000Z",
    "UpdatedAt": "2025-01-15T10:30:00.000Z"
  }
}

Error Responses

400 - Validation Error

{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error: Subject is required"
  }
}

400 - Missing authorAvatarUrl

{
  "success": false,
  "error": {
    "code": 400,
    "message": "authorAvatarUrl is required"
  }
}

403 - Premium Required

{
  "success": false,
  "error": {
    "code": 403,
    "message": "Tickets module requires a Premium or Enterprise subscription"
  }
}

403 - Module Not Enabled

{
  "success": false,
  "error": {
    "code": 403,
    "message": "Tickets module is not enabled for this workspace"
  }
}

403 - Membership Required

{
  "success": false,
  "error": {
    "code": 403,
    "message": "Workspace membership is required to create tickets in this category"
  }
}

400 - Max Tickets Reached

{
  "success": false,
  "error": {
    "code": 400,
    "message": "You can only have 5 open tickets in this category"
  }
}

Rate Limit

25 requests per second per API key

Introduction & basics

Basic

Activity

Activity Credits

Sessions

Attendance

Game Moderation

Applications

Members

Time-Off

Hotel

Food & Beverage

Ranking

Flights

Tickets

Overview

Request Body

Response

Example

Response Example

Error Responses

Rate Limit

​Overview

​Request Body

​Response

​Example

​Response Example

​Error Responses

​Rate Limit

Overview

Request Body

Response

Example

Response Example

Error Responses

Rate Limit