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.
Field | Max Length | Required | Notes |
---|---|---|---|
response_type | false | Set this field value to json to return results in JSON format | |
accountid | true | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
apikey | true | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
teammemberid | false | Must 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. | |
firstname | 50 | true | Database requires both first and last name |
lastname | 50 | true | Database requires both first and last name |
birthday | 10 | false | Birthday 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. |
otherfirstname | 50 | false | |
otherlastname | 50 | false | |
otherbirthday | 10 | false | Birthday 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. |
company | 50 | false | |
address | 50 | false | |
city | 50 | false | |
state | 20 | false | Recommended that this be the 2 digit state code for US addresses |
postalcode | 20 | false | |
phone1 | 20 | false | Will automatically be formatted to (xxx) xxx-xxxx |
phone1note | 20 | false | Recommended that description is used if known (work, home, mobile, etc...) |
phone1textsignin | 1 | false | Use value of "1" to opt in Phone 1 for texting |
phone2 | 20 | false | Will automatically be formatted to (xxx) xxx-xxxx |
phone2note | 20 | false | |
phone2textsignin | 1 | false | Use value of "1" to opt in Phone 2 for texting |
phone3 | 20 | false | Will automatically be formatted to (xxx) xxx-xxxx |
phone3note | 20 | false | |
phone3textsignin | 1 | false | Use value of "1" to opt in Phone 3 for texting |
phone4 | 20 | false | Will automatically be formatted to (xxx) xxx-xxxx |
phone4note | 20 | false | |
phone4textsignin | 1 | false | Use value of "1" to opt in Phone 4 for texting |
75 | false | ||
otheremail | 75 | false | |
custom1 | 50 | false | Recommended that you only use custom fields when user's exact custom field mapping is known |
custom20 | 50 | false | Custom 1 through 20 |
memo | 50 | false | Brief 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. |
category | 50 | false | Must match the name of an existing Category exactly. Any mismatch will result in the category not being assigned. This is the default category |
category2 | 50 | false | Must match the name of an existing Category2 exactly. Any mismatch will result in the category2 not being assigned. (This is the secondary category) |
source | 50 | false | Must match the name of an existing Source exactly. Any mismatch will result in the source not being assigned. |
othersystemid | 32 | false | For tracking the ID of this contact in another system |
addednote | false | When 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. | |
referredbyid | false | The Contact ID of the referring contact. | |
adddate | false | Override 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 |