Get
/CloseUserAccountByExternalId/{id}
Allows you close a user account removing all identifying information from the system by providing a unique identifier from your external system.
Security
API Key
Header parameter nameapi_key
Path parameters
id
stringRequired
The external ID of the user whose account is to be closed.
Responses
200
OK Response
object
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
RowsAffected
integer (int32)
The number of database rows affected while removing all data.
Example5