Send Array of Custom Field Values

Send an array of values for different custom fields.
HTTP Method
URL
Requires Auth
POST
/api/v1/livechat/custom.fields
no
Body Parameters
Key
Example Value
Description
token*
iNKE8a6k6cjbqWhWd
The visitor token.
customFields*
"customFields": [{ ... }] }
The object in which you must enter the custom field information.
key*
address
The custom field.
value*
Rocket.Chat Avenue
The value you want to set for the custom field.
overwrite*
true
Overwrite the value of the custom field.
Example Call
curl -X POST \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/livechat/custom.fields \
     -d '{"token": "iNKE8a6k6cjbqWhWd", 
     "customFields": [{
          "key": "address", 
          "value": "Rocket.Chat Avenue", 
          "overwrite": true}]}'
Example Response
{
  "fields": [
    {
      "Key": "address",
      "value": "Rocket.Chat Avenue",
      "overwrite": true
    }
  ],
  "success": true
}
Change Log
Version
Description
0.70.0
Added

HTTP Method	URL	Requires Auth
`POST`	`/api/v1/livechat/custom.fields`	`no`

Key	Example Value	Description
`token*`	`iNKE8a6k6cjbqWhWd`	The visitor token.
`customFields*`	`"customFields": [{ ... }] }`	The object in which you must enter the custom field information.
`key*`	`address`	The custom field.
`value*`	`Rocket.Chat Avenue`	The value you want to set for the custom field.
`overwrite*`	`true`	Overwrite the value of the custom field.

Version	Description
0.70.0	Added

Last modified 5d ago