Update an interlocutor

🚧

Private API key needed

This endpoint can only be used with your private API key, available in the API tab of your bot settings.

Update interlocutor attributes.

Note that the userID can't be updated.

Request

Attribute

Required

Type

Description

type

string

must be interlocutor

userID

string

your ID for this interlocutor (0 < length < 100)

firstName

string

interlocutor's first name

lastName

string

interlocutor's last name

email

string

interlocutor's email

phoneNumber

string

interlocutors' phone number

customAttributes

object

custom attributes (keys must only contain letters, digits and underscores)

{
    "type": "interlocutor",
    "id": "5b29016e24acbe58c292bbad",
    "userID": "123456",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "customAttributes": {
        "age": "29"
    }
}

Response

At the moment this endpoint does not return anything.

Language