Send Custom Field Value

Prev Next
Post
/api/v1/livechat/custom.field

Send the value for a custom field.

Changelog

Version Description
0.70.0 Added
Body parameters
Example 1
{
  "token": "iNKE8a6k6cjbqWhWd",
  "key": "address",
  "value": "Rocket.Chat Avenue",
  "overwrite": true
}
object
token
string Required

The visitor token.

key
string Required

The custom field.

value
string Required

The value you want to set for the custom field.

overwrite
boolean Required

Overwrite the value of the custom field.

Responses
200

OK

Success Example
{
  "field": {
    "key": "address",
    "value": "Rocket.Chat Avenue",
    "overwrite": true
  },
  "success": true
}
Expand All
object
field
object
key
string
value
string
overwrite
boolean
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'token' [invalid-params]",
  "errorType": "invalid-params"
}
Example 2
{
  "success": false,
  "error": "must have required property 'key' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string