CreateTicket - TCN API

Public Method to create a ticket.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

CreateTicketReq - Request for CreateTicket

due_date

string <date-time>

due_date

optional

ticket due date

Examples:

1s1.000340012s

title

string

title

optional

title of the ticket to be created.

description

string

description

optional

description of the ticket

metadata

array[object (Metadata) {2}]

metadata

optional

A list of conversation context meatadatgit stata

name

string

name

optional

value

string

value

optional

ticket_skills

array[object (Skills) {2}]

ticket_skills

deprecated

A list of skills assotiated with a ticket

skill_id

string

skill_id

deprecated

is_preferred

boolean

is_preferred

deprecated

Mandatory = 0, Preferred = 1

ticket_sla

array[object (Sla) {4}]

ticket_sla

optional

A list of sla assotiated with a ticket

sla_duration

object (Duration)

sla_duration

optional

condition_sid

integer <int64> | string

condition_sid

optional

sla_sid

integer <int64> | string

sla_sid

optional

sla_min

integer <int64> | string

sla_min

optional

assign_self

boolean

assign_self

optional

assign_other

string

assign_other

deprecated

ticket_action

array[null (TicketAction) {3}]

ticket_action

optional

object

email_context

optional

object

sms_context

optional

object

voice_context

optional

project_sid

integer <int64> | string

project_sid

optional

the enabled project sid. project must have been enabled/imported from omni.project.project_sid to tickets_db.ticket_project.project_sid

status

integer <int64> | string

status

optional

Status - Ticket status : 1 open, 2 doing, 3 close etc

ticket_assignee

array[string]

ticket_assignee

optional

assignee list

contact_entry_id

integer <int64> | string

contact_entry_id

optional

Example

{
    "due_date": "1s",
    "title": "string",
    "description": "string",
    "metadata": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "ticket_skills": [
        {
            "skill_id": "string",
            "is_preferred": true
        }
    ],
    "ticket_sla": [
        {
            "sla_duration": {
                "scale": "TIME_SCALE_MINUTE",
                "value": 0
            },
            "condition_sid": 0,
            "sla_sid": 0,
            "sla_min": 0
        }
    ],
    "assign_self": true,
    "assign_other": "string",
    "ticket_action": [
        {
            "email_context": {
                "contact_name": "string",
                "to_email": "string",
                "from_email": "string"
            }
        }
    ],
    "project_sid": 0,
    "status": 0,
    "ticket_assignee": [
        "string"
    ],
    "contact_entry_id": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

CreateTicketRes - Response from CreateTicket BE API

ticket

object (Ticket)

ticket

optional

Returns the created ticket row in the response

created_by_date

string <date-time>

created_by_date

optional

The created Date of the Ticket Object

Examples:

1s1.000340012s

due_date

string <date-time>

due_date

deprecated

due-date

Examples:

1s1.000340012s

ticket_status

enum<string>

ticket_status

optional

Status of the ticket - NEW,OPEN,CLOSED

Allowed values:

TICKET_STATUS_NEWTICKET_STATUS_OPENTICKET_STATUS_CLOSE

project_title

string

project_title

optional

project_title

ticket_code

string

ticket_code

optional

A globally distributable, custom sequence generated per-project-per-month for a ticket row.

title

string

title

optional

The title of the ticket

description

string

description

optional

The description of the ticket

org_id

string

org_id

optional

The org where the created was created

created_by_id

string

created_by_id

optional

The userId (uuid) who created the ticket

created_by_name

string

created_by_name

optional

The created_by_name from omni.project

assignee_list

string

assignee_list

deprecated

A list of users assigned to this ticket. note: bound to re-factor later.

metadata

array[object (Metadata) {2}]

metadata

optional

A list of conversation context meatadata

ticket_skills

array[object (Skills) {2}]

ticket_skills

deprecated

A list of skills assotiated with a ticket

ticket_sla

array[object (Sla) {4}]

ticket_sla

optional

A list of sla assotiated with a ticket

assignee

string

assignee

optional

To be deprecated

ticket_action

array[null (TicketAction) {3}]

ticket_action

optional

A set of Action associated with a Project

ticket_sid

integer <int64> | string

ticket_sid

deprecated

The snowflake id of a ticket row

project_sid

integer <int64> | string

project_sid

optional

The imported/enabled ticket_project project_sid from omni.project

status

integer <int64> | string

status

optional

Status - Ticket status : 1 open, 2 doing, 3 close etc

ticket_assignee

array[string]

ticket_assignee

optional

assignee list

ticket_participant

array[string]

ticket_participant

optional

participant list - Any user who participates in the ticket life cycle

Example

{
    "ticket": {
        "created_by_date": "1s",
        "due_date": "1s",
        "ticket_status": "TICKET_STATUS_NEW",
        "project_title": "string",
        "ticket_code": "string",
        "title": "string",
        "description": "string",
        "org_id": "string",
        "created_by_id": "string",
        "created_by_name": "string",
        "assignee_list": "string",
        "metadata": [
            {
                "name": "string",
                "value": "string"
            }
        ],
        "ticket_skills": [
            {
                "skill_id": "string",
                "is_preferred": true
            }
        ],
        "ticket_sla": [
            {
                "sla_duration": {
                    "scale": "TIME_SCALE_MINUTE",
                    "value": 0
                },
                "condition_sid": 0,
                "sla_sid": 0,
                "sla_min": 0
            }
        ],
        "assignee": "string",
        "ticket_action": [
            {
                "email_context": {
                    "contact_name": "string",
                    "to_email": "string",
                    "from_email": "string"
                }
            }
        ],
        "ticket_sid": 0,
        "project_sid": 0,
        "status": 0,
        "ticket_assignee": [
            "string"
        ],
        "ticket_participant": [
            "string"
        ]
    }
}

🔴500Server Error