OPPORTUNITIES

Creates a new opportunity.

POST/api/v2/opportunities

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Request body

application/jsonrequired

namestring
companyIdinteger · int32
contactIdinteger · int32
groupIdinteger · int32
userIdinteger · int32
branchIdinteger · int32
commentsstring
statusIdinteger · int32
probabilitynumber · double
reasonIdsinteger[]
referenceNostring
openDatestring · date
closeDatestring · datenullable
decisionDatestring · datenullable
expirationDatestring · datenullable
deliveryDatestring · datenullable
deliveryStatestring
deliveryCountystring
decisionCommentsstring
lostSaleboolean
lostRentalboolean
saleTypeIdinteger · int32
transactionTypeIdinteger · int32
amountnumber · double
rentalIntervalstring
rentalRatenumber · double
rentalDurationinteger · int32
equipmentIdinteger · int32
makestring
modelstring
serialNostring
stockNostring
yearstring
hoursnumber · double
quantityinteger · int32
attachmentsstring
optionsstring
additionalEquipmentstring

Responses

Standard response envelopeisSuccessmessageerrorsdata

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

opportunityIdinteger · int32
userIdinteger · int32
userstring
equipmentIdinteger · int32
companyIdinteger · int32
companyNamestring
contactIdinteger · int32
contactstring
statusIdinteger · int32
statusstring
internalResultstring
groupIdinteger · int32
groupstring
namestring
amountnumber · double
closeDatestring · datenullable
probabilitynumber · double
deletedboolean
openDatestring · date
branchIdinteger · int32
branchstring
lostSaleboolean
saleTypeIdinteger · int32
saleTypestring
transactionTypeIdinteger · int32
transactionTypestring
makestring
modelstring
serialNostring
stockNostring
yearstring
hoursinteger · int32
qtyinteger · int32
attachmentsstring
optionsstring
additionalEquipmentstring
commentsstring
decisionDatestring · datenullable
deliveryDatestring · datenullable
deliveryStatestring
deliveryCountystringnullable
decisionCommentsstring
expirationDatestring · datenullable
referenceNostring
lostRentalboolean
rentalRatenumber · double
rentalIntervalstring
rentalDurationinteger · int32

REQUEST EXAMPLE

curl --request POST \
  'https://apiv2.crmseries.com/api/v2/opportunities' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string",
    "companyId": 1024,
    "contactId": 1024,
    "groupId": 1024,
    "userId": 1024,
    "branchId": 1024,
    "comments": "string",
    "statusId": 1024,
    "probability": 1.5,
    "reasonIds": [
      1024
    ],
    "referenceNo": "string",
    "openDate": "2026-01-15",
    "closeDate": "2026-01-15",
    "decisionDate": "2026-01-15",
    "expirationDate": "2026-01-15",
    "deliveryDate": "2026-01-15",
    "deliveryState": "string",
    "deliveryCounty": "string",
    "decisionComments": "string",
    "lostSale": false,
    "lostRental": false,
    "saleTypeId": 1024,
    "transactionTypeId": 1024,
    "amount": 125000.5,
    "rentalInterval": "string",
    "rentalRate": 125000.5,
    "rentalDuration": 1,
    "equipmentId": 1024,
    "make": "Caterpillar",
    "model": "320",
    "serialNo": "CAT0320XABC12345",
    "stockNo": "STK-1001",
    "year": "string",
    "hours": 3250,
    "quantity": 1,
    "attachments": "string",
    "options": "string",
    "additionalEquipment": "string",
    "udFs": [
      {
        "udfID": 1024,
        "lookupId": 1024,
        "stringValue": "string",
        "dateValue": "2026-01-15",
        "numericValue": 125000.5,
        "booleanValue": true
      }
    ],
    "competitors": [
      {
        "name": "string",
        "make": "Caterpillar",
        "model": "320",
        "year": "string",
        "hours": 3250,
        "quotedPrice": 125000.5,
        "rentalRate": 125000.5,
        "rentalInterval": "string"
      }
    ]
  }'

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

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "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
    }
  },
  "errors": []
}