Bot user
Bot_user - is the specific contact the bot is communicating with.
get
https://app.hightouch.ai
/api/bot/bot_users/
Get BotUsers
get
https://app.hightouch.ai
/api/bot/bot_users/:id/
Get BotUser
patch
https://app.hightouch.ai
/api/bot/bot_users/:id/
Update BotUser
Object store
Parameter | Type | Description |
name | string | User name |
phone | string | telepphone |
avatar_url | string | User avatar URL |
subscribe_to_bot | boolean | Whether the user is subscribed to the bot |
tags | array | Tags assigned to the user |
user_vars | object | An object of type dict containing user variables and their values (e.g, {'var1':'some text', 'var2': 15}). |
In order to set the value of a variable, you need to send a request with the following content:
{
"store": {
"user_vars": {
"goods":5
}
}
}
This will set the value of the "good" variable to 5.
In order to add a tag, you need to send a request:
{
"store": {
"tags": [{
"id": 13
} ]
}
}
In order to delete a tag, you need to send a request:
{
"store": {
"tags": []
}
}
post
https://app.hightouch.ai
/api/bot/bot_user/unsafe_create/
Create BotUser
Last modified 1yr ago