Follow

Create Account Profile

The Create Account Profile command allows you to create a new profile. The command allows you to set the Name and Description of the new profile.

The Create Account Profile command requires the following arguments: Command, Realm, Password, and Account Profile Field Name.

api_web?r=myrealm&p=mypass&c=acctproaddprofile&acct_pro_name=myprofile

The command is 'acctproaddprofile', the realm is 'myrealm', and the password is 'mypass'. The new profile will be named 'myprofile'.

Example

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

api_web?r=myrealm&p=mypass&c=acctproaddprofile&acct_pro_name=myprofile&acct_pro_desc=profiledescription

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

SUCCESS: 5

Results

The Create 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 new profile. The result format is:

SUCCESS: [profile_id]

Failure

The command will fail if a profile with the same name already exists 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=acctproaddprofile

c=acctproaddprofile

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 Name Yes

Name of the profile to create. To include spaces, use + or %20 to avoid possible issues with spaces in a URL.

acct_pro_name=[profile_name]

Profile Description  

Applies description to new 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