Ashley DeBon: /* Successful Response (200) */

2026-07-21T08:05:12Z

‎Successful Response (200)

Ashley DeBon: /* Update Opportunity */

2026-07-21T08:04:33Z

‎Update Opportunity

Ashley DeBon: Created page with "== Update Opportunity == === Base URL === https://apimobile.callproof.com === Endpoint === /api/opportunities/{id} === Purpose === Updates an existing opportunity, includin..."

2026-07-21T08:04:22Z

Created page with "== Update Opportunity == === Base URL === https://apimobile.callproof.com === Endpoint === /api/opportunities/{id} === Purpose === Updates an existing opportunity, includin..."

New page

== Update Opportunity ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/opportunities/{id}

=== Purpose ===
Updates an existing opportunity, including stage, owner, value, probability, close date, linked accounts/people, notes, and custom field values. Also records an opportunity history entry for the update.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| id || integer || Yes || Unique identifier of the opportunity to update
|}

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| opportunity_stage_id || integer || Yes || Opportunity stage identifier (must exist)
|-
| owner_id || integer || Yes || User ID of the opportunity owner (must exist)
|-
| form_data || string (JSON) || Yes || Custom field values for the opportunity (JSON string)
|-
| opportunity_name || string || No || Updated opportunity name
|-
| opportunity_type_id || integer || No || Opportunity type identifier
|-
| value || number || No || Opportunity value (numeric; values less than 1 are stored as 1)
|-
| probability || number || No || Win probability from 0 to 100
|-
| close_date || string (date) || No || Expected close date
|-
| notes || string || No || Opportunity notes
|-
| linked_accounts || string (JSON array) || No || JSON array of contact/account IDs to link (replaces existing linked accounts)
|-
| linked_contacts || string (JSON array) || No || JSON array of personnel IDs to link (replaces existing linked people)
|}

=== Successful Response (200) ===
Indicates that the opportunity was updated successfully.

{| class="wikitable"
! Field !! Type !! Description
|-
| clientStatusCode || integer || Status indicator for the client (for example, 200)
|-
| user_id || integer || Identifier of the authenticated user
|-
| company_id || integer || Identifier of the authenticated user’s company
|-
| message || string || Confirmation message (for example, "Opportunities Updated Successfully")
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failed – response body uses <code>clientStatusCode</code> 401 with the first validation error message
|-
| 500 || Server/update error – opportunity could not be updated
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Missing/invalid <code>opportunity_stage_id</code>, <code>owner_id</code>, or <code>form_data</code>; invalid <code>close_date</code>, <code>value</code>, or <code>probability</code>.
* '''500''' – Opportunity not found, custom field update failure, or another update error (for example, "Error while Updating Opportunities").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 08:04, 21 July 2026
Line 1:		Line 1:
−	== Update Opportunity ==	+	== [[Mobile_API]] »Update Opportunity ==

	=== Base URL ===		=== Base URL ===

@@ Line 61: / Line 61: @@
 | linked_contacts || string (JSON array) || No || JSON array of personnel IDs to link (replaces existing linked people)
 |}
 === Successful Response (200) ===

Update the Opportunity Details - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Update Opportunity */

Ashley DeBon: Created page with "== Update Opportunity == === Base URL === https://apimobile.callproof.com === Endpoint === /api/opportunities/{id} === Purpose === Updates an existing opportunity, includin..."