1. Users
Returning.AI
  • Getting Started
  • Users
    • User directory and provisioning
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Milestones
      POST
    • Update User Data, Identifier, And Roles
      POST
    • Update User XP and Currency
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
      GET
    • Send Message
      POST
    • Reply Message
      POST
    • React Message
      POST
    • Upload message images
      POST
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
      • List mini-game logs by user email
      • Get current mini-game and streak state
      • Update user spin-wheel information
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
      • Get Daily Calculation Data
      • Get Rolling Calculation Data
    • Match Predictions
    • Get tier configuration
      GET
    • Get daily user XP and coin changes
      POST
    • Search user gamification logs
      POST
    • Get user activity stats
      POST
  • Rewards & Redemptions
    • Store catalog to redemptions
    • Update redemption order status or refund
      PUT
    • List redemption orders by user email
      POST
    • List redemption statuses
      POST
    • Get redemption status by ID
      POST
    • List redemption orders by community
      POST
    • Create redemption order status
      POST
    • Get redemption order status history
      POST
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
    • Get bulk update job status
    • Get bulk update job details
    • Bulk update users from CSV
    • Bulk update premium currency from CSV
  • Channels
    • Iframe
    • List integration channels
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store catalog
    • Purchase History
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Update products in bulk
      • Create products in bulk
      • Create product with vouchers
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • User Fields
    • User field definitions and history
    • User Field History
      • Get all user field histories in a community
      • Get user field histories for a specific field
      • Get user field histories for a specific user
      • Get user field histories of specific user field and user
      • Update A User Field Value
      • Deprecated Field-First History Write
      • Deprecated Field-First History Read
    • Get A User Field Definition
    • Update A User Field Definition
    • Create A User Field Definition
    • Delete A User Field Definition
    • List User Field Definitions
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Secure Auth
      • Register user with password
      • Verify user email
      • Log in user with password
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
      • Upload user avatar
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  1. Users

Manage User Account

POST
/v1/users/manage

What this endpoint does#

Soft-deletes or restores one member in the API key's community. Use it for account-level removal and undo, not for profile, role, XP, or custom-field edits.
It does not remove the member from POST /v1/users/filter or from GET /v1/communities/{communityId}/users/{email} on the current public runtime. Search and community GET can still return the user after a successful delete.
WARNING
Exact retry / accidental delete
action must be remove or restore. On 2026-08-19 Codex, action: "delete" was accepted and returned 200 USER_SOFT_DELETED anyway. Do not send delete in tests against live members. If you did, send action: "restore" for the same user.
INFO
Workflow
Authenticate → identify the member with POST /v1/users/info → POST /v1/users/manage with remove or restore → confirm with POST /v1/users/info and the admin user list, not with filter alone.

Quick start#

Restore (safe to retry on an already-active member):
Soft-delete uses the same body with "action": "remove".

Authentication and permission#

Send Authorization: Bearer <COMMUNITY_API_KEY>. Required permission: Delete/Restore User. Keep the key server-side.

Complete examples#

Restore (200). { "user": "member@example.com", "action": "restore" } returned 200 USER_RESTORED User has been restored successfully. Follow-up GET community user by email and POST /v1/users/info both returned 200.
Soft-delete (200). { "user": "member@example.com", "action": "delete" } returned 200 USER_SOFT_DELETED User has been deleted successfully even though validation copy says the allowed values are remove and restore. Prefer remove in integrations.
Missing action (400). { "user": "member@example.com" } returned detail.action: Action is required and must be either remove or restore.
Empty body (400). {} returned detail.user: Required and the same action requirement.

Success and readback#

ActionCodeMessage
restoreUSER_RESTOREDUser has been restored successfully
remove or deleteUSER_SOFT_DELETEDUser has been deleted successfully
Envelope is { status: "success", code, message }.
CHECK
Readback
After restore, call POST /v1/users/info and GET /v1/communities/{communityId}/users/{email}. Both should return 200. After remove, those same reads may still return 200. Filter rows are not proof of deletion.

Errors and recovery#

StatusWhenRecovery
400 Manage user endpoint validation error.Missing user or missing actionSend both. Use remove or restore.
401Missing or invalid keyReplace the community key.
Do not probe remove against a live member to "see what happens". Create a disposable user first, or restore immediately if you already did.

Retry safety#

WARNING
Exact retry
restore is safe to retry; a second restore on an active member still returned 200 USER_RESTORED. remove / delete is not a sandbox action. Do not retry remove to confirm the code. Retry only after checking POST /v1/users/info.

Gotchas#

Validation text says remove or restore, but delete currently performs a soft-delete.
Soft-delete does not drop POST /v1/users/filter rows.
Soft-delete does not make GET /v1/communities/{communityId}/users/{email} return 404 on the current runtime.
user accepts the same identifier family as other user writes (email in the Codex proof).

Next steps#

Get Users with Filters
Search still returns soft-deleted members. Do not use filter as deletion proof.

Request

Body Params application/json

Examples

Responses

🟢200OK
application/json
Request completed successfully.
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠409
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://adss-integration.returning.ai/apis/v1/users/manage' \
--header 'Content-Type: application/json' \
--data '{
    "action": "delete",
    "user": "johndoe"
}'
Response Response Example
200 - Success Example
{
    "action": "delete",
    "user": "momoyo"
}
Modified at 2026-08-18 17:20:35
Previous
Get User Data
Next
Get User Milestones
Built with