v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB

contacts

Create Contact

Use this endpoint to create a new contact.

This endpoint is rate limited. Use the RateLimit-* response headers to check current limits and remaining quota.

post/contacts

Request body

contactTypeIdsstring[]

firstNamestring

First name of the contact.

lastNamestring

Last name of the contact.

crossReferencestring

CrossReference of the contact.

companyNamestring

Company name of the contact.

companyJobTitlestring

Job title of the contact.

notestring

A note for the contact.

billingAddressSameAsMailingAddressboolean

Indicates if the billing address is the same as mailing address

Example request

{
  "contactTypeIds": [
    "52ba94c5-3ecf-4e7f-90cd-a91de12a72f5"
  ],
  "firstName": "John",
  "lastName": "Smith",
  "crossReference": "Cross reference.",
  "companyName": "Acme Roofing Inc.",
  "companyJobTitle": "Job title",
  "note": "This is a note",
  "phoneNumbers": [
    {
      "number": "8555551234",
      "ext": "234",
      "primary": true,
      "hasTextingAvailable": true,
      "type": "Home"
    }
  ],
  "emailAddresses": [
    {
      "address": "contactmail@mail.com",
      "primary": true
    }
  ],
  "mailingAddress": {
    "street1": "123 Main St.",
    "street2": "Apt 2",
    "city": "Peoria",
    "zipCode": "61603",
    "state": {
      "id": 43
    },
    "country": {
      "id": 1
    }
  },
  "billingAddress": {
    "street1": "123 Main St.",
    "street2": "Apt 2",
    "city": "Peoria",
    "zipCode": "61603",
    "state": {
      "id": 43
    },
    "country": {
      "id": 1
    }
  }
}

Response

Created

idstring uuid

_linkstring uri