Follow

Update Account Profile Values

The Update Account Profile Values command allows you to assign and change values saved in account profile fields.

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

api_web?r=myrealm&p=mypass&c=acctproupdatevalues&acct_pro_id=5&acct_pro_fields=acct_pro_city|acct_pro_state|acct_pro_zip^mycity|mystate|55555

The command is 'acctproupdatevalues', the realm is 'myrealm', and the password is 'mypass'. The desired account profile is defined in 'acct_pro_id', and the new field values are listed in 'acct_pro_fields'.

Example

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

api_web?r=myrealm&p=mypass&c=acctproupdatevalues&acct_pro_id=5&acct_pro_fields=acct_pro_city|acct_pro_state|acct_pro_zip^mycity|mystate|55555

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

SUCCESS: 5

Results

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

Success

The command success message returns the SUCCESS message followed by the ID of the updated account 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=[cctproupdatevalues

c=[cctproupdatevalues

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 Declares the account profile to be updated. acct_pro_id=[profile_id]
Fields Yes Lists the fields and the values which will be inserted into the fields. Field names and Values must be separated by a delimiter: pipe (|).  To include spaces in the field values, use %20 to avoid possible issues with spaces in a URL.   acct_pro_fields=[fields]^[values]
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk