Update opportunity with the Keap API

Updates the fields sent and returns the opportunity. Fields left out keep their values. Moving the opportunity to another stage is a change of stage_id.

Identifier
keap_update_opportunity

The request

POST https://connect.reportei.com/api/tools/keap_update_opportunity/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "opportunity_id": "<opportunity_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
opportunity_idstringYesId of the opportunity, from List opportunities or Create opportunity.
opportunity_titlestringNoTitle of the opportunity.
contact_idstringNoId of the contact, from List contacts.
stage_idstringNoId of the pipeline stage, from List opportunity stages.
user_idstringNoId of the user assigned to the opportunity, the id field of List users (not global_user_id).
projected_revenue_lownumberNoLow estimate of the revenue.
projected_revenue_highnumberNoHigh estimate of the revenue.
estimated_close_timestringNoExpected close date and time in ISO 8601, for example 2026-11-30T15:00:00Z.
next_action_timestringNoDate and time of the next action in ISO 8601.
next_action_notesstringNoWhat the next action is.
opportunity_notesstringNoGeneral notes.
include_in_forecastbooleanNoCounts the opportunity in the sales forecast.

Supported connections

Your customer connects their Keap account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/keap, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/keap_update_opportunity. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.