PayPilot API
Live demoGitHub
HomeGuidesSDKsContext PluginAPI Reference
Growth

Add an opportunity by hand

POST
/api/v1/opportunities

For something the detector cannot see - a lease ending, a competitor closing, a supplier deal. It behaves like any detected opportunity from here on: it can be approved, turned into a campaign and measured. The nightly detection pass upserts by key and never touches a manual one.

Authorization

HTTPBearer
AuthorizationBearer <token>

JWT access token

In: header

Query Parameters

merchant_id?|

Optional merchant to act on. Must be one you are a member of.

Formatuuid

Header Parameters

X-Merchant-ID?string|null

Request Body

application/json

An opportunity a person spotted, not the detector.

confidence?number
Range0 <= value <= 1
Default0.5
effort?string
Default"MEDIUM"

Value in

  • "LOW"
  • "MEDIUM"
  • "HIGH"
estimated_value_monthly?number
Range0 <= value <= 100000000
Default0
impact?string
Default"MEDIUM"

Value in

  • "LOW"
  • "MEDIUM"
  • "HIGH"
kind?string
Lengthlength <= 32
Default"RETENTION"
recommended_action?string
Lengthlength <= 2000
Default""
summary?string
Lengthlength <= 2000
Default""
title*string
Length4 <= length <= 200

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/opportunities" \  -H "Content-Type: application/json" \  -d '{    "title": "string"  }'
{  "data": {},  "meta": {},  "success": true}

Opportunity Radar GET

Detected growth opportunities ranked by expected value, discounted by effort.

Run opportunity detection POST

Runs the deterministic detector and upserts the results. Idempotent: re-running refreshes existing opportunities rather than duplicating them, and never rolls back an opportunity a human has already acted on.