Delete organization

DELETE

/api/v1/gen_organizations

Delete an existing organization.

Parameters

Query Parameters

organization_id

required

Organization Id

string

Responses

200

Successful Response

BooleanResponse

Simple response returning a single boolean success status.

object

success

required

Success

Success status of the operation

boolean

400

Bad Request

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

403

Forbidden: You cannot update your own role, or the role of the owner, or remove yourself from the organization.

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

Example

{
  "error": "You cannot update your own role",
  "error_code": "cannot_update_own_role"
}

404

Not Found: User not found, or user is not a member of this organization.

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

Example

{
  "error": "User not found",
  "error_code": "user_not_found"
}

422

Unprocessable Content: Validation error (e.g., invalid parameters).

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null

Example

{
  "error": "Name is too long",
  "error_code": "validation_error"
}

500

Internal Server Error

ErrorResponse

object

detail

Any of:

string

string

null

null

error

Any of:

string

string

null

null

error_code

Any of:

string

string

null

null