Account types

Delete an account type

Delete a custom account type and reassign its users to another account type.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
  • Default Sigma account types cannot be deleted.
  • All users assigned to the deleted account type will be reassigned to the specified reassignToAccountTypeId.
  • Retrieve account type IDs by calling the /v2/accountTypes endpoint.

Usage scenarios

  • Remove custom account types that are no longer needed.
  • Consolidate account types by moving users to a different account type before deletion.
delete/v2/accountTypes/{accountTypeId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

accountTypeIdstring required

The unique identifier of the account type to delete.

Query parameters

reassignToAccountTypeIdstring

The unique identifier of the account type to reassign users to. Users currently assigned the deleted account type will be reassigned this account type.

Response

The response body.

AccountTypesDeleteAccountTypeResponse200 required

Changes

No recorded changes to this operation across all 1 revision of this API.