Creating contacts

Use the following endpoint to create contacts:

  • POST contact/v1/contacts

For information on creating vendor contacts, see Vendor contacts.

Minimum creation criteria for contacts

All contacts must have a contact subtype and at least one contact tag. There are additional minimum criteria that vary based on the contact subtype, such as the following:

  • An ABPerson must have the following:
    • The contactSubtype set to ABPerson
    • At least one contact tag
    • A last name
    • At least one of the following: Tax ID, Phone, a complete Address, Date of Birth, or both Driver's License Number and State
  • An ABCompany must have the following:
    • The contactSubtype set to ABCompany
    • At least one contact tag
    • A name
    • At least one of the following: Tax ID, Phone, or a complete Address
Note: If you do not specify a name for an ABCompany, Cloud API returns the error message provided by ContactManager. This error message refers to the field as "Company Name", but the field (in both the ABContact resource and the ABContact data model entity) is "name".

The following creates a minimal ABPerson:

{
  "data": {
    "attributes": {
            "contactSubtype": "ABPerson",
            "lastName": "Kahlo",
            "tags": [
                {
                    "type": {
                        "code": "client"
                    }
                }
            ],
            "taxId": "000-00-0001"
    }
  }
}

The following creates a minimal ABCompany:

{
  "data": {
    "attributes": {
            "contactSubtype": "ABCompany",
            "name": "Cryptocurrents",
            "tags": [
                {
                    "type": {
                        "code": "client"
                    }
                }
            ],
            "taxId": "00-0000002"
    }
  }
}

Email addresses and phone numbers can also be specified in the payload.