Personal tools

switchvox.admins.myAccount.update

From SwitchvoxExtendAPI

Jump to: navigation, search

Contents

Description

Allows an admin user to update their own admin account.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.
Name Required Type Default Description
admin_id required integer ID of the admin account being updated.
password optional string The admin password.
language optional string en The language to be used for the admin.
locale optional string us The locale to be used for the admin.

Example Requests & Responses

Please see the API Request and Response Format section for more information on various request encodings.

Example One

Request

<request method="switchvox.admins.myAccount.update">
	<parameters>
		<admin_id>2</admin_id>
        	<password>abc1234</password>
        	<language>es</language>
	        <locale>mx</locale>
	</parameters>
</request>

Response

<response method="switchvox.admins.myAccount.update">
	<result>
		<success />
	</result>
</response>

Error Codes

See the Error Code Formatting section to see the xml structure when an error is returned.
See the Generic Error Codes section to see a list of general fault codes that may be returned.
Code Description
97579 Invalid admin_id (%1). Admin_ids may only contain digits.
99073 Invalid password. The password field must be 3-15 characters in length.
69143 Invalid language/locale code (%1).
88372 The requested admin_id (%1) does not exist.
27168 Your account is not permitted to run this action.