If you have your own system and would like to update accounts without our dashboard, we have just created an API allowing you to do just that. This API is for server to server communication, in case you have your own CRM system or something similar to manage your customer base.
- Parameters (Bold are mandatory) if the optional parameters not supplied then there is no update to these fields
Parameter Name (Case Sensitive) |
Value |
Description |
Default Value |
User (mandatory) |
Admin’s username |
The admin’s username that matches the api_id |
|
api_id (mandatory) |
Admin’s Api Id |
The admin’s api_id that matches the username |
Generated from edit profile |
user_name (mandatory) |
User's user_name |
The user name of the user that need to update his profile |
|
fname |
Advertiser’s First Name |
Advertiser’s First Name |
|
lname |
Advertiser’s Last Name |
Advertiser’s Last Name |
|
|
Advertiser’s email |
Advertiser’s email |
|
phone |
Advertiser’s local phone |
Advertiser’s local phone |
|
package |
Package ID |
Set this package to this advertiser |
|
password |
Advertiser password |
* Minimum 6 Characters * Password must contains one letter and one number * Password cannot contain the following characters: #, %, &, + |
|
new_user_name |
User Name |
The new user name for this account |
|
group |
Group ID |
Set this group to this advertiser |
|
street_address |
Street Address |
The user's street address |
|
city |
City |
The user's city |
|
state |
US state short name (2 letters i.e. NJ, NY, CA) |
The user's state |
|
country |
Country |
The user's country |
|
zipcode |
Zip code |
The user's zip code |
|
timezone |
Time zone name as appear at the user's profile drop down |
The user's time zone |
|
cc_emails |
CC Emails separated by semi colon (;) limites to 240 characters |
CC Emails that will be sent notifications additinal to the user's email |
|
billing_email |
|
Email that will receive the user's bills instead of the user's email |
|
credits |
integer |
Number of credits to Add can be negative number in order to reduce credits i.e. 100 / -100 |
- Return Code
- If the API succeeds then it will return with status code 200 with the following message: “User updated successfully"
- If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.
Example:
https://mcpn.us/api?ev=updateProfile&user=adminuser&api_id=A1H444h07FhB65dn&user_name=adv_user_name&fname=Jhon&lname=Smith&email=jsmith@gmail.com&phone=17225555555&package=1203&new_user_name=janes@gmail.com
Comments
0 comments
Article is closed for comments.