Update an opportunity

Updates the specified opportunity by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

patch

Update an opportunity

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

opportunityIdstringRequired

The ID of the opportunity.

Body

application/json

namestring · min: 1Optional

The name of the opportunity.

pipelineIdstringOptional

The ID of the opportunity pipeline.

stageIdstringOptional

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

patch

/v1/agents/{agentId}/opportunities/{opportunityId}

HTTPcURLJavaScriptPython

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

{
  "name": "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:17:22.177Z",
  "updatedAt": "2025-12-11T10:17:22.177Z",
  "removed": true,
  "tags": [
    "text"
  ]
}