Update Opportunity by ID (Partial)

๐Ÿงพ Update Opportunity by ID (Partial)

Endpoint: PATCH /api/v3/opportunities/{opportunityId}

Auth Required: โœ… Yes (Bearer Token)


๐Ÿ“ Description

Updates one or more fields of an existing opportunity by its ID. This endpoint is ideal for modifying individual fields like stage, name, or expected close date without resubmitting the full opportunity object.


๐Ÿ”ข URL Parameters

Parameter Type Required Description
opportunityId integer/string โœ… Yes Unique identifier of the opportunity.

๐Ÿ” Query Parameters

None.


๐Ÿ“ฅ Request Body

Content-Type: application/json

Only include the fields you want to update.

๐Ÿ”ง Sample Schema

{  "<fieldToUpdate>": "<newValue>",  "<anotherField>": true }  

๐Ÿ“ค Request Example

PATCH https://api.briefingedge.com/api/v3/opportunities/1001 Authorization: Bearer <token> Content-Type: application/json  {  "stageId": 5 }  

โœ… Success Response (200 OK)

Returns the updated Opportunity object.

Example:

{  "OpportunityID": 1001,  "Name": "Acme Expansion",  "StageID": 5,  "ExpectedCloseDate": "2025-10-01",  "Status": "Updated" }  

โŒ Error Responses

Code Message Description
400 Bad Request Invalid data or malformed request.
401 Unauthorized Missing or invalid bearer token.
404 Not Found No opportunity found with the given ID.
500 Internal Server Error Unexpected server-side failure.