URL : v3/api/post-form-group
Method : POST
Query Parameters : None
Body Parameters :
| Parameter | Type | Possible values | Optional/Required | Description |
| name | string | Required | Name of the form group | |
| form-fields | array | Array of objects | Required | Form fields which are updated or newly created.
Please read below for detailed explanation |
| help_topic_ids | array | Optional | array of help topic ids | |
| department_ids | array | Optional | array if department ids | |
| id | array | Required | Id of the form field. It will be null, if form is getting created and non-null if form is getting updated |
//form fields is an array of objects as shown below. So if a field is updated it is going to send that field with previous id but if a field is newly created, id will be sent as null. So not all fields are required to sent but just the changed one
"form_fields":[
{
"id":1,//null in case of a new field created
"title":"title",
"pattern":"",//any regex pattern
"sort_order":1,
"type":"email",
"required_for_agent":1,
"required_for_user":1,
"display_for_agent":1,
"display_for_user":1,
"default":1,
"media_option":"0",
"api_endpoint":null,
"labels_for_agent":[
{
"id":1,//null if a new field is added
"language":"en",
"label":"test label"
}
],
"labels_for_user":[
{
"id":1,//null if a new field is added
"language":"en",
"label":"test label"
}
"labels_for_validation":[
{
"id":1,//null if a new field is added
"language":"en",
"label":"test label"
}
],
"options":[
{
"id":null,
"labels":[//option labels
{
"id":1,//null if a new field is added
"language":"en",
"label":"test label"
}
],
"nodes":[]//in case of nested fields add the
same document as above here
}]
}]