Description
Manage the storage of data associated with a user within your channel.The user cache stores unique information about each person who interacts with your conversational experience and can be used within your workflows to:
- Associate operational data, such as an order number, to a
user. - Allow the channel to know user properties before the conversation begins.
- Store information needed to query internal or external services from specific workflows.
- Defining reactions or executing a workflow before the user initiates the conversation (coming soon).
Get User Cache
Endpoint
Path Parameters
string
required
User’s phone number (without the
+ sign).Query Parameters
string
required
Identifier of the channel associated with the user.
Request Example
Response Example
The response may include any data previously stored in the user’s cache.Set user cache
Endpoint
Path Parameters
string
required
User’s phone number (without the
+ sign).Request Body
object
Object with the data that will be merged with the user’s current cache.
string
required
Identifier of the channel associated with the user.
Request Example
Response Example
Common Errors
400- Could not get or update the user’s status.401- Invalid or missing credentials.404- User or channel not found.200- Logic error when obtaining the cache (when status is “failed”).