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.

Path Parameters

property_id
string
required

The property_id (e.g. property-xxxx) or the property_name of the custom property

Query Parameters

type
enum<string>

Specifies whether to resolve the chat or the ticket property when the same name exists under both

Available options:
chat,
ticket

Body

application/json
name
string
  • The new name of the property
  • Must be unique within its type
Example:

"Workspace ID"

section
string
  • The name of the section to move the property to
  • 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
Example:

true

Response

200 OK

success
boolean
Example:

true

message
string
Example:

"Custom property updated"

data
object