Créer une opportunité avec l'API Keap

Crée une opportunité pour un contact à une étape du pipeline et la renvoie. opportunity_title, contact_id et stage_id sont obligatoires.

Identifiant
keap_create_opportunity

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "opportunity_title": "<opportunity_title>",
    "contact_id": "<contact_id>",
    "stage_id": "<stage_id>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
opportunity_titlestringOuiTitle of the opportunity.
contact_idstringOuiId of the contact, from List contacts.
stage_idstringOuiId of the pipeline stage, from List opportunity stages.
user_idstringNonId of the user assigned to the opportunity, the id field of List users (not global_user_id).
projected_revenue_lownumberNonLow estimate of the revenue.
projected_revenue_highnumberNonHigh estimate of the revenue.
estimated_close_timestringNonExpected close date and time in ISO 8601, for example 2026-11-30T15:00:00Z.
next_action_timestringNonDate and time of the next action in ISO 8601.
next_action_notesstringNonWhat the next action is.
opportunity_notesstringNonGeneral notes.
include_in_forecastbooleanNonCounts the opportunity in the sales forecast.

Connexions possibles

Votre client connecte son compte Keap une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/keap, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/keap_create_opportunity. Il devient la définition de tool de votre agent sans conversion.

Autres tools Keap

Voir les 14 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.