SEsentdm
Users

Remove user

Changed on

Removes a user's access to an organization or profile. Requires admin role. You cannot remove yourself or remove the last admin.

delete/v3/users/{userId}

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/users/{userId}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

userIdstring uuid required

User ID from route parameter

Headers

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

Response

User removed successfully

Changes

  • 6c829543a93eRevision changes
    • breaking

      added to the request body allOf list

    • breaking

      for the path request parameter userId, the format changed from no format to uuid

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • warning

      removed from the request body allOf list

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status