Delete User API

Overview

Soft-deletes a customer record in a Manage Users group and queues deletion of the linked wallet pass. This is the same endpoint the Manage Users dashboard uses when you remove a user from the UI.

Base URL

https://app.addtowallet.co

DELETE/api/manage-users/customers/:customerId

Path Parameters

customerId (string, required): The unique identifier of the customer to delete. Use the _id returned by List Users, or the customerId returned by Add User.

Authentication

All API requests must include your API key in the request headers:

"apikey": "your-api-key-here"

Request Example

curl -X DELETE 'https://app.addtowallet.co/api/manage-users/customers/686d10e7c2f0bc5cdf25c84b' \
  -H 'apikey: your-api-key-here'

Response

The customer record is soft-deleted synchronously. If the customer has a linked pass, deletion of that pass is queued and a batchId is returned for tracking.

Success Response Fields

message (string): Human-readable status message. Returns "Pass deletion is queued for user" when a pass deletion was queued.
batchId (string, optional): Returned when a pass deletion was queued. Use it with the Batch Status endpoint to track the deletion.

Response Example

{
  "message": "Pass deletion is queued for user",
  "batchId": "686d111dab9ab557fe3e5644"
}

Notes

• The customer record is soft-deleted (marked deleted: true) but retained in storage.
• Wallet pass removal happens asynchronously. Poll Batch Status with the returned batchId to confirm completion.
• Calling Delete User on a customer with no linked pass returns an error — the customer must have hasPass: true.

Error Code	Description
400	Bad Request - Customer has no associated pass to delete, or invalid customerId format.
401	Unauthorized - Missing or invalid API key.
403	Forbidden - Insufficient permissions for this customer.
404	Not Found - Customer with the specified ID does not exist.
429	Too Many Requests - API rate limit exceeded. Please wait before making additional requests.
500	Internal Server Error - Unexpected error during customer or pass deletion. Please contact support.