Skip to the content

Texa DeskDevelopers

Section

Platform API · Users

Delete a User

DELETE/platform/api/v1/users/{id}

Authorization

api_access_tokenheaderrequired

A platform app's token. Platform apps exist only on a dedicated instance, made in its super admin console. On Texa's shared hosting this API is not open to companies.

Path parameters

idintegerrequired

The numeric ID of the user on the platform

Responses

200

Success

401

Unauthorized

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

404

The user does not exist

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

curl -X DELETE 'https://desk.texadesk.com/platform/api/v1/users/1' \
  -H "api_access_token: $PLATFORM_TOKEN"

import os, requests

headers = {"api_access_token": os.environ["PLATFORM_TOKEN"]}
r = requests.delete("https://desk.texadesk.com/platform/api/v1/users/1", headers=headers)
r.raise_for_status()

const r = await fetch("https://desk.texadesk.com/platform/api/v1/users/1", {
  method: "DELETE",
  headers: { "api_access_token": `${process.env.PLATFORM_TOKEN}` },
});
if (!r.ok) throw new Error(`${r.status}: ${await r.text()}`);