Delete Current Organization

Delete the current organization and all its users.

DELETE /api/v1/organizations/

Typescript (SDK)

TypeScript

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.organizations.delete({
    deleteComments: "Deleted the organization because it was no longer needed",
  });

  console.log(result);
}

run();

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Syllable-API-Key · string · header · required

Body

application/x-www-form-urlencoded

delete_comments · string | null

Comments explaining the deletion

Example:

"Deleted the organization because it was no longer needed"

Response

200

application/json

Successful Response