RecomlyRecomlyRecomlyDocs
Recomly APIEndpointsUsers

Delete user

Remove a member from the organization.

DELETE /api/app/users/{email}

Removes a member from the organization and deletes their platform account. Requires the admin role.

Callers cannot delete their own account. The last member or last admin of an organization cannot be deleted.

The email path parameter must be URL-encoded (@%40).


Request

See API Basics for required headers.

Path parameters

ParameterTypeDescription
emailstringURL-encoded email address of the member to delete.

Sample request

curl -X DELETE https://api.recomly.com/api/app/users/carol%40acmeplumbing.com \
  -H "Authorization: Bearer rk_live_abc123:def456"

Sample response

Status: 200 OK

{
  "ok": true
}

Error responses

See API Basics for standard status codes and error response format.

StatusMeaning
400Cannot delete self, last member, or last admin of the organization.
403Caller does not have the admin role.
404No member with that email exists in the organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.