# Returning.AI-dev ## Docs - [Getting Started](https://adss-dev.returning.ai/doc-2046835.md): - [Channels](https://adss-dev.returning.ai/channels.md): - Channels [Iframe](https://adss-dev.returning.ai/doc-2046843.md): - [Events](https://adss-dev.returning.ai/events.md): - Events [Outgoing webhooks](https://adss-dev.returning.ai/events/outgoing-webhooks.md): - Events > Outgoing webhooks [Encryption](https://adss-dev.returning.ai/doc-2046846.md): - Events > Outgoing webhooks [User Joins Server](https://adss-dev.returning.ai/doc-2046847.md): - Events > Outgoing webhooks [User Visits server](https://adss-dev.returning.ai/doc-2046848.md): - Events > Outgoing webhooks [New Message Posted Anywhere](https://adss-dev.returning.ai/doc-2046849.md): - Events > Outgoing webhooks [New Message Posted To channel ](https://adss-dev.returning.ai/doc-2046850.md): - Events > Outgoing webhooks [Purchased Store Item ](https://adss-dev.returning.ai/doc-2046851.md): - Events [Incoming webhooks](https://adss-dev.returning.ai/events/incoming-webhooks.md): - Events > Incoming webhooks [API Keys & Encryption](https://adss-dev.returning.ai/doc-2046852.md): - Events > Incoming webhooks [Send message into channels](https://adss-dev.returning.ai/doc-2046853.md): - Events > Incoming webhooks [Update Custom User Fields](https://adss-dev.returning.ai/doc-2046854.md): - Events > Incoming webhooks [Update In-game currency](https://adss-dev.returning.ai/doc-2046855.md): - [Widgets](https://adss-dev.returning.ai/widgets.md): - Widgets [Authenticated Widgets](https://adss-dev.returning.ai/doc-2046858.md): - Widgets [Public widgets](https://adss-dev.returning.ai/doc-2046859.md): ## API Docs - Authentication [Register user with password](https://adss-dev.returning.ai/auth/register-user.md): Creates a password-based user account for the authentication flow. Use this when the client application owns the signup screen and needs Returning.AI to create a login identity before email verification. - Authentication [Verify user email](https://adss-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. - Authentication [Log in user with password](https://adss-dev.returning.ai/auth/login.md): **What it is for:** Log in user with password. Use this as part of password-based account authentication rather than broker system ingestion. - Authentication [Secure Auth](https://adss-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. - Users [Get user](https://adss-dev.returning.ai/users/get-user-by-id.md): **What it is for:** Get user. Use this for user provisioning, lookup, profile management, or user-specific gamification data. - Users [Get Users with Filters](https://adss-dev.returning.ai/users/search-users.md): **What it is for:** Searches users with filters. Use this for back-office syncs, reconciliation, and segmented reporting. - Users [Create New User](https://adss-dev.returning.ai/users/create-user.md): **What it is for:** Creates a user in the community resolved from the API key. Use this for broker-driven onboarding or pre-provisioning. - Users [Get User Data](https://adss-dev.returning.ai/users/lookup-user.md): **What it is for:** Looks up a Returning.AI user by supported identifiers and returns profile, custom field, and community-specific user data. - Users [Manage User Account](https://adss-dev.returning.ai/users/update-user-status.md): This endpoints allows you to delete or restore a user in your community. - Users [List mini-game logs by user email](https://adss-dev.returning.ai/mini-games/get-user-logs.md): **What it is for:** Returns mini-game logs for a user email. - Users [Get user's current Mini Games and Streak stats](https://adss-dev.returning.ai/mini-games/get-current-user-state.md): **What it is for:** Returns the user's current mini-game and streak summary. - Users [Get User Milestones](https://adss-dev.returning.ai/api-37120219.md): - Messaging > Message Actions > Direct Channel > private DM channel [Reply Message](https://adss-dev.returning.ai/messaging/message-actions/private-dm/reply.md): This endpoint sends a message to a channel as a specified user. - Messaging > Message Actions > Direct Channel > private DM channel [Send Message](https://adss-dev.returning.ai/messaging/message-actions/private-dm/send.md): This endpoint sends a message to a channel as a specified user. - Messaging > Message Actions > Direct Channel > private DM channel [React Message](https://adss-dev.returning.ai/messaging/message-actions/private-dm/react.md): - Messaging > Message Actions > Direct Channel > public channel [Reply Message](https://adss-dev.returning.ai/messaging/message-actions/public-channel/reply.md): This endpoint sends a message to a channel as a specified user. - Messaging > Message Actions > Direct Channel > public channel [Send Message](https://adss-dev.returning.ai/messaging/message-actions/public-channel/send.md): This endpoint sends a message to a channel as a specified user. - Messaging > Message Actions > Direct Channel > public channel [React Message](https://adss-dev.returning.ai/messaging/message-actions/public-channel/react.md): - Messaging > Message Actions > Forum Channel [Send Message](https://adss-dev.returning.ai/messaging/message-actions/forum/send.md): This endpoint sends a message to a channel as a specified user. - Messaging > Message Actions > Forum Channel [Reply Message](https://adss-dev.returning.ai/messaging/message-actions/forum/reply.md): This endpoint sends a message to a channel as a specified user. - Messaging > Message Actions > Forum Channel [React Message](https://adss-dev.returning.ai/messaging/message-actions/forum/react.md): - Messaging > Message Actions > Text Channel [Reply Message](https://adss-dev.returning.ai/messaging/message-actions/text/reply.md): This endpoints sends a reply to a message as a specified user. - Messaging > Message Actions > Text Channel [Send Message](https://adss-dev.returning.ai/messaging/message-actions/text/send.md): This endpoint sends a message to a channel as a specified user. - Messaging > Message Actions > Text Channel [React Message](https://adss-dev.returning.ai/messaging/message-actions/text/react.md): - Messaging > Message Actions > Iframe Channel [Reply Message](https://adss-dev.returning.ai/messaging/message-actions/iframe/reply.md): This endpoints sends a reply to a message as a specified user. - Messaging > Message Actions > Iframe Channel [Send Message](https://adss-dev.returning.ai/messaging/message-actions/iframe/send.md): This endpoint sends a message to a channel as a specified user. - Messaging > Message Actions > Iframe Channel [React Message](https://adss-dev.returning.ai/messaging/message-actions/iframe/react.md): - Messaging [Get Messages](https://adss-dev.returning.ai/messaging/get-messages.md): **What it is for:** Lists messages for a channel, forum topic, or community context so an integration can audit or sync conversation history. - Messaging [Send Message](https://adss-dev.returning.ai/messaging/send-message.md): This endpoint sends a message to a channel as a specified user. - Messaging [Reply Message](https://adss-dev.returning.ai/messaging/reply-message.md): This endpoints sends a reply to a message as a specified user. - Messaging [React Message](https://adss-dev.returning.ai/messaging/react-to-message.md): This endpoints sends a reaction to a message as a specified user. - Messaging [Upload message images](https://adss-dev.returning.ai/messaging/upload-image.md): **What it is for:** Uploads one or more images for use in message payloads. Send files as `multipart/form-data` under the `images` field. - Gamification > Leaderboards [List leaderboards with pagination](https://adss-dev.returning.ai/gamification/leaderboards/list.md): Lists leaderboards for the community resolved from the bearer API key. Response objects mirror the current micro-services leaderboard schema, including reset/prize settings, page config, translations, banner data, and expanded widget configuration. - Gamification > Leaderboards [Create a new leaderboard](https://adss-dev.returning.ai/gamification/leaderboards/create.md): Creates a leaderboard for the API-key community and returns the created leaderboard document. - Gamification > Leaderboards [Update an existing leaderboard](https://adss-dev.returning.ai/gamification/leaderboards/update.md): Updates an existing leaderboard for the community resolved from the bearer API key. This endpoint mirrors the current micro-services leaderboard schema. Current fields such as `leaderImage`, `order`, `banner`, `translations`, reset/prize settings, user display settings, page config, and the expanded widget configuration are accepted. Legacy partner aliases are still accepted where supported by the service adapter. Send only fields that should change. - Gamification > Leaderboards [Get a single leaderboard by ID](https://adss-dev.returning.ai/gamification/leaderboards/get.md): Returns one leaderboard for the community resolved from the bearer API key. The response mirrors the current micro-services leaderboard schema, including `leaderImage`, reset/prize settings, `banner`, `translations`, user display settings, page config, and expanded widget configuration. - Gamification > Leaderboards [Delete a leaderboard](https://adss-dev.returning.ai/gamification/leaderboards/delete.md): Deletes one leaderboard for the community resolved from the bearer API key. Requires `leaderboard` permission. The path remains prefix-free in Apidog; runtime routing may mount the partner API under `/apis/partner` depending on deployment mode. - Gamification > Streaks & Mini Games [List user streak logs](https://adss-dev.returning.ai/streaks/search-streak-logs.md): **What it is for:** Lists streak logs for customer success or gamification review. - Gamification > Streaks & Mini Games [Update user spin-wheel information](https://adss-dev.returning.ai/mini-games/update-user-wheel-state.md): **What it is for:** Updates per-user spin-wheel metadata used by mini-game/streak operations. - Gamification > Referral [Get referral programs](https://adss-dev.returning.ai/api-37955364.md): **What it is for:** Returns public referral program definitions for the API key’s community. Clients can use this to build their - Gamification > Referral [Get user's referral summary](https://adss-dev.returning.ai/api-37905861.md): **What it is for:** Returns a user's referral summary, including invite link, referral activity totals, referral program stage - Gamification [Get tiers and XP settings](https://adss-dev.returning.ai/gamification/get-tier-configuration.md): **What it is for:** Returns tiers/XP configuration used by the community gamification layer. - Gamification [Get daily user gamification history](https://adss-dev.returning.ai/gamification/get-user-daily-history.md): **What it is for:** Returns daily gamification history for a user. - Gamification [List user gamification logs](https://adss-dev.returning.ai/gamification/search-logs.md): **What it is for:** Returns gamification log rows for a user or community filter. - Gamification [Get user activity stats](https://adss-dev.returning.ai/gamification/user-action-stats.md): **What it is for:** Returns activity statistics for a user. - Rewards & Redemptions [Update redemption order status](https://adss-dev.returning.ai/redemptions/update-order-status.md): **What it is for:** Changes a redemption order status and can optionally refund coins when moving an order to a refunded status. - Rewards & Redemptions [List redemption orders by user email](https://adss-dev.returning.ai/redemptions/list-user-orders.md): **What it is for:** Returns redemption orders for a specific user email with pagination. - Rewards & Redemptions [List redemption statuses](https://adss-dev.returning.ai/redemptions/list-statuses.md): **What it is for:** Lists custom redemption statuses available in a community. - Rewards & Redemptions [Get redemption status by ID](https://adss-dev.returning.ai/redemptions/get-status.md): **What it is for:** Reads one redemption status by ID. - Rewards & Redemptions [List redemption orders by community](https://adss-dev.returning.ai/redemptions/list-community-orders.md): **What it is for:** Returns redemption orders for the API-key community with pagination. - Rewards & Redemptions [Create redemption order status](https://adss-dev.returning.ai/redemptions/create-status.md): **What it is for:** Creates a custom redemption order status for the API-key community. - Rewards & Redemptions [Get redemption order status history](https://adss-dev.returning.ai/redemptions/get-order-status-history.md): **What it is for:** Returns status-change history for a redemption order. - Chart Analysis [Create Analysis](https://adss-dev.returning.ai/chart-analysis/create-analysis.md): Creates a new technical chart analysis with: - Chart Analysis [Get Analysis](https://adss-dev.returning.ai/chart-analysis/get-analysis.md): **What it is for:** Get Analysis. Use this for chart-analysis content, metadata, drawings, and lifecycle management. - Chart Analysis [Update Analysis](https://adss-dev.returning.ai/chart-analysis/update-analysis.md): Update an existing analysis. Supports partial updates to: - Chart Analysis [Delete Analysis](https://adss-dev.returning.ai/chart-analysis/delete-analysis.md): **What it is for:** Delete Analysis. Use this for chart-analysis content, metadata, drawings, and lifecycle management. - Chart Analysis [List Analyses](https://adss-dev.returning.ai/chart-analysis/list-channel-analyses.md): List all analyses in a channel with pagination and filtering. - Chart Analysis [Append Drawings](https://adss-dev.returning.ai/chart-analysis/append-drawings.md): Append additional drawings to an existing analysis without replacing existing drawings. - Bulk Operations [List bulk update jobs](https://adss-dev.returning.ai/bulk-jobs/list-jobs.md): **What it is for:** Lists bulk update jobs created for the community so operators can inspect processing state and recent results. - Bulk Operations [Get bulk update job status](https://adss-dev.returning.ai/bulk-jobs/get-job-status.md): **What it is for:** Returns the processing status for a bulk update job. - Bulk Operations [Get bulk update job details](https://adss-dev.returning.ai/bulk-jobs/get-job-details.md): **What it is for:** Returns row-level details for a bulk update job, usually with pagination. - Bulk Operations [Bulk update users from CSV](https://adss-dev.returning.ai/bulk-jobs/update-users.md): **What it is for:** Uploads a CSV that updates many user records asynchronously. Track the result from the bulk update list/status endpoints or API logs. - Bulk Operations [Bulk update premium currency from CSV](https://adss-dev.returning.ai/bulk-jobs/update-premium-currency.md): **What it is for:** Uploads a CSV to update premium currency balances in bulk. Use this for broker-pushed balance/points adjustments where one row maps to one user update. - Channels [List integration channels](https://adss-dev.returning.ai/channels/list-channels.md): This endpoint gets the list of channels in the community. - Store > Purchase History [Update purchase history redemption instructions or voucher details](https://adss-dev.returning.ai/store/purchase-history/update.md): Updates purchase-history correction fields for an existing order and returns the updated purchase history. - Store > Categories [List store categories](https://adss-dev.returning.ai/store/categories/list.md): Returns a paginated list of store categories for the API-key's community, with optional sorting, field projection, search, filtering, and user visibility filtering. - Store > Categories [Create store category](https://adss-dev.returning.ai/store/categories/create.md): Creates one store category for the API-key community and returns the created public category. - Store > Categories [Get store category by ID](https://adss-dev.returning.ai/store/categories/get.md): Returns one store category from the API-key's community by category ID, with optional field projection. - Store > Categories [Update store category](https://adss-dev.returning.ai/store/categories/update.md): Updates one store category for the API-key community and returns the updated public category. - Store > Categories [Delete store category](https://adss-dev.returning.ai/store/categories/delete.md): Deletes one store category for the API-key's community and returns the deleted category ID. - Store > Products [List products](https://adss-dev.returning.ai/store/products/list.md): Returns products for the API-key community using the public partner product contract. - Store > Products [Create products in bulk](https://adss-dev.returning.ai/api-37688711.md): Creates up to 100 voucher products for the API-key community and returns the created public product records. - Store > Products [Create product with vouchers](https://adss-dev.returning.ai/store/products/create.md): Creates a voucher product for the API-key community and optionally creates new voucher codes for that product. - Store > Products [Update products in bulk](https://adss-dev.returning.ai/api-37690410.md): Updates up to 100 voucher products for the API-key community and returns the updated public product records. - Store > Products [Read product](https://adss-dev.returning.ai/store/products/get.md): Returns one product from the API-key community using the public partner product contract. - Store > Products [Update product and append vouchers](https://adss-dev.returning.ai/store/products/update.md): Updates a product in the API-key community with a full product body and optionally appends new voucher codes to the same product. - Store > Products [Delete product](https://adss-dev.returning.ai/store/products/delete.md): Deletes one product from the API-key community. - Store [Get store configuration](https://adss-dev.returning.ai/store/configuration/get.md): Reads the current community store configuration aggregate for the API-key's community, including display settings, currency configuration, i18n settings, and populated widget data with defaults. - Store [Update store configuration](https://adss-dev.returning.ai/store/configuration/update.md): Updates the current community store configuration aggregate for the API-key's community and persists widget settings as part of the same operation. - Community Analytics [Get Loyalty Overview](https://adss-dev.returning.ai/analytics/get-loyalty-overview.md): **What it is for:** Get Loyalty Overview. Use this to retrieve loyalty overview metrics for reporting dashboards. - Community > Appearance [Update community theme colors](https://adss-dev.returning.ai/community/appearance/update-theme-colors.md): Update community appearance settings. - Community > Appearance [Update community bot profile](https://adss-dev.returning.ai/community/appearance/update-bot.md): Module: Community Bot - Community > Appearance [Update community URL metadata](https://adss-dev.returning.ai/community/appearance/update-meta.md): escription - Community > Appearance [Update community name and URL](https://adss-dev.returning.ai/community/appearance/update-name-url.md): Basic Info - Community > Community Users [Get community users](https://adss-dev.returning.ai/community/users/list.md): Retrieve a paginated list of users in a specific community with optional field selection. - Community > Community Users [Get user](https://adss-dev.returning.ai/community/users/get.md): Retrieve user information by user ID within a community context with optional field selection. - Community [Create community](https://adss-dev.returning.ai/community/create.md): **What it is for:** Creates a new community and returns the created community payload. - API Keys > Community API Keys [Create API key](https://adss-dev.returning.ai/api-keys/community/create.md): Creates a new API key for a community. API keys can be used for authentication - API Keys > Community API Keys [Read API keys](https://adss-dev.returning.ai/api-keys/community/list.md): Retrieve a paginated list of API keys for a community. This endpoint provides an overview - API Keys > Community API Keys [Delete API key](https://adss-dev.returning.ai/api-keys/community/delete.md): Permanently delete an API key from a community. This action cannot be undone and will - API Keys > Community API Keys [Update API key](https://adss-dev.returning.ai/api-keys/community/update.md): Updates an existing API key for a community. This endpoint allows modification of - API Keys > User API Keys [List user API keys](https://adss-dev.returning.ai/api-keys/user/list.md): **What it is for:** List user API keys. Use this to create, list, update, revoke, or inspect API keys and their permission scopes. - API Keys > User API Keys [Create user API key](https://adss-dev.returning.ai/api-keys/user/create.md): **What it is for:** Create user API key. Use this to create, list, update, revoke, or inspect API keys and their permission scopes. - API Keys > User API Keys [Update user API key](https://adss-dev.returning.ai/api-keys/user/update.md): **What it is for:** Update user API key. Use this to create, list, update, revoke, or inspect API keys and their permission scopes. - API Keys > User API Keys [Delete user API key](https://adss-dev.returning.ai/api-keys/user/delete.md): **What it is for:** Delete user API key. Use this to create, list, update, revoke, or inspect API keys and their permission scopes. - API Keys > User API Keys [Get current API key information](https://adss-dev.returning.ai/api-keys/user/info.md): **What it is for:** Get current API key information. Use this to create, list, update, revoke, or inspect API keys and their permission scopes. - User Fields > User Field History [Get all user field histories in a community](https://adss-dev.returning.ai/user-fields/list-history.md): **What it is for:** Get all user field histories in a community. Use this to audit changes to broker-specific custom fields, reconcile historical values, and troubleshoot user-data syncs. - User Fields > User Field History [Get user field histories for a specific field](https://adss-dev.returning.ai/user-fields/list-field-history.md): **What it is for:** Get user field histories for a specific field. Use this to audit changes to broker-specific custom fields, reconcile historical values, and troubleshoot user-data syncs. - User Fields > User Field History [Get user field histories for a specific user](https://adss-dev.returning.ai/user-fields/list-user-history.md): **What it is for:** Get user field histories for a specific user. Use this to audit changes to broker-specific custom fields, reconcile historical values, and troubleshoot user-data syncs. - User Fields > User Field History [Get user field histories of specific user field and user](https://adss-dev.returning.ai/user-fields/list-user-field-history.md): **What it is for:** Get user field histories of specific user field and user. Use this to audit changes to broker-specific custom fields, reconcile historical values, and troubleshoot user-data syncs. - User Fields > User Field History [Create user field history for specific user](https://adss-dev.returning.ai/user-fields/update-user-field-value.md): **What it is for:** Create user field history for specific user. Use this to audit changes to broker-specific custom fields, reconcile historical values, and troubleshoot user-data syncs. - User Fields > User Field History [Create user field history](https://adss-dev.returning.ai/user-fields/history/create.md): **What it is for:** Create user field history. Use this to audit changes to broker-specific custom fields, reconcile historical values, and troubleshoot user-data syncs. - User Fields > User Field History [Get user field histories](https://adss-dev.returning.ai/user-fields/history/list.md): **What it is for:** Get user field histories. Use this to audit changes to broker-specific custom fields, reconcile historical values, and troubleshoot user-data syncs. - User Fields [Get Specific User Field](https://adss-dev.returning.ai/user-fields/get-field.md): **What it is for:** Get Specific User Field. Use this to define and maintain custom user fields used for broker segmentation, eligibility, reporting, and integration payloads. - User Fields [Update Custom User Field](https://adss-dev.returning.ai/user-fields/update-field.md): **What it is for:** Update Custom User Field. Use this to define and maintain custom user fields used for broker segmentation, eligibility, reporting, and integration payloads. - User Fields [Create user field](https://adss-dev.returning.ai/user-fields/create.md): Creates a new user field for a community - User Fields [Delete Custom User Field](https://adss-dev.returning.ai/user-fields/delete-field.md): **What it is for:** Delete Custom User Field. Use this to define and maintain custom user fields used for broker segmentation, eligibility, reporting, and integration payloads. - User Fields [Get all user fields for a community](https://adss-dev.returning.ai/user-fields/list.md): Retrieves all user fields associated with a specific community - User Fields [Delete user field](https://adss-dev.returning.ai/user-fields/delete.md): **What it is for:** Delete user field. Use this to define and maintain custom user fields used for broker segmentation, eligibility, reporting, and integration payloads. - User Fields [Update user field](https://adss-dev.returning.ai/user-fields/update.md): **What it is for:** Update user field. Use this to define and maintain custom user fields used for broker segmentation, eligibility, reporting, and integration payloads. - User Fields [Get specific user field](https://adss-dev.returning.ai/user-fields/get.md): **What it is for:** Get specific user field. Use this to define and maintain custom user fields used for broker segmentation, eligibility, reporting, and integration payloads. - Legacy > Servers [Create server](https://adss-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-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-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-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 > Badges [List badges](https://adss-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-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-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-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-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-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 > Messaging [Reply to message](https://adss-dev.returning.ai/messaging/message-actions/reply.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 > Messaging [Send message](https://adss-dev.returning.ai/messaging/message-actions/send.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 > Messaging [React to message](https://adss-dev.returning.ai/messaging/message-actions/react.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-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-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-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-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-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-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-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 [Upload user avatar](https://adss-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-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-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-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-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-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-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-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. ## Schemas - [Pet](https://adss-dev.returning.ai/schema-13734782.md): - [Category](https://adss-dev.returning.ai/schema-13734783.md): - [Tag](https://adss-dev.returning.ai/schema-13734784.md): - [ValidationError](https://adss-dev.returning.ai/schema-13734785.md): - [NotFoundError](https://adss-dev.returning.ai/schema-13734786.md): - [InternalServerError](https://adss-dev.returning.ai/schema-13734787.md): - [NotImplementedError](https://adss-dev.returning.ai/schema-13734788.md): - [CreateUserFieldHistoryResponse](https://adss-dev.returning.ai/schema-13734789.md): - [CreateUserFieldHistorySuccessResponse](https://adss-dev.returning.ai/schema-13734790.md): - [UserFieldHistoryItem](https://adss-dev.returning.ai/schema-13734791.md): - [GetUserFieldHistoriesResponse](https://adss-dev.returning.ai/schema-13734792.md): - [UserFieldHistoriesValidationError](https://adss-dev.returning.ai/schema-13734793.md): - [UserFieldHistoriesMetaWithValidation](https://adss-dev.returning.ai/schema-13734794.md): - [UserFieldHistoriesMetaWithPagination](https://adss-dev.returning.ai/schema-13734795.md): - [GetUserFieldHistoriesSuccessResponse](https://adss-dev.returning.ai/schema-13734796.md): - [CreateUserFieldResponse](https://adss-dev.returning.ai/schema-13734797.md): - [CreateUserFieldSuccessResponse](https://adss-dev.returning.ai/schema-13734798.md): - [DeleteUserFieldResponse](https://adss-dev.returning.ai/schema-13734799.md): - [DeleteUserFieldSuccessResponse](https://adss-dev.returning.ai/schema-13734800.md): - [UserFieldCreator](https://adss-dev.returning.ai/schema-13734801.md): - [GetUserFieldResponse](https://adss-dev.returning.ai/schema-13734802.md): - [GetUserFieldSuccessResponse](https://adss-dev.returning.ai/schema-13734803.md): - [ValidationErrorItem](https://adss-dev.returning.ai/schema-13734804.md): - [GetUserFieldsMetaResponse](https://adss-dev.returning.ai/schema-13734805.md): - [CreatorInfo](https://adss-dev.returning.ai/schema-13734806.md): - [UserFieldResponse](https://adss-dev.returning.ai/schema-13734807.md): - [GetUserFieldsSuccessResponse](https://adss-dev.returning.ai/schema-13734808.md): - [UpdateUserFieldResponse](https://adss-dev.returning.ai/schema-13734809.md): - [UpdateUserFieldPayload](https://adss-dev.returning.ai/schema-13734810.md): - [UpdateUserFieldSuccessResponse](https://adss-dev.returning.ai/schema-13734811.md): - [MetaResponse](https://adss-dev.returning.ai/schema-13734812.md): - [GetUserResponse](https://adss-dev.returning.ai/schema-13734813.md): - [GetUserSuccessResponse](https://adss-dev.returning.ai/schema-13734814.md): - [Purchased store item](https://adss-dev.returning.ai/schema-13734815.md): - [ErrorResponse](https://adss-dev.returning.ai/schema-13734819.md): - [New message posted to channel](https://adss-dev.returning.ai/schema-13734816.md): - [UpdateAnalysisRequest](https://adss-dev.returning.ai/schema-13734820.md): - [User visits server](https://adss-dev.returning.ai/schema-13734817.md): - [AppendDrawingsRequest](https://adss-dev.returning.ai/schema-13734821.md): - [User join server](https://adss-dev.returning.ai/schema-13734818.md): - [CreateAnalysisResponse](https://adss-dev.returning.ai/schema-13734822.md): - [GetAnalysisResponse](https://adss-dev.returning.ai/schema-13734823.md): - [UpdateAnalysisResponse](https://adss-dev.returning.ai/schema-13734824.md): - [AppendDrawingsResponse](https://adss-dev.returning.ai/schema-13734825.md): - [AnalysisMetadata](https://adss-dev.returning.ai/schema-13734826.md): - [Expiry](https://adss-dev.returning.ai/schema-13734827.md): - [Levels](https://adss-dev.returning.ai/schema-13734828.md): - [LevelEntry](https://adss-dev.returning.ai/schema-13734829.md): - [Drawing](https://adss-dev.returning.ai/schema-13734830.md): - [HorizontalLineDrawing](https://adss-dev.returning.ai/schema-13734831.md): - [LineDrawing](https://adss-dev.returning.ai/schema-13734832.md): - [RectangleDrawing](https://adss-dev.returning.ai/schema-13734833.md): - [ParallelDrawing](https://adss-dev.returning.ai/schema-13734834.md): - [FibonacciRetracementDrawing](https://adss-dev.returning.ai/schema-13734835.md): - [Coordinate](https://adss-dev.returning.ai/schema-13734836.md): - [DrawingStyle](https://adss-dev.returning.ai/schema-13734837.md): - [AnalysisDetail](https://adss-dev.returning.ai/schema-13734838.md): - [AnalysisSummary](https://adss-dev.returning.ai/schema-13734839.md): - [CreateAnalysisRequest](https://adss-dev.returning.ai/schema-13734840.md): - [ListAnalysesResponse](https://adss-dev.returning.ai/schema-13734841.md): - [StandardApiError](https://adss-dev.returning.ai/schema-15051629.md): - [StandardSuccessEnvelope](https://adss-dev.returning.ai/schema-15051630.md): - [PurchasedStoreItemEvent](https://adss-dev.returning.ai/schema-15053964.md): - [ChannelMessagePostedEvent](https://adss-dev.returning.ai/schema-15053965.md): - [UserVisitedCommunityEvent](https://adss-dev.returning.ai/schema-15053966.md): - [UserJoinedCommunityEvent](https://adss-dev.returning.ai/schema-15053967.md):