Remove User Account

From Creately Developer

Jump to: navigation, search

Contents

Description

This method is used to remove a existing Creately user account and its data. Only a API Key holder can access this method.

Request

Request Details

URL https://creately.com/api/user
HTTP Method POST
Supported Authentication SA
API Permissions This API call will require the API Key to have special permission to access this method. The user needed to be removed also must be a user registered by the same API Key.
User Permissions Not applicable

Request Parameters

Parameter Description Required Default Value
returnxml A boolean value indicating "true" or "false". Specifies if response should be a XML. Response will be sent in a XML if the value is true. Response will be sent in a serial string if the value is false. Optional true

NOTE: Parameters required by the authentication method must be provided. See what parameters are required in Authentication

Response

Response Details

Type XML
Content The response containing a success message. No additional data will be sent

Response Parameters

Tag Description
success Indicates if the request was successfully processed. May have true or false
errorcode Will be available if the success parameter was false. Will contain a valid API Error code. Valid error codes are listed in API Error Codes
message Will be available if the success parameter was false. Will contain a string message for the error

Errors

Refer to Errors related to Auth API calls in the Error Codes
Possible errors for Remove User method are:


Examples

Example 1

Request

https://creately.com/api/user?apikey=2njk4234j23hkj23h4j2k3423jk4h&sig=jkn435654jk2j1kjh3mjk9&uid=0d4fece0-0a10-4050-94e3-155270faceca

Response

	<creately-api-response>
 		<success>true</success>
 	</creately-api-response>
Personal tools