Add Custom Fields to Website Chat Window

Description

You can use this API to add custom fields to the chat window on your website.

URL

Copiedhttps://salesiq.zoho.com/api/v2/{screen name}/apps/{app id}/website/components/fields

Example

Copiedhttps://salesiq.zoho.com/api/v2/dcm_01/apps/80000000007001/website/components/chat/fields

Payload

Copied{
"name": "Age",
  "hint": "Enter your age",
"is_mandatory": "true",
"type": "text"
}

Success Response

Copied{
  "url": "/api/v2/zylker-inc/apps/80000000007001/website/components/chat/fields",
  "object": "fields",
  "data": [
    {
      "name": "Name",
      "visibility": "3",
      "maxlength": "30",
      "is_enabled": "true",
      "hint": "Enter your name",
      "index": 0,
      "is_mandatory": "false",
      "type": "text",
      "is_predefined": "true"
    },
    {
      "name": "Email Address",
      "visibility": "3",
      "maxlength": "30",
      "is_enabled": "true",
      "hint": "Enter your email",
      "index": 1,
      "is_mandatory": "false",
      "type": "text",
      "is_predefined": "true"
    },
    {
      "name": "Phone",
      "visibility": "3",
      "maxlength": "30",
      "is_enabled": "true",
      "hint": "Enter your phone number",
      "index": 2,
      "is_mandatory": "false",
      "type": "text",
      "is_predefined": "true"
    },
    {
      "name": "Age",
      "visibility": "3",
      "maxlength": "30",
      "is_enabled": "true",
      "hint": "Enter your age",
      "index": 3,
      "is_mandatory": "true",
      "type": "text",
      "is_predefined": "false"
    }
  ]
}