POST
/
v1
/
custom-field
curl --request POST \
  --url https://platform.thena.ai/v1/custom-field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-org-id: <api-key>' \
  --data '{
  "isActive": true,
  "description": "<string>",
  "name": "<string>",
  "source": "<string>",
  "fieldType": "<string>",
  "options": [
    "<string>"
  ],
  "metadata": {},
  "placeholderText": "<string>",
  "hintText": "<string>",
  "mandatoryOnClose": true,
  "mandatoryOnCreation": true,
  "visibleToCustomer": true,
  "editableByCustomer": true,
  "autoAddToAllForms": true,
  "defaultValue": "<string>",
  "teamId": "<string>",
  "lookup": "<string>"
}'
{
  "data": {
    "name": "<string>",
    "uid": "<string>",
    "organizationId": "<string>",
    "source": "ticket",
    "fieldType": "single_line",
    "options": [
      "<string>"
    ],
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isActive": true,
    "teamId": "<string>",
    "autoAddToAllForms": true,
    "hintText": "<string>",
    "placeholderText": "<string>",
    "mandatoryOnCreation": true,
    "mandatoryOnClose": true,
    "visibleToCustomer": true,
    "editableByCustomer": true,
    "defaultValue": "<string>"
  },
  "status": true,
  "message": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Enter JWT bearer token

​
x-org-id
string
header
required

Enter organization ID

Body

application/json
​
name
string
required

The name of the custom field

​
source
string
required

The source of the custom field

​
fieldType
string
required

The type of the custom field

​
isActive
boolean

Whether the custom field is active

​
description
string

The description of the custom field

​
options
string[]

The options of the custom field

​
metadata
object

The metadata of the custom field

​
placeholderText
string

The placeholder text of the custom field

​
hintText
string

The hint text of the custom field

​
mandatoryOnClose
boolean

Whether the custom field is mandatory on close

​
mandatoryOnCreation
boolean

Whether the custom field is mandatory on creation

​
visibleToCustomer
boolean

Whether the custom field is visible to customer

​
editableByCustomer
boolean

Whether the custom field is editable by customer

​
autoAddToAllForms
boolean

Whether the custom field is auto added to all forms

​
defaultValue
string

The default value of the custom field

​
teamId
string

The team id of the custom field

​
lookup
string

The lookup object id or thena entity name

Response

201
application/json
Operation successful
​
data
object
required
​
status
boolean
required
​
message
string
required
​
timestamp
string
required