COMPANY

Creates, updates or deletes a company

Requires authentication using either a JWT or API key. The specific operation (create, update, or delete) is determined by the contents of the request object. Returns appropriate HTTP status codes for success, validation errors, not found, or server errors.

POST/api/v2/external/companies

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentialsAPI key

Request body

application/jsonrequired

An object containing the external company data and the operation to perform. Cannot be null.

externalIdstring
modifySourcestringnullable
externalProviderstringnullable
branchCodestringnullable
prospectSourcestringnullable
recordTypestringnullable
deletedbooleannullable
categoriesstring[]nullable
companyNamestringnullable
legalNamestringnullable
accountNostringnullable
address1stringnullable
address2stringnullable
address3stringnullable
citystringnullable
statestringnullable
zipstringnullable
countystringnullable
countrystringnullable
mailingbooleannullable
latitudenumber · doublenullable
longitudenumber · doublenullable
phonestringnullable
faxstringnullable
webstringnullable
statusstringnullable
addRecordIfMatchNotFoundbooleannullable

Responses

Standard response envelopeisSuccessmessageerrorsdata

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

companyIdinteger · int32
parentIdinteger · int32
recordTypeIdinteger · int32
branchIdinteger · int32
companyNamestring
legalNamestring
accountNostring
address1string
address2string
address3string
citystring
statestring
zipstring
countystring
countrystring
mailingbooleannullable
latitudenumber · double
longitudenumber · double
phonestring
faxstring
webstring
linkedboolean
sourceIdinteger · int32
statusstring
enteredstring · date-time
lastModifiedstring · date-time
completeboolean
parentNamestring
parentAccountNostring
assignedRecordTypestring
assignedBranchstring
assignedNationalAccountsstring
assignedNationalAccountIdsstring
assignedSourcestring
buyIDstring

REQUEST EXAMPLE

curl --request POST \
  'https://apiv2.crmseries.com/api/v2/external/companies' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalId": "string",
    "modifySource": "string",
    "externalProvider": "string",
    "branchCode": "string",
    "ranks": [
      {
        "rankName": "string",
        "roleName": "string"
      }
    ],
    "prospectSource": "string",
    "recordType": "string",
    "deleted": false,
    "categories": [
      "string"
    ],
    "udfs": [
      {
        "fieldName": "string",
        "fieldValue": "string",
        "recordType": "string"
      }
    ],
    "salesReps": [
      {
        "salesCode": "string",
        "roleName": "string"
      }
    ],
    "companyName": "Acme Equipment Co.",
    "legalName": "Acme Equipment Co.",
    "accountNo": "string",
    "address1": "100 Main St",
    "address2": "100 Main St",
    "address3": "100 Main St",
    "city": "Chicago",
    "state": "IL",
    "zip": "60601",
    "county": "Cook",
    "country": "US",
    "mailing": true,
    "latitude": 41.8781,
    "longitude": -87.6298,
    "phone": "555-0100",
    "fax": "555-0100",
    "web": "https://example.com",
    "status": "string",
    "addRecordIfMatchNotFound": true
  }'

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

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "companyId": 1024,
    "parentId": 1024,
    "recordTypeId": 1024,
    "branchId": 1024,
    "companyName": "Acme Equipment Co.",
    "legalName": "Acme Equipment Co.",
    "accountNo": "string",
    "address1": "100 Main St",
    "address2": "100 Main St",
    "address3": "100 Main St",
    "city": "Chicago",
    "state": "IL",
    "zip": "60601",
    "county": "Cook",
    "country": "US",
    "mailing": true,
    "latitude": 41.8781,
    "longitude": -87.6298,
    "phone": "555-0100",
    "fax": "555-0100",
    "web": "https://example.com",
    "linked": true,
    "sourceId": 1024,
    "status": "string",
    "entered": "2026-01-15T14:30:00Z",
    "lastModified": "2026-01-15T14:30:00Z",
    "complete": true,
    "parentName": "string",
    "parentAccountNo": "string",
    "assignedRecordType": "string",
    "assignedBranch": "string",
    "assignedNationalAccounts": "string",
    "assignedNationalAccountIds": "string",
    "assignedSource": "string",
    "assignedRanks": [
      {
        "role": "string",
        "rank": "string",
        "roleID": 1024,
        "rankID": 1024,
        "editable": true,
        "availableRanks": [
          {
            "value": "string",
            "display": "string",
            "group": "string",
            "scope": "string",
            "dateRange": true
          }
        ]
      }
    ],
    "buyID": "string",
    "assignedCredits": [
      {
        "creditAmount": 125000.5,
        "creditType": "string",
        "comment": "string"
      }
    ],
    "assignedCategories": [
      {
        "categoryId": 1024,
        "categoryName": "string"
      }
    ],
    "recordAccessRights": {
      "exists": true,
      "view": true,
      "edit": true,
      "delete": true,
      "addNote": true
    }
  },
  "errors": []
}