Skip to content

Open a support ticket

POST
/tickets
curl --request POST \
--url https://api.nsin.ir/tickets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "subject": "example", "message": "example" }'

Send JSON for a text-only ticket, or multipart/form-data to attach images.

object
subject
required
string
message
required
string
Example generated
{
"subject": "example",
"message": "example"
}

The created ticket.

Media type application/json
object
id
integer
user_id
integer
subject
string
status

For example open or closed.

string
closed_at
string format: date-time
closed_by_user_id
integer
user_last_read_message_id
integer
staff_last_read_message_id
integer
messages

The thread. Populated when fetching a single ticket.

Array<object>
object
id
integer
ticket_id
integer
author_user_id
integer
author

The message author.

object
key
additional properties
any
body
string
is_staff

True when written by support staff.

boolean
attachments
Array<object>
object
id
integer
message_id
integer
original_name
string
content_type
string
size_bytes
integer
url

Where to download the attachment.

string
created_at
string format: date-time
created_at
string format: date-time
updated_at
string format: date-time
Example generated
{
"id": 1,
"user_id": 1,
"subject": "example",
"status": "example",
"closed_at": "2026-04-15T12:00:00Z",
"closed_by_user_id": 1,
"user_last_read_message_id": 1,
"staff_last_read_message_id": 1,
"messages": [
{
"id": 1,
"ticket_id": 1,
"author_user_id": 1,
"author": {},
"body": "example",
"is_staff": true,
"attachments": [
{
"id": 1,
"message_id": 1,
"original_name": "example",
"content_type": "example",
"size_bytes": 1,
"url": "example"
}
],
"created_at": "2026-04-15T12:00:00Z"
}
],
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}

Invalid body, or a missing/oversized subject or message.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Example
{
"error": "read-only API key"
}

Missing, malformed, revoked or expired API key — or the owning account is inactive.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example invalidKey
{
"error": "invalid API key"
}

The key is read-only and this endpoint is a write. Read-only keys may only issue GET, HEAD and OPTIONS.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example readOnly
{
"error": "read-only API key"
}

The key exceeded its request budget (300 requests per minute by default).

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example limited
{
"error": "rate limit exceeded"
}