Get Custom Field Information
    • Dark
      Light
    • PDF

    Get Custom Field Information

    • Dark
      Light
    • PDF

    Article summary

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

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

    Changelog

    VersionDescription
    2.4.0Added
    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

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

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.