v1

latestOpenAPI 3.1.02026-07-1451089.2 KB

Create a contact

Create a new contact. All contacts are scoped to a particular team so a teamKey is required. When creating a contact you can provide all of the contact info in a single call. See the possible parameters below.

Contacts must have at least one of name or emailaddresses set.

Note: Including the parameter getIfExisting limits the parameters you can include in the call.

post/teams/{teamKey}/contacts/

Path parameters

teamKeystring required

Team key

Query parameters

getIfExistingboolean

If set to true, will check for existing contact based on email. If contact does exist, call will return existing contact; else, call will create new contact. Either way, the call will return a contact. If you include this parameter, the call can only take a teamKey and a contact's emailAddresses. If you have more information on your contact, you'll need to run a separate call to update it. See <b>Update a contact</b>.

Request body

givenNamestring

First name

familyNamestring

Last name

emailAddressesstring[] required

The only email addresses associated with the contact will be the ones you include here; make sure to include any previously associated addresses as well as the new one(s).

titlestring

Contact's title/description

otherstring

Notes or other uncategorized information.

addressesstring[]

The only addresses associated with the contact will be the ones you include here; make sure to include any previously associated addresses as well as the new one(s).

phoneNumbersstring[]

The only phone numbers associated with the contact will be the ones you include here; make sure to include any previously associated numbers as well as the new one(s).

twitterHandlestring

facebookHandlestring

linkedinHandlestring

photoUrlstring

Response

200

teamKeystring

givenNamestring

familyNamestring

titlestring

emailAddressesstring[]

phoneNumbersstring[]

addressesstring[]

creationDateinteger

keystring

lastSavedTimestampinteger

Example response

{
  "teamKey": "agxzfm1haWxmb29nYWVyEQsSBFRlYW0YgICIvJO1pQgM",
  "givenName": "Billie",
  "familyName": "Jean",
  "title": "Not my lover",
  "emailAddresses": [
    "mjackson@gmail.com"
  ],
  "phoneNumbers": [
    "919.989.9909"
  ],
  "addresses": [
    "1005 Cherry Street"
  ],
  "creationDate": 1501633590512,
  "key": "VGVhbUNvbnRhY3Qsfn5zdHJlYWtsb25naWR-fjc1MTg3NDcyMDY",
  "lastSavedTimestamp": 1501633590850
}