LEADS

Creates a new lead from external source.

POST/api/v2/leads/external

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentialsAPI key

Request body

application/jsonrequired

The lead data to create.

leadIdinteger · int32
companyNamestringnullable
namestringnullable
phonestringnullable
emailstringnullable
descriptionstringnullable
address1stringnullable
address2stringnullable
citystringnullable
statestringnullable
zipstringnullable
countystringnullable
countrystringnullable
cellstringnullable
commentsstringnullable
companyPhonestringnullable
webstringnullable
faxstringnullable
titlestringnullable
positionstringnullable
departmentstringnullable
ownerEmailstringnullable
sourcestringnullable
makestringnullable
modelstringnullable
equipmentTypestringnullable
branchstringnullable
sourceUrlstringnullable
sourcePagestringnullable

Responses

Lead created successfully.

Standard response envelopeisSuccessmessageerrorsdata

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

integer · int32

REQUEST EXAMPLE

curl --request POST \
  'https://apiv2.crmseries.com/api/v2/leads/external' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "leadId": 1024,
    "companyName": "Acme Equipment Co.",
    "name": "string",
    "phone": "555-0100",
    "email": "jane.doe@example.com",
    "description": "string",
    "address1": "100 Main St",
    "address2": "100 Main St",
    "city": "Chicago",
    "state": "IL",
    "zip": "60601",
    "county": "Cook",
    "country": "US",
    "cell": "555-0100",
    "comments": "string",
    "companyPhone": "555-0100",
    "web": "https://example.com",
    "fax": "555-0100",
    "title": "string",
    "position": "string",
    "department": "string",
    "ownerEmail": "jane.doe@example.com",
    "source": "string",
    "make": "Caterpillar",
    "model": "320",
    "equipmentType": "string",
    "branch": "string",
    "sourceUrl": "https://example.com",
    "sourcePage": "string",
    "userDefinedFields": [
      {
        "fieldName": "string",
        "fieldValue": "string",
        "recordType": "string"
      }
    ]
  }'

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

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": 1,
  "errors": []
}