Skip to main content

Add or manage user data and events via APIs

API Integration for User Data and Events​

You can easily add or manage user data and events in Yellow.ai through our APIs. Keep your user-related data seamlessly synchronized with your entire tech stack.

Summary of User APIs​

GoalEndpointMethodDoc Link
Create userhttps://{host}/cdp/api/v1/user?bot={botId}POSTAdd user API
Update userhttps://{host}/cdp/api/v1/user/{userId}?bot={{botId}}PUTUpdate user API
Get user by userIdhttps://{host}/cdp/api/v1/user/123456?properties=email,tags&bot={botId}&userId=trueGETGet user details API
Get all usershttps://{host}/cdp/api/v1/user?bot={botId}&offset=0&limit={}GETGet user details API
Delete userhttps://{host}/cdp/api/v1/user/{userId}?bot={botId}&offset={}&limit={}DELETEDelete user API

For more details, refer to our User Management API Reference Documentation.