users

Delete or archive a user

Changed on

Permanently deletes or archives a user by their unique identifier. The type query parameter controls whether the user is fully deleted (DELETED) or archived (ARCHIVED). Deleting a user removes their account, numbers, and all associated resources. Archiving a user disables their account but preserves their data for future reactivation.

Permission: No specific permission required. A valid API key is sufficient.

Monitoring: Not needed.

Warning — Destructive operation: This route does not enforce any specific permission category. Any valid API key can delete or archive any user in the team. Exercise extreme caution when using this endpoint, especially in automated workflows. Consider restricting API key distribution accordingly.

delete/users/{userId}

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/users/{userId}
  • Auth
    API key in header Authorization

Path parameters

userIdinteger required

The identifier of the user

Query parameters

type'DELETED' | 'ARCHIVED'

Type of deletion

Response

Successful operation

Changes

  • d92d55716cc3Revision changes
    • info

      api operation id deleteUsersUserid was added

    • info

      added the new optional query request parameter type