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 | 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

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: 126

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

{
  "id": "text",
  "name": "text",
  "customerId": "text",
  "ownerId": "text",
  "score": 1,
  "amount": 1,
  "stageId": "text",
  "pipelineId": "text",
  "createdAt": "2025-12-11T10:14:26.958Z",
  "updatedAt": "2025-12-11T10:14:26.958Z",
  "removed": true,
  "tags": [
    "text"
  ]
}