Docs
post

Create a new ticket for visitor

Allows an authenticated visitor to create a support ticket. Requires x-visitor-id header for authentication.

Internal Visitor API
Endpoint
/internal/visitors/tickets
Method
post
Plan Required
FREE
Authorization
Bearer Token required
Permissions
None
Content-Type
application/json

API Tester(Loading...)

Loading API token configuration...

Payload

Body Parameters

Content-Type: application/jsonrequired

Schema:

title

string
Issue with my account

description

string
I am unable to log in to my account. When I try to...

priority

string
MEDIUM

Response

200Created ticket

id

string
123456789

websiteId

number
1

visitorId

number
1

conversationId

number
1

title

string
Login issue with mobile app

description

string
User cannot login to the mobile app after recent u...

status

string
NEW

priority

string
MEDIUM

assigneeId

number
1

uniqueEmailAddress

string

languageCode

string
en

summary

string
Customer experiencing login issues with mobile app...

createdAt

string
2023-12-01T10:00:00Z

updatedAt

string
2023-12-01T15:30:00Z

website

object
Website information

visitor

object
Visitor information

assignee

object
Assigned user information

messages

array
Ticket messages

tags

array
technical-issue,mobile-app,urgent
201201 response
No response details available
400Bad request - Missing or invalid visitor ID header or invalid ticket data
No response details available
401Unauthorized - Invalid visitor token
No response details available

Expected Response

JSON
{
  "id": "123456789",
  "websiteId": 1,
  "visitorId": 1,
  "conversationId": 1,
  "title": "Login issue with mobile app",
  "description": "User cannot login to the mobile app after recent update",
  "status": "NEW",
  "priority": "MEDIUM",
  "assigneeId": 1,
  "uniqueEmailAddress": "[email protected]",
  "languageCode": "en",
  "summary": "Customer experiencing login issues with mobile app after update. Requires technical assistance with account access.",
  "createdAt": "2023-12-01T10:00:00Z",
  "updatedAt": "2023-12-01T15:30:00Z",
  "website": "https://mywebsite.com",
  "visitor": {},
  "assignee": {},
  "messages": "Hello, this is a test message",
  "tags": [
    "technical-issue",
    "mobile-app",
    "urgent"
  ]
}

API Access Token

Base URL

https://api.5chat.io