Create an opportunity

When creating an opportunity, you must specify the pipeline and stage to which the opportunity belongs, along with the customer linked to the opportunity.

post

Create a new opportunity

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

Body

application/json

namestring · min: 1Required

The name of the opportunity.

customerIdstringRequired

The ID of the customer associated with the opportunity.

pipelineIdstringRequired

The ID of the opportunity pipeline.

stageIdstringRequired

The ID of the pipeline stage.

ownerIdstring · nullableOptional

The ID of the user that own the opportunity.

scoreinteger · max: 100 · nullableOptional

The score indicating the likelihood of closing the opportunity.

amountnumber · nullableOptional

The monetary value of the opportunity, if applicable.

tagsstring[]Optional

The tags associated with the opportunity.

Responses

200

Successful Response

application/json

This an object representing a sales opportunity.

idstringOptional

The ID of the opportunity.

namestringOptional

The name of the opportunity.

customerIdstringOptional

The ID of the customer the opportunity belongs to.

ownerIdstring · nullableOptional

The ID of the owner of the opportunity.

scorenumber · nullableOptional

The score of the opportunity.

amountnumber · nullableOptional

The amount of the opportunity.

stageIdstringOptional

The ID of the stage the opportunity belongs to.

pipelineIdstringOptional

The ID of the pipeline the opportunity belongs to.

createdAtstring · date-timeOptional

The date and time the opportunity was created in ISO 8601 format.

updatedAtstring · date-timeOptional

The date and time the opportunity was last updated in ISO 8601 format.

removedbooleanOptional

Whether the opportunity has been removed.

tagsstring[]Optional

The tags associated with the opportunity.

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Validation Error

application/json

post

/v1/agents/{agentId}/opportunities

HTTPcURLJavaScriptPython

POST /v1/agents/{agentId}/opportunities HTTP/1.1
Host: api.voxity.ai
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "name": "text",
  "customerId": "text",
  "pipelineId": "text",
  "stageId": "text",
  "ownerId": "text",
  "score": 1,
  "amount": 1,
  "tags": [
    "text"
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "text",
  "name": "text",
  "customerId": "text",
  "ownerId": "text",
  "score": 1,
  "amount": 1,
  "stageId": "text",
  "pipelineId": "text",
  "createdAt": "2026-04-02T08:21:15.231Z",
  "updatedAt": "2026-04-02T08:21:15.231Z",
  "removed": true,
  "tags": [
    "text"
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}