Create a new opportunity in your sales pipeline with basic opportunity information and custom values.
Endpoint: /action/opportunities/create
Method: POST
Request Body (example):
{
"name": "",
"description": "",
"clientName": "",
"stageName": "",
"value": 0.00,
"estCloseDate": "2023-07-20",
"leadInfo": {
"firstName": "",
"lastName": "",
"email": "",
"phone": "",
"role": "",
"businessName": "",
"website": "",
"address1": "",
"address2": "",
"city": "",
"locality": "",
"postal": "",
"country": "",
"sourceUrl": "",
"leadSource": "",
"answers": [
{
"fieldKey": "",
"question": "",
"answer": ""
}
]
},
"toDos": [
{
"item": "Do something",
"complete": false,
"dueDate": "2023-07-20"
}
],
"customValues": {
"Field1 Name": "Value",
"Field2 name": "Value"
}
}
Properties that require further clarification:
name - Required - Opportunity Name
clientName - Optional - Exact match of a client name in the CRM
stageName - Optional - If provided, must match an exact stage name in your pipeline
leadInfo.answers - Optional - Array of answer objects to capture additional questions and answers.
fieldKey - Required - used as the property on the field for reporting and token mapping
question - Required - the question text associated with this answer object
answer - Required - the answer the person provided to your question
customValues - Optional - map of custom fields. The left side of the map must match exactly to fields specified in your pipeline settings custom fields setup.