Appearance
Create an opportunity
POST
/api/nova/opportunities
Creates a new opportunity record. The request body accepts name, description, probability, forecasted closing date, start date, actual closing date, estimated duration in months, a stateId resolved against the account's opportunity states, and custom UDF fields. Creation is subject to the account's API usage limits and returns 429 when the limit is exceeded. On success the new opportunity's id is returned. Responds with 401 if the API key is invalid.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "actualClosingDate": "string", "bidCurrency": "string", "bidValue": 0, "companyId": "string", "contactId": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "estimatedDurationMonths": 0, "forecastedClosingDate": "string", "id": "string", "name": "string", "ownerId": "string", "probability": 0, "startDate": "string", "stateId": "string", "tags": [ { "group": "string", "value": "string" } ]
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "requestId": "string", "success": true
{
}