CONTACT

Adds a new contact to a company.

POST/api/v2/external/contacts

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentialsAPI key

Request body

application/jsonrequired

The contact details.

deletedbooleannullable
sequenceNumberinteger · int32nullable
externalIdstringnullable
externalProviderstringnullable
modifySourcestringnullable
accountNumberstringnullable
firstNamestringnullable
middleNamestringnullable
lastNamestringnullable
nickNamestringnullable
phonestringnullable
cellstringnullable
faxstringnullable
emailstringnullable
titlestringnullable
positionstringnullable
departmentstringnullable
addRecordIfMatchNotFoundbooleannullable

Responses

Contact added successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

contactIdinteger · int32
companyIdinteger · int32
companyDisplaystring
firstNamestring
middleNamestring
lastNamestring
fullNamestring
nickNamestring
phonestring
cellstring
faxstring
emailstring
titlestring
positionstring
departmentstring
deletedboolean
activeboolean
enteredstring · date-time
lastModifiedstring · date-time
completeboolean
externalIdstring
globalUnsubscribeboolean
linkedboolean
lastTouchUserstring
lastTouchDatestring · datenullable

REQUEST EXAMPLE

curl --request POST \
  'https://apiv2.crmseries.com/api/v2/external/contacts' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "deleted": false,
    "sequenceNumber": 1,
    "externalId": "string",
    "externalProvider": "string",
    "modifySource": "string",
    "accountNumber": "string",
    "firstName": "Jane",
    "middleName": "string",
    "lastName": "Doe",
    "nickName": "string",
    "phone": "555-0100",
    "cell": "555-0100",
    "fax": "555-0100",
    "email": "jane.doe@example.com",
    "title": "string",
    "position": "string",
    "department": "string",
    "addRecordIfMatchNotFound": true
  }'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "contactId": 1024,
    "companyId": 1024,
    "companyDisplay": "string",
    "firstName": "Jane",
    "middleName": "string",
    "lastName": "Doe",
    "fullName": "Jane Doe",
    "nickName": "string",
    "phone": "555-0100",
    "cell": "555-0100",
    "fax": "555-0100",
    "email": "jane.doe@example.com",
    "title": "string",
    "position": "string",
    "department": "string",
    "deleted": false,
    "active": true,
    "entered": "2026-01-15T14:30:00Z",
    "lastModified": "2026-01-15T14:30:00Z",
    "complete": true,
    "externalId": "string",
    "globalUnsubscribe": true,
    "linked": true,
    "assignedPhones": [
      {
        "description": "string",
        "phone": "555-0100",
        "phoneId": 1024
      }
    ],
    "assignedEmails": [
      {
        "description": "string",
        "email": "jane.doe@example.com",
        "emailId": 1024
      }
    ],
    "lastTouchUser": "string",
    "lastTouchDate": "2026-01-15",
    "recordAccessRights": {
      "exists": true,
      "view": true,
      "edit": true,
      "delete": true,
      "addNote": true
    }
  },
  "errors": []
}