send-a-livechat-custom-field.md

Send Custom Field Value

Send the value for a custom field.

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

Body Parameters

Key	Example Value	Description
token*	iNKE8a6k6cjbqWhWd	The visitor token.
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.field \
    -d '{"token": "iNKE8a6k6cjbqWhWd", 
         "key": "address", 
         "value": "Rocket.Chat Avenue", 
         "overwrite": true}'

Example Response

{
  "field": {
    "key": "address",
    "value": "Rocket.Chat Avenue",
    "overwrite": true
  },
  "success": true
}

Change Log

Version	Description
0.70.0	Added