Get
/CloseUserAccount
The CloseUserAccount command closes a user account and removes all user information using an ID. This is usually a unique identifier used by the calling system.
Security
API Key: api_key
Header parameter nameapi_key
All methods require an API key, which must be obtained from Skillable. This key is used by Skillable to validate your account. The key can be passed as an HTTP request header with the header name "api_key".
Query parameters
userId
stringRequired
The ID of the user to retrieve. This is usually a unique identifier used by the calling system.
Example555
Responses
200
OK Response.
Example of successfully closing out a user account
{
"Status": 1,
"Error": null,
"RowsAffected": 25
}Example response when the user does not exist and no rows are affected
{
"RowsAffected": 0,
"Error": null,
"Status": 1
}object
Status
integer (int32)
Indicates the status of the API request.
0 = Error
1 = Success
Error
string | null
In the event of an error, this will contain a detailed error message. The status property will also be set to Error (0).
RowsAffected
integer (int32)
The number of database rows affected while removing all user data for the account.