Delete User

This endpoint allows you to delete users from your account.

Warning

DANGER: Deleting a user permanently removes their account and all associated data. This action cannot be undone. Ensure the user should be permanently removed before proceeding.

POST Parameters

ParameterRequiredValueDescription
api_key{key}An API key that has access to the resource you want to query for
user_id{integer}The unique ID of the user to delete

Response Information

ElementDescription
<status>A status code in response to the operation.
<message>Additional information about the operation – human readable.

Example

Sample Request

POST https://api-app.xtracta.com/v1/user/delete HTTP/1.1
api_key=123&user_id=12345

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<user_response>
    <status>200</status>
    <message>The request has been successfully processed</message>
</user_response>

Schema Definition

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

  <xs:simpleType name="ConfidenceType">
    <xs:union>
      <xs:simpleType>
        <xs:restriction base="xs:integer">
          <xs:minInclusive value="0"/>
          <xs:maxInclusive value="100"/>
        </xs:restriction>
      </xs:simpleType>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value=""/>
        </xs:restriction>
      </xs:simpleType>
    </xs:union>
  </xs:simpleType>

  <xs:complexType name="UserresponseType">
    <xs:sequence>
      <xs:element name="status" type="xs:positiveInteger"/>
      <xs:element name="message" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:element name="user_response">
    <xs:complexType>
      <xs:sequence>
      <xs:element name="status" type="xs:positiveInteger"/>
      <xs:element name="message" type="xs:string"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>