Custom fields
Update custom fields
Introduction
- API Reference
- Platform
- Platform APIs
- Login & sign up
- Organizations
- SLA duration
- Users
- Teams
- Tickets
- Comments & reactions
- Custom fields
- Forms
- Draft tickets
- Accounts & contacts
- Custom objects
- Workflows
- SLA
- Storage
- Notifications
Custom fields
Update custom fields
PATCH
/
v1
/
custom-field
curl --request PATCH \
--url https://platform.thena.ai/v1/custom-field \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-org-id: <api-key>' \
--data '{
"fields": [
{
"fieldId": "<string>",
"version": 123,
"updates": {
"name": "<string>",
"description": "<string>",
"isActive": true,
"options": [
"<string>"
],
"placeholderText": "<string>",
"hintText": "<string>",
"defaultValue": "<string>",
"regexForValidation": "<string>",
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true,
"editableByCustomer": true,
"autoAddToAllForms": true
}
}
]
}'
{
"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
Enter JWT bearer token
Enter organization ID
Body
application/json
Response
200
application/json
Operation successful
Available options:
ticket
, account
, custom_object
, customer_contact
Available options:
single_line
, multi_line
, rich_text
, integer
, decimal
, currency
, date
, date_time
, time
, single_choice
, multi_choice
, radio_button
, checkbox
, email
, phone_number
, url
, ip_address
, regex
, password
, file_upload
, calculated
, lookup
, address
, coordinates
, rating
, toggle
, boolean
curl --request PATCH \
--url https://platform.thena.ai/v1/custom-field \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-org-id: <api-key>' \
--data '{
"fields": [
{
"fieldId": "<string>",
"version": 123,
"updates": {
"name": "<string>",
"description": "<string>",
"isActive": true,
"options": [
"<string>"
],
"placeholderText": "<string>",
"hintText": "<string>",
"defaultValue": "<string>",
"regexForValidation": "<string>",
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true,
"editableByCustomer": true,
"autoAddToAllForms": true
}
}
]
}'
{
"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"
}