Overview
Adds an team member to the database via an http form post. A successful post will return a success message and the teammemberid for the new team member.
Post Url
https://ReplaceWithYourWhiteLabelCRMDomain/api/2/AddTeamMember.aspx
- SSL is requred
Form Fields
Field | Max Length* | Required | Notes |
response_type | No | Default results will be returned in XML.Set this field value to json to return results in JSON format | |
apiusername | Yes | API User Name and password are assigned by AllClients | |
apipassword | Yes | API User Name and password are assigned by AllClients | |
accountid | Yes | Add this new team member to the account with this accountid | |
50 | Yes | ||
password | 50 | Yes | You need to assign a password, even if you are using other sign on methods |
user_level | 1 | Yes | “A” for Administrator
“P” for Power User “I” for Independent User “T” for Team Player
see http://www.allclients.com/team/ for more details |
display_fullname | 50 | Yes | |
display_initials | 5 | Yes | |
display_hexcolor | 6 | No | Default is FFFFFF – Leave off the “#” |
permission_sharetemplates | 1 | No | “1” for Yes
“0” for No (default) |
permission_groupedit | 1 | No | “1” for Yes
“0” for No (default) |
mailmerge_newsletter | 50 | No | Mail Merge Profile: Newsletter Title, ie: “John’s Newsletter” |
mailmerge_fullname | 50 | No | ie: “John Smith” |
mailmerge_company | 50 | No | |
mailmerge_address | 60 | No | ie: “123 Mail Street Suite A” |
mailmerge_citystatezip | 60 | No | ie: “Windsor, CA 95492” |
mailmerge_phone | 30 | No | |
mailmerge_email | 75 | No | |
mailmerge_website | 75 | No | Use full URL. ie: “http://www.mywebsite.com/” |
extra_field1 | 50 | No | Extra fields for your internal use. (Store an internal ID or whatever you’d like) |
extra_field2 | 50 | No | Extra fields for your internal use. (Store an internal ID or whatever you’d like) |
* An error will not result if Max Length is exceeded. Data will be trimmed to this length.
Sample Results
Success Message
<?xml version="1.0"?>
<results>
<message>Success</message>
<accountid>15631</accountid>
<teammemberid>232</teammemberid>
</results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>