# Returning.AI-dev ## Docs - [Getting Started](https://adss-uat-dev.returning.ai/getting-started.md): - Users [User directory and provisioning](https://adss-uat-dev.returning.ai/users/overview.md): - Messaging [Monitor and respond to community messages](https://adss-uat-dev.returning.ai/messaging/monitor-and-respond.md): - Gamification > Leaderboards [Leaderboards](https://adss-uat-dev.returning.ai/gamification/leaderboards/overview.md): - Gamification > Streaks & Mini Games [Mini-game State and History](https://adss-uat-dev.returning.ai/mini-games/state-and-history.md): - Gamification > Referral [Referral Program Integration](https://adss-uat-dev.returning.ai/docs/referral-program-integration.md): - Rewards & Redemptions [Store catalog to redemptions](https://adss-uat-dev.returning.ai/redemptions/overview.md): - Bulk Operations [Bulk user updates](https://adss-uat-dev.returning.ai/bulk-jobs/overview.md): - [Channels](https://adss-uat-dev.returning.ai/channels.md): - Channels [Iframe](https://adss-uat-dev.returning.ai/channels/iframe.md): - [Events](https://adss-uat-dev.returning.ai/events.md): - Events [Outgoing webhooks](https://adss-uat-dev.returning.ai/events/outgoing-webhooks.md): - Events > Outgoing webhooks [Encryption](https://adss-uat-dev.returning.ai/events/outgoing/encryption.md): - Events > Outgoing webhooks [User Joins Server](https://adss-uat-dev.returning.ai/events/outgoing/user-joins-server.md): - Events > Outgoing webhooks [User Visits server](https://adss-uat-dev.returning.ai/events/outgoing/user-visits-server.md): - Events > Outgoing webhooks [New Message Posted Anywhere](https://adss-uat-dev.returning.ai/events/outgoing/message-posted-anywhere.md): - Events > Outgoing webhooks [New Message Posted To channel ](https://adss-uat-dev.returning.ai/events/outgoing/message-posted-to-channel.md): - Events > Outgoing webhooks [Purchased Store Item ](https://adss-uat-dev.returning.ai/events/outgoing/purchased-store-item.md): - Events [Incoming webhooks](https://adss-uat-dev.returning.ai/events/incoming-webhooks.md): - Events > Incoming webhooks [API Keys & Encryption](https://adss-uat-dev.returning.ai/events/incoming/api-keys-and-encryption.md): - Events > Incoming webhooks [Send message into channels](https://adss-uat-dev.returning.ai/events/incoming/send-message.md): - Events > Incoming webhooks [Update Custom User Fields](https://adss-uat-dev.returning.ai/events/incoming/update-custom-user-fields.md): - Events > Incoming webhooks [Update In-game currency](https://adss-uat-dev.returning.ai/events/incoming/update-in-game-currency.md): - [Widgets](https://adss-uat-dev.returning.ai/widgets.md): - Widgets [Authenticated Widgets](https://adss-uat-dev.returning.ai/widgets/authenticated.md): - Widgets [Public widgets](https://adss-uat-dev.returning.ai/widgets/public.md): - Widgets [Channels](https://adss-uat-dev.returning.ai/widgets/channels.md): - Widgets [Leaderboard](https://adss-uat-dev.returning.ai/widgets/leaderboard.md): - Widgets [Milestone](https://adss-uat-dev.returning.ai/widgets/milestone.md): - Widgets [Socials](https://adss-uat-dev.returning.ai/widgets/socials.md): - Widgets [Store](https://adss-uat-dev.returning.ai/widgets/store.md): - Store [Store catalog](https://adss-uat-dev.returning.ai/store/overview.md): - Community [Community directory and appearance](https://adss-uat-dev.returning.ai/community/overview.md): - API Keys [API key lifecycle](https://adss-uat-dev.returning.ai/api-keys/overview.md): - User Fields [User field definitions and history](https://adss-uat-dev.returning.ai/user-fields/overview.md): ## API Docs - Users [Get Users with Filters](https://adss-uat-dev.returning.ai/users/search-users.md): ## What this endpoint does - Users [Create New User](https://adss-uat-dev.returning.ai/users/create-user.md): ## What this endpoint does - Users [Get User Data](https://adss-uat-dev.returning.ai/users/lookup-user.md): ## What this endpoint does - Users [Manage User Account](https://adss-uat-dev.returning.ai/users/update-user-status.md): ## What this endpoint does - Users [Get User Milestones](https://adss-uat-dev.returning.ai/users/get-milestones.md): ## What this endpoint does - Users [Update User Data, Identifier, And Roles](https://adss-uat-dev.returning.ai/users/update-user-data.md): ## What this endpoint does - Users [Update User XP and Currency](https://adss-uat-dev.returning.ai/users/update-xp-currency.md): ## What this endpoint does - Messaging [Get Messages](https://adss-uat-dev.returning.ai/messaging/get-messages.md): ## What this endpoint does - Messaging [Send Message](https://adss-uat-dev.returning.ai/messaging/send-message.md): ## What this endpoint does - Messaging [Reply Message](https://adss-uat-dev.returning.ai/messaging/reply-message.md): ## What this endpoint does - Messaging [React Message](https://adss-uat-dev.returning.ai/messaging/react-to-message.md): ## What this endpoint does - Messaging [Upload message images](https://adss-uat-dev.returning.ai/messaging/upload-image.md): ## What this endpoint does - Gamification > Leaderboards [List leaderboards with pagination](https://adss-uat-dev.returning.ai/gamification/leaderboards/list.md): ## What this endpoint does - Gamification > Leaderboards [Create a new leaderboard](https://adss-uat-dev.returning.ai/gamification/leaderboards/create.md): ## What this endpoint does - Gamification > Leaderboards [Update an existing leaderboard](https://adss-uat-dev.returning.ai/gamification/leaderboards/update.md): ## What this endpoint does - Gamification > Leaderboards [Get a single leaderboard by ID](https://adss-uat-dev.returning.ai/gamification/leaderboards/get.md): ## What this endpoint does - Gamification > Leaderboards [Delete a leaderboard](https://adss-uat-dev.returning.ai/gamification/leaderboards/delete.md): ## What this endpoint does - Gamification > Streaks & Mini Games [List user streak logs](https://adss-uat-dev.returning.ai/streaks/search-streak-logs.md): ## What this endpoint does - Gamification > Streaks & Mini Games [List mini-game logs by user email](https://adss-uat-dev.returning.ai/mini-games/get-user-logs.md): ## What this endpoint does - Gamification > Streaks & Mini Games [Get current mini-game and streak state](https://adss-uat-dev.returning.ai/mini-games/get-current-user-state.md): ## What this endpoint does - Gamification > Streaks & Mini Games [Update user spin-wheel information](https://adss-uat-dev.returning.ai/mini-games/update-user-wheel-state.md): ## What this endpoint does - Gamification > Referral [Get referral programs](https://adss-uat-dev.returning.ai/gamification/get-referral-programs.md): ## What this endpoint does - Gamification > Referral [Get user's referral summary](https://adss-uat-dev.returning.ai/gamification/get-user-referral-summary.md): ## What this endpoint does - Gamification > Rolling Data [Get Daily Calculation Data](https://adss-uat-dev.returning.ai/gamification/get-daily-calculation.md): ## What this endpoint does - Gamification > Rolling Data [Get Rolling Calculation Data](https://adss-uat-dev.returning.ai/gamification/get-rolling-calculation.md): ## What this endpoint does - Gamification [Get tier configuration](https://adss-uat-dev.returning.ai/gamification/get-tier-configuration.md): ## What this endpoint does - Gamification [Get daily user XP and coin changes](https://adss-uat-dev.returning.ai/gamification/get-user-daily-history.md): ## What this endpoint does - Gamification [Search user gamification logs](https://adss-uat-dev.returning.ai/gamification/search-logs.md): ## What this endpoint does - Gamification [Get user activity stats](https://adss-uat-dev.returning.ai/gamification/user-action-stats.md): ## What this endpoint does - Rewards & Redemptions [Update redemption order status or refund](https://adss-uat-dev.returning.ai/redemptions/update-order-status.md): ## What this endpoint does - Rewards & Redemptions [List redemption orders by user email](https://adss-uat-dev.returning.ai/redemptions/list-user-orders.md): ## What this endpoint does - Rewards & Redemptions [List redemption statuses](https://adss-uat-dev.returning.ai/redemptions/list-statuses.md): ## What this endpoint does - Rewards & Redemptions [Get redemption status by ID](https://adss-uat-dev.returning.ai/redemptions/get-status.md): ## What this endpoint does - Rewards & Redemptions [List redemption orders by community](https://adss-uat-dev.returning.ai/redemptions/list-community-orders.md): ## What this endpoint does - Rewards & Redemptions [Create redemption order status](https://adss-uat-dev.returning.ai/redemptions/create-status.md): ## What this endpoint does - Rewards & Redemptions [Get redemption order status history](https://adss-uat-dev.returning.ai/redemptions/get-order-status-history.md): ## What this endpoint does - Chart Analysis [Create Analysis](https://adss-uat-dev.returning.ai/chart-analysis/create-analysis.md): ## What this endpoint does - Chart Analysis [Get Analysis](https://adss-uat-dev.returning.ai/chart-analysis/get-analysis.md): ## What this endpoint does - Chart Analysis [Update Analysis](https://adss-uat-dev.returning.ai/chart-analysis/update-analysis.md): ## What this endpoint does - Chart Analysis [Delete Analysis](https://adss-uat-dev.returning.ai/chart-analysis/delete-analysis.md): ## What this endpoint does - Chart Analysis [List Analyses](https://adss-uat-dev.returning.ai/chart-analysis/list-channel-analyses.md): ## What this endpoint does - Chart Analysis [Append Drawings](https://adss-uat-dev.returning.ai/chart-analysis/append-drawings.md): ## What this endpoint does - Bulk Operations [List bulk update jobs](https://adss-uat-dev.returning.ai/bulk-jobs/list-jobs.md): ## What this endpoint does - Bulk Operations [Get bulk update job status](https://adss-uat-dev.returning.ai/bulk-jobs/get-job-status.md): ## What this endpoint does - Bulk Operations [Get bulk update job details](https://adss-uat-dev.returning.ai/bulk-jobs/get-job-details.md): ## What this endpoint does - Bulk Operations [Bulk update users from CSV](https://adss-uat-dev.returning.ai/bulk-jobs/update-users.md): ## What this endpoint does - Bulk Operations [Bulk update premium currency from CSV](https://adss-uat-dev.returning.ai/bulk-jobs/update-premium-currency.md): ## What this endpoint does - Channels [List integration channels](https://adss-uat-dev.returning.ai/channels/list-channels.md): ## What this endpoint does - Community Analytics [Get Loyalty Overview](https://adss-uat-dev.returning.ai/analytics/get-loyalty-overview.md): ## What this endpoint does - Community Analytics [Get Phone Verification Contacts](https://adss-uat-dev.returning.ai/analytics/get-phone-verification-contacts.md): ## What this endpoint does - Store > Purchase History [Update redemption instructions or voucher details](https://adss-uat-dev.returning.ai/store/purchase-history/update.md): ## What this endpoint does - Store > Categories [List Store categories](https://adss-uat-dev.returning.ai/store/categories/list.md): ## What this endpoint does - Store > Categories [Create Store category](https://adss-uat-dev.returning.ai/store/categories/create.md): ## What this endpoint does - Store > Categories [Get Store category by ID](https://adss-uat-dev.returning.ai/store/categories/get.md): ## What this endpoint does - Store > Categories [Update Store category](https://adss-uat-dev.returning.ai/store/categories/update.md): ## What this endpoint does - Store > Categories [Delete Store category](https://adss-uat-dev.returning.ai/store/categories/delete.md): ## What this endpoint does - Store > Products [List products](https://adss-uat-dev.returning.ai/store/products/list.md): ## What this endpoint does - Store > Products [Update products in bulk](https://adss-uat-dev.returning.ai/store/products/bulk-update.md): Updates up to 100 voucher products for the API-key community and returns the updated public product records. - Store > Products [Create products in bulk](https://adss-uat-dev.returning.ai/store/products/bulk-create.md): ## What this endpoint does - Store > Products [Create product with vouchers](https://adss-uat-dev.returning.ai/store/products/create.md): ## What this endpoint does - Store > Products [Read product](https://adss-uat-dev.returning.ai/store/products/get.md): ## What this endpoint does - Store > Products [Update product and append vouchers](https://adss-uat-dev.returning.ai/store/products/update.md): ## What this endpoint does - Store > Products [Delete product](https://adss-uat-dev.returning.ai/store/products/delete.md): ## What this endpoint does - Store > Redemption-transaction [Get redemption transaction detail](https://adss-uat-dev.returning.ai/store/redemption-transaction.md): ## What this endpoint does - Store [Get Store configuration](https://adss-uat-dev.returning.ai/store/configuration/get.md): ## What this endpoint does - Store [Update Store configuration](https://adss-uat-dev.returning.ai/store/configuration/update.md): ## What this endpoint does - Community > Appearance [Update community theme colors](https://adss-uat-dev.returning.ai/community/appearance/update-theme-colors.md): ## What this endpoint does - Community > Appearance [Update community bot profile](https://adss-uat-dev.returning.ai/community/appearance/update-bot.md): ## What this endpoint does - Community > Appearance [Update community URL metadata](https://adss-uat-dev.returning.ai/community/appearance/update-meta.md): ## What this endpoint does - Community > Appearance [Update community name and URL](https://adss-uat-dev.returning.ai/community/appearance/update-name-url.md): ## What this endpoint does - Community > Community Users [Get community users](https://adss-uat-dev.returning.ai/community/users/list.md): ## What this endpoint does - Community > Community Users [Get user](https://adss-uat-dev.returning.ai/community/users/get.md): ## What this endpoint does - Community [Create community](https://adss-uat-dev.returning.ai/community/create.md): ## What this endpoint does - API Keys > Community API Keys [Create API key](https://adss-uat-dev.returning.ai/api-keys/community/create.md): ## What this endpoint does - API Keys > Community API Keys [Read API keys](https://adss-uat-dev.returning.ai/api-keys/community/list.md): ## What this endpoint does - API Keys > Community API Keys [Delete API key](https://adss-uat-dev.returning.ai/api-keys/community/delete.md): ## What this endpoint does - API Keys > Community API Keys [Update API key](https://adss-uat-dev.returning.ai/api-keys/community/update.md): ## What this endpoint does - API Keys > User API Keys [List user API keys](https://adss-uat-dev.returning.ai/api-keys/user/list.md): ## What this endpoint does - API Keys > User API Keys [Create user API key](https://adss-uat-dev.returning.ai/api-keys/user/create.md): ## What this endpoint does - API Keys > User API Keys [Update user API key](https://adss-uat-dev.returning.ai/api-keys/user/update.md): ## What this endpoint does - API Keys > User API Keys [Delete user API key](https://adss-uat-dev.returning.ai/api-keys/user/delete.md): ## What this endpoint does - API Keys > User API Keys [Get current API key information](https://adss-uat-dev.returning.ai/api-keys/user/info.md): ## What this endpoint does - User Fields > User Field History [Get all user field histories in a community](https://adss-uat-dev.returning.ai/user-fields/list-history.md): ## What this endpoint does - User Fields > User Field History [Get user field histories for a specific field](https://adss-uat-dev.returning.ai/user-fields/list-field-history.md): ## What this endpoint does - User Fields > User Field History [Get user field histories for a specific user](https://adss-uat-dev.returning.ai/user-fields/list-user-history.md): ## What this endpoint does - User Fields > User Field History [Get user field histories of specific user field and user](https://adss-uat-dev.returning.ai/user-fields/list-user-field-history.md): ## What this endpoint does - User Fields > User Field History [Update A User Field Value](https://adss-uat-dev.returning.ai/user-fields/update-user-field-value.md): ## What this endpoint does - User Fields > User Field History [Deprecated Field-First History Write](https://adss-uat-dev.returning.ai/user-fields/history/create.md): ## What this route is - User Fields > User Field History [Deprecated Field-First History Read](https://adss-uat-dev.returning.ai/user-fields/history/list.md): ## What this route is - User Fields [Get A User Field Definition](https://adss-uat-dev.returning.ai/user-fields/get-field.md): ## What this endpoint does - User Fields [Update A User Field Definition](https://adss-uat-dev.returning.ai/user-fields/update-field.md): ## What this endpoint does - User Fields [Create A User Field Definition](https://adss-uat-dev.returning.ai/user-fields/create.md): ## What this endpoint does - User Fields [Delete A User Field Definition](https://adss-uat-dev.returning.ai/user-fields/delete-field.md): ## What this endpoint does - User Fields [List User Field Definitions](https://adss-uat-dev.returning.ai/user-fields/list.md): ## What this endpoint does - Legacy > Servers [Create server](https://adss-uat-dev.returning.ai/community-configuration/create-community.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Servers [List servers](https://adss-uat-dev.returning.ai/community-configuration/list-communities.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Servers [Update server metadata](https://adss-uat-dev.returning.ai/community-configuration/update-community.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Bulk Operations [Bulk import users from CSV](https://adss-uat-dev.returning.ai/bulk-jobs/import-users.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Authentication [Secure Auth](https://adss-uat-dev.returning.ai/auth/legacy-secure-auth.md): **What it is for:** Secure Auth. Use this as part of password-based account authentication rather than broker system ingestion. - Legacy > Authentication [Register user with password](https://adss-uat-dev.returning.ai/auth/register-user.md): ## What this endpoint does - Legacy > Authentication [Verify user email](https://adss-uat-dev.returning.ai/auth/verify-email.md): **What it is for:** Verify user email. Use this as part of password-based account authentication rather than broker system ingestion. - Legacy > Authentication [Log in user with password](https://adss-uat-dev.returning.ai/auth/login.md): ## What this endpoint does - Legacy > Badges [List badges](https://adss-uat-dev.returning.ai/gamification/list-badges.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Badges [Create badge](https://adss-uat-dev.returning.ai/gamification/create-badge.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Badges [Update badge](https://adss-uat-dev.returning.ai/gamification/update-badge.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Badges [Delete badge](https://adss-uat-dev.returning.ai/gamification/delete-badge.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Badges [Remove badge from user](https://adss-uat-dev.returning.ai/gamification/remove-user-badge.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Badges [Award badge to user](https://adss-uat-dev.returning.ai/gamification/award-user-badge.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Roles & Permissions [List server roles](https://adss-uat-dev.returning.ai/community-configuration/list-roles.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Roles & Permissions [Create role](https://adss-uat-dev.returning.ai/community-configuration/create-role.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Roles & Permissions [Update role](https://adss-uat-dev.returning.ai/community-configuration/update-role.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Roles & Permissions [Delete role](https://adss-uat-dev.returning.ai/community-configuration/delete-role.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Roles & Permissions [List user roles](https://adss-uat-dev.returning.ai/community-configuration/list-user-roles.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Roles & Permissions [Add role to user](https://adss-uat-dev.returning.ai/community-configuration/add-user-role.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Roles & Permissions [Remove role from user](https://adss-uat-dev.returning.ai/community-configuration/remove-user-role.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Users [Get user](https://adss-uat-dev.returning.ai/users/get-user-by-id.md): ## What this endpoint does - Legacy > Users [Upload user avatar](https://adss-uat-dev.returning.ai/users/upload-avatar.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Channels [Create channel](https://adss-uat-dev.returning.ai/channels/create-channel.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Channels [Update channel](https://adss-uat-dev.returning.ai/channels/update-channel.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > Channels [Delete channel](https://adss-uat-dev.returning.ai/channels/delete-channel.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > API Keys [List integration API keys](https://adss-uat-dev.returning.ai/api-keys/integration/list.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > API Keys [Create integration API key](https://adss-uat-dev.returning.ai/api-keys/integration/create.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > API Keys [Delete integration API key](https://adss-uat-dev.returning.ai/api-keys/integration/delete.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community. - Legacy > API Keys [Update integration API key](https://adss-uat-dev.returning.ai/api-keys/integration/update.md): **Legacy category:** This endpoint is retained for compatibility, historical admin tooling, or test workflows. Do not use it as the default choice for new integrations unless the backend team confirms this exact route is still supported for your community.