Get Custom Field Information
Get details about a specific custom field.
HTTP Method | URL | Requires Auth |
---|---|---|
GET | /api/v1/livechat/custom-fields/:_id |
Permission required:
view-l-room
Key | Example Value | Description |
---|---|---|
_id * | address | The custom field ID. |
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/livechat/custom-fields/address
{
"customField": {
"_id": "address",
"label": "address",
"scope": "visitor",
"visibility": "visible",
"regexp": "",
"searchable": true,
"type": "input",
"required": false,
"defaultValue": "",
"options": "",
"public": true,
"_updatedAt": "2023-10-30T13:43:09.408Z",
"id": "address"
},
"success": true
}
Version | Description |
---|---|
2.4.0 | Added |
Last modified 6d ago