Skip to main content
Node.js

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
  • The name of the property
  • Must be unique within its type (chat/ticket)
Example:

"Workspace"

type
enum<string>
required
  • The type the property belongs to
Available options:
chat,
ticket
Example:

"ticket"

kind
enum<string>
required
  • The value kind of the property
  • dropdown is single-select, picklist is multi-select
Available options:
text,
date,
file,
dropdown,
picklist
Example:

"dropdown"

section
string
  • The name of the section to place the property under
  • Created automatically if it does not exist
Example:

"Issue Details"

mandatory
boolean
  • Whether the property is mandatory
  • Supported only for ticket properties; rejected for chat properties
  • Defaults to false
Example:

false

options
string[]
  • The initial option labels
  • Required (at least one non-empty label) for dropdown and picklist kinds
  • Not allowed for other kinds
Example:

Response

200 OK

success
boolean
Example:

true

message
string
Example:

"Custom property created"

data
object