Get Custom Field Information

Prev Next
Get
/api/v1/livechat/custom-fields/{_id}

Get details about a specific custom field. Permission required: view-l-room

Changelog

Version Description
2.4.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Path parameters
_id
stringRequired

The custom field ID.

Exampleaddress
Responses
200

OK

Success Example
{
  "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
}
Expand All
object
customField
object
_id
string
label
string
scope
string
visibility
string
regexp
string
searchable
boolean
type
string
required
boolean
defaultValue
string
options
string
public
boolean
_updatedAt
string
id
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string