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
Create a form
curl --request POST \
--url https://platform.thena.ai/v1/forms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-org-id: <api-key>' \
--data '{
"name": "<string>",
"description": "<string>",
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [
{}
]
}
],
"forVendor": true,
"forUser": true,
"teamId": "<string>"
}
],
"fields": [
{
"field": "<string>",
"defaultValue": {},
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true,
"editableByCustomer": true
}
],
"isActive": true,
"channels": [
"<string>"
],
"teamId": "<string>"
}'
{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"fields": [
{
"field": "<string>",
"defaultValue": {},
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true,
"editableByCustomer": true
}
],
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [
{}
]
}
],
"forVendor": true,
"forUser": true,
"teamId": "<string>"
}
],
"version": 123,
"isActive": true,
"default": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"channels": [
"<string>"
],
"teamId": "<string>"
},
"status": true,
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
Authorizations
Enter JWT bearer token
Enter organization ID
Body
The name of the form
The description of the form
Conditions of the form
The ID of the trigger field
The value of the trigger field
The type of the condition
Indicates if the form is for vendor
Indicates if the form is for user
The ID of the team
Fields of the form
The field
Indicates if the field is editable by customer
The default value
Indicates if the field is mandatory on creation
Indicates if the field is mandatory on close
Indicates if the field is visible to customer
Indicates if the form is active
Channels of the form
The ID of the team
Response
The field
Indicates if the field is editable by customer
The default value
Indicates if the field is mandatory on creation
Indicates if the field is mandatory on close
Indicates if the field is visible to customer
The ID of the trigger field
The value of the trigger field
The type of the condition
Indicates if the form is for vendor
Indicates if the form is for user
The ID of the team
curl --request POST \
--url https://platform.thena.ai/v1/forms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-org-id: <api-key>' \
--data '{
"name": "<string>",
"description": "<string>",
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [
{}
]
}
],
"forVendor": true,
"forUser": true,
"teamId": "<string>"
}
],
"fields": [
{
"field": "<string>",
"defaultValue": {},
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true,
"editableByCustomer": true
}
],
"isActive": true,
"channels": [
"<string>"
],
"teamId": "<string>"
}'
{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"fields": [
{
"field": "<string>",
"defaultValue": {},
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true,
"editableByCustomer": true
}
],
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [
{}
]
}
],
"forVendor": true,
"forUser": true,
"teamId": "<string>"
}
],
"version": 123,
"isActive": true,
"default": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"channels": [
"<string>"
],
"teamId": "<string>"
},
"status": true,
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}