Follow

Update Account Profile

The Update Account Profile command allows you to change the Name and/or Description of the specified profile.

The Update Account Profile command requires the following arguments: Command, Realm, Password, and Profile ID.

api_web?r=myrealm&p=mypass&c=acctproupdateprofile&acct_pro_id=123

The command is 'acctproupdateprofile', the realm is 'myrealm', and the password is 'mypass'. The ID of the desired profile is '123'.

Example

Using 'acctproupdateprofile' with all commands and arguments (please note the command is wrapped for display purposes only):

api_web?r=myrealm&p=mypass&c=acctproupdateprofile&acct_pro_id=123&acct_pro_name=myprofile&acct_pro_desc=myprofiledescription

Successful results return, where '123' is the ID of the updated profile:

SUCCESS:123

Results

The Update Account Profile command outputs either a SUCCESS or FAILURE message. 

Success

The command success message returns the SUCCESS message followed by the ID of the updated profile. The result format is:

SUCCESS: [profile_id]

Failure

The command will fail if a profile ID which does not exist is entered or invalid data is defined. The result format is:

FAILURE: [Reason]

Arguments

This command supports the following arguments:

Name Req? Description Argument
Command Yes Defines the command to use.

cmd=acctproupdateprofile

c=acctproupdateprofile

Realm Yes Name of the realm to run the command. This is required, and the command will fail if the realm and password do not match.

realm=[realm_name]

r=[realm_name]

Password Yes Authentication code for API access.  This is required, and the command will fail if the realm and password do not match.

pwd=[password]

p=[password]

Profile ID Yes Identifies the profile which should be updated acct_pro_id=[profile_id]
Profile Name   The new name which will be applied to the profile. To include spaces, use + or %20 to avoid possible issues with spaces in a URL. acct_pro_name=[profile_name]
Profile ID   The new description which will be applied to the profile. To include spaces, use + or %20 to avoid possible issues with spaces in a URL. acct_pro_desc=[profile_description]
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk