AddContact

Overview

Adds a contact to the database via an http form post. A successful post will return a success message and the contactid for the new contact.

URL

POST/api/2/AddContact.aspx

Parameters

FieldMax LengthRequiredNotes
response_typefalseSet this field value to json to return results in JSON format
accountidtrueMust be numeric. Account ID for this account.
Found in Settings > API Settings or for White Label CRM in the Admin control panel
apikeytrueAPI Key for this account.
Found in Settings > API Settings or for White Label CRM in the Admin control panel
teammemberidfalseMust be numeric. Team Member ID.
Defaults to 0 (Account Owner). If a team member is selected AND the contact is "own" a member database, the new contact will be put to the database that the user shares.
firstname50trueDatabase requires both first and last name
lastname50trueDatabase requires both first and last name
birthday10falseBirthday year is optional. Use only formats MM/DD or MM/DD/YYYY. Zero pad leading digits, so month and day are always 2 digits. January 5th is 01/05.
otherfirstname50false
otherlastname50false
otherbirthday10falseBirthday year is optional. Use only formats MM/DD or MM/DD/YYYY. Zero pad leading digits, so month and day are always 2 digits. January 5th is 01/05.
company50false
address50false
city50false
state20falseRecommended that this be the 2 digit state code for US addresses
postalcode20false
phone120falseWill automatically be formatted to (xxx) xxx-xxxx
phone1note20falseRecommended that description is used if known (work, home, mobile, etc...)
phone1textsignin1falseUse value of "1" to opt in Phone 1 for texting
phone220falseWill automatically be formatted to (xxx) xxx-xxxx
phone2note20false
phone2textsignin1falseUse value of "1" to opt in Phone 2 for texting
phone320falseWill automatically be formatted to (xxx) xxx-xxxx
phone3note20false
phone3textsignin1falseUse value of "1" to opt in Phone 3 for texting
phone420falseWill automatically be formatted to (xxx) xxx-xxxx
phone4note20false
phone4textsignin1falseUse value of "1" to opt in Phone 4 for texting
email75false
otheremail75false
custom150falseRecommended that you only use custom fields when user's exact custom field mapping is known
custom2050falseCustom 1 through 20
memo50falseBrief memo for contact. This is not a note, but a brief memo that shows up on the contact's page. Recommended less than 100 characters.
category50falseMust match the name of an existing Category exactly. Any mismatch will result in the category not being assigned. This is the default category
category250falseMust match the name of an existing Category2 exactly. Any mismatch will result in the category2 not being assigned. (This is the secondary category)
source50falseMust match the name of an existing Source exactly. Any mismatch will result in the source not being assigned.
othersystemid32falseFor tracking the ID of this contact in another system
addednotefalseWhen a contact is added via the API, a note is added to the contact record. The default is "Added via API" but you can override the default note with this field.
referredbyidfalseThe Contact ID of the referring contact.
adddatefalseOverride the default current timestamp. Also include a timezone if you want to set a timezone.
If you don't know a time, we suggest you use "now" for your timezone, in which case the displayed date may be a day early based on timezones.
Example: 10/04/2017 2:03PM