Skip to main content
DELETE
/
api
/
v1
/
users
Python (SDK)
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.v1.delete(request={
        "email": "[email protected]",
        "reason": "User left the organization",
    })

    # Handle response
    print(res)
{
  "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

reason
string
required

The reason for deleting the user

Example:

"User left the organization"

Response

Successful Response