Skip to main content
DELETE
/
api
/
v1
/
users
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";

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

async function run() {
  const result = await syllableSDK.v1.delete({
    email: "user@syllable.ai",
    reason: "User left the organization",
  });

  console.log(result);
}

run();
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Syllable-API-Key
string
header
required

Body

application/json

Request model to delete a user.

email
string
required

The email address of the user to delete

Example:

"user@syllable.ai"

reason
string
required

The reason for deleting the user

Example:

"User left the organization"

Response

Successful Response