Skip to content

Remove Role

Soft remove a role from the target path. The role is marked as removed but not permanently deleted from the database. The authenticated user must have ADMIN permissions.

Parameters

name * are required parametersdata typedescription
roleId*stringThe unique identifier of the role to remove

Return Value

json
{
  "statusCode": 201,
  "data": null,
  "message": "Successfully removed the role"
}

Error Codes

  • 400 Bad Request: Returned when parameters are invalid.
  • 401 Unauthorized: Returned when permissions are insufficient.

Examples

bash
curl -X POST "https://app.wombat.software/api/{targetPath}/role/:roleId/remove" \
  -H "Content-Type: application/json" \
  -H "Authentication: Bearer ..."

ENDPOINTS

post/api/{targetPath}/role/:roleId/remove