LEADS

Creates a new lead.

POST/api/v2/leads

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Request body

application/jsonrequired

The lead data to create.

ownerIdinteger · int32
descriptionstring
commentsstring
statusIdinteger · int32
sourceIdinteger · int32
sourcestringnullable
sourceLocationIdinteger · int32
assignedReasonIdsinteger[]
companyNamestring
address1string
address2string
citystring
zipstring
statestring
countrystring
countystring
faxstring
webstring
companyPhonestring
companyIdinteger · int32
contactIdinteger · int32
titlestring
positionstring
firstNamestring
lastNamestring
departmentstring
phonestring
cellstring
emailstring
sourceUrlstring
sourcePagestring
branchIdinteger · int32
makestring
modelstring
equipmentTypestring
enterTypestring

Responses

Lead created successfully.

Standard response envelopeisSuccessmessageerrorsdata

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

recordTypestringnullable
leadIDinteger · int32nullable
ownerIDinteger · int32nullable
statusIDinteger · int32nullable
sourceIDinteger · int32nullable
sourcestringnullable
sourceLocationIDinteger · int32nullable
sourceLocationstringnullable
ratingstringnullable
descriptionstringnullable
companyIDinteger · int32nullable
companyNamestringnullable
address1stringnullable
citystringnullable
statestringnullable
zipstringnullable
countystringnullable
countrystringnullable
contactIDinteger · int32nullable
contactNamestringnullable
firstNamestringnullable
lastNamestringnullable
emailstringnullable
phonestringnullable
cellstringnullable
equipmentIDinteger · int32nullable
makestringnullable
modelstringnullable
serialNostringnullable
stockNostringnullable
yearstringnullable
hoursinteger · int32nullable
attachmentsstringnullable
deletedbooleannullable
ownerNamestringnullable
statusNamestringnullable
commentsstringnullable
dateAssignedstring · date-timenullable
dateAcknowledgedstring · date-timenullable
dateConvertedstring · date-timenullable
address2stringnullable
faxstringnullable
titlestringnullable
positionstringnullable
companyPhonestringnullable
webstringnullable
departmentstringnullable
favoritebooleannullable
assignedReasonIDsinteger[]nullable
strAssignedReasonsstring[]nullable
assignedReasonsDisplaystringnullable
latitudenumber · doublenullable
longitudenumber · doublenullable
equipmentTypestringnullable
sourceUrlstringnullable
sourcePagestringnullable
branchstringnullable
associatedQuoteinteger · int32nullable
identifierstringnullable
branchIDinteger · int32nullable
closedbooleannullable
canAcknowledgeboolean

REQUEST EXAMPLE

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

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

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "recordType": "string",
    "leadID": 1024,
    "ownerID": 1024,
    "statusID": 1024,
    "sourceID": 1024,
    "source": "string",
    "sourceLocationID": 1024,
    "sourceLocation": "string",
    "rating": "string",
    "description": "string",
    "companyID": 1024,
    "companyName": "Acme Equipment Co.",
    "address1": "100 Main St",
    "city": "Chicago",
    "state": "IL",
    "zip": "60601",
    "county": "Cook",
    "country": "US",
    "contactID": 1024,
    "contactName": "Jane Doe",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com",
    "phone": "555-0100",
    "cell": "555-0100",
    "equipmentID": 1024,
    "make": "Caterpillar",
    "model": "320",
    "serialNo": "CAT0320XABC12345",
    "stockNo": "STK-1001",
    "year": "string",
    "hours": 3250,
    "attachments": "string",
    "deleted": false,
    "ownerName": "Jane Doe",
    "statusName": "string",
    "comments": "string",
    "dateAssigned": "2026-01-15T14:30:00Z",
    "dateAcknowledged": "2026-01-15T14:30:00Z",
    "dateConverted": "2026-01-15T14:30:00Z",
    "address2": "100 Main St",
    "fax": "555-0100",
    "title": "string",
    "position": "string",
    "companyPhone": "555-0100",
    "web": "https://example.com",
    "department": "string",
    "favorite": true,
    "assignedReasonIDs": [
      1024
    ],
    "strAssignedReasons": [
      "string"
    ],
    "assignedReasonsDisplay": "string",
    "latitude": 41.8781,
    "longitude": -87.6298,
    "equipmentType": "string",
    "sourceUrl": "https://example.com",
    "sourcePage": "string",
    "branch": "string",
    "associatedQuote": 1,
    "identifier": "string",
    "associatedOpportunity": {
      "opportunityId": 1024,
      "userId": 1024,
      "user": "string",
      "equipmentId": 1024,
      "companyId": 1024,
      "companyName": "Acme Equipment Co.",
      "contactId": 1024,
      "contact": "string",
      "statusId": 1024,
      "status": "string",
      "internalResult": "string",
      "groupId": 1024,
      "group": "string",
      "name": "string",
      "amount": 125000.5,
      "closeDate": "2026-01-15",
      "probability": 1.5,
      "deleted": false,
      "openDate": "2026-01-15",
      "branchId": 1024,
      "branch": "string",
      "lostSale": false,
      "saleTypeId": 1024,
      "saleType": "string",
      "transactionTypeId": 1024,
      "transactionType": "string",
      "make": "Caterpillar",
      "model": "320",
      "serialNo": "CAT0320XABC12345",
      "stockNo": "STK-1001",
      "year": "string",
      "hours": 3250,
      "qty": 1,
      "attachments": "string",
      "options": "string",
      "additionalEquipment": "string",
      "comments": "string",
      "decisionDate": "2026-01-15",
      "deliveryDate": "2026-01-15",
      "deliveryState": "string",
      "deliveryCounty": "string",
      "decisionComments": "string",
      "expirationDate": "2026-01-15",
      "referenceNo": "string",
      "lostRental": false,
      "rentalRate": 125000.5,
      "rentalInterval": "string",
      "rentalDuration": 1,
      "assignedReasons": [
        {
          "assignedId": 1024,
          "parentType": "string",
          "parentId": 1024,
          "reasonId": 1024,
          "reason": "string"
        }
      ],
      "udfs": [
        {
          "assignedId": 1024,
          "fieldName": "string",
          "displayText": "string",
          "recordType": "string",
          "recordId": 1024,
          "udfID": 1024,
          "lookupId": 1024,
          "stringValue": "string",
          "dateValue": "2026-01-15",
          "numericValue": 125000.5,
          "booleanValue": true
        }
      ],
      "competitors": [
        {
          "competitorId": 1024,
          "recordType": "string",
          "recordId": 1024,
          "competitorName": "string",
          "make": "Caterpillar",
          "model": "320",
          "serialNo": "CAT0320XABC12345",
          "equipYear": "string",
          "hours": 3250,
          "attachments": "string",
          "options": "string",
          "additionalEquipment": "string",
          "comments": "string",
          "quotedPrice": 125000.5,
          "rate": 125000.5,
          "terms": "string",
          "payment": 125000.5,
          "wonAgainst": true,
          "lostTo": false,
          "rentalInterval": "string",
          "rentalRate": 125000.5,
          "rentalDuration": 1
        }
      ],
      "recordAccessRights": {
        "exists": true,
        "view": true,
        "edit": true,
        "delete": true,
        "addNote": true
      }
    },
    "branchID": 1024,
    "closed": false,
    "canAcknowledge": true,
    "udfs": [
      {
        "udf": {
          "udfid": 1024,
          "recordType": "string",
          "categoryId": 1024,
          "subCategoryId": 1024,
          "category": "string",
          "categorySortOrder": 1,
          "subCategory": "string",
          "subCategorySortOrder": 1,
          "fieldName": "string",
          "displayText": "string",
          "dataType": "string",
          "editable": true,
          "visible": true,
          "required": true,
          "complete": true,
          "editCriteria": "string",
          "editRules": "string",
          "sortOrder": 1,
          "location": "string",
          "lastModified": "2026-01-15T14:30:00Z",
          "deleted": false
        },
        "lookups": [
          {
            "udflookupId": 1024,
            "udfid": 1024,
            "value": "string",
            "groupName": "string",
            "sortOrder": 1,
            "lastModified": "2026-01-15T14:30:00Z",
            "deleted": false
          }
        ],
        "assignedId": 1024,
        "udfid": 1024,
        "recordType": "string",
        "recordId": 1024,
        "lookupId": 1024,
        "stringValue": "string",
        "dateValue": "2026-01-15",
        "numericValue": 125000.5,
        "booleanValue": true,
        "entered": "2026-01-15T14:30:00Z",
        "lastModified": "2026-01-15T14:30:00Z"
      }
    ]
  },
  "errors": []
}