Change a User Plan

From Creately Developer

Jump to: navigation, search

Contents

Description

This method allows you to change the user plan. A user plan contains a set of permissions that applies to the user. Every user in Creately is assigned to a plan. To understand more about plan see Permission

Request

Request Details

URL https://creately.com/api/plan
HTTP Method POST
Supported Authentication SA
API Permissions This API call will required special permissions for the API Key to access.
User Permissions Not applicable

Request Parameters

Parameter Description Required Default Value
action Must contain the value "changeplan". Will indicate that this is a Plan changing action. Mandatory N/A
planid A valid Creately Plan ID to which the user plan needs to be switched. Note that your API Key will have limited permissions in which Plan ID's can be used. Please refer to Permission for further details Mandatory N/A
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 Will indicate if the request was successfully executed or not.

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 Change Plan method are:

Examples

Example 1

Request

https://creately.com/api/plan?apikey=2njk4234j23hkj23h4j2k3423jk4h&sig=jkn435654jk2j1kjh3mjk9&usr=johndoe@achme.com&action=changeplan&planid=plus-325494-01

Response

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