canonical: https://jentic.com/apis/oppbot.com/oppbot

# OppBot API

Jentic publishes the only available OpenAPI specification for OppBot API, keeping it validated and agent-ready. OppBot is a sales-engagement platform that nurtures underserved leads into sales-ready opportunities for demand generation teams. The API exposes a small set of endpoints for managing prospects - listing, fetching, creating, updating, and deleting prospect records - and pushing prospects into outbound sequences. Authentication is a bearer token issued by OppBot to each customer workspace.

## For AI agents

Add and manage prospects in an OppBot workspace and push them into outbound nurture sequences using a bearer token, across 7 REST endpoints.

## Scope

Does not handle email sending infrastructure, calendaring, or CRM record-of-truth - use for OppBot prospect management and sequence enrolment only.

## Capabilities

- Add a prospect record with contact details and assign ownership
- Update a prospect's status, fields, or owner from another system
- Push a prospect into a named outbound sequence to start nurture
- Retrieve prospect records by ID for sync into a CRM
- Remove a prospect record when the lead opts out or converts
- Verify a workspace's bearer token through the /me endpoint

## Use cases

### Inbound lead capture to OppBot nurture

When an inbound form fills, an automation agent can call POST `/prospect/store` to create the OppBot prospect and POST `/prospects/sequences/add` to drop them straight into a cold-outreach sequence. This shortens the gap between marketing capture and sales follow-up to seconds and removes the need for a CSV upload step.

Example prompt: POST `/prospect/store` with email, first_name, last_name, then POST `/prospects/sequences/add` to push the new prospect into the 'inbound-warm' sequence.

### CRM-to-OppBot sync

RevOps teams can keep OppBot in step with a CRM by treating the OppBot endpoints as the system of action. New CRM contacts trigger POST `/prospect/store`, status changes trigger PUT `/prospect/update/{id}`, and deletions trigger DELETE `/prospects/delete/{id}.` The /me endpoint provides a quick health check for the integration credentials.

Example prompt: On a CRM webhook, call PUT `/prospect/update/{id}` with the new title and company so the OppBot record matches the CRM.

### Prospect enrichment then sequence

Agents can enrich a prospect with a data provider, write the enriched fields back to OppBot via PUT `/prospect/update/{id}`, and then call POST `/prospects/sequences/add` only if the enrichment confidence clears a threshold. This avoids burning sequence sends on weak leads.

Example prompt: Enrich the prospect with Clearbit, PUT `/prospect/update/{id}` with the enriched company, then POST `/prospects/sequences/add` only when confidence > 0.8.

### AI agent for outbound demand gen

Through Jentic, an AI agent can answer 'add this person to our outbound flow' by translating it into a chained call: POST `/prospect/store` followed by POST `/prospects/sequences/add.` The bearer token sits in your Jentic One instance, so an SDR-assistant agent can run this multiple times a day without exposing the credential.

Example prompt: Search Jentic for 'add a prospect to oppbot and start a sequence', execute `/prospect/store` then `/prospects/sequences/add` for the supplied lead.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/me` | Test authentication for the workspace token |
| GET | `/prospects` | List prospects in the workspace |
| POST | `/prospect/store` | Add a new prospect |
| PUT | `/prospect/update/{id}` | Update an existing prospect |
| DELETE | `/prospects/delete/{id}` | Delete a prospect |
| POST | `/prospects/sequences/add` | Add a prospect to a sequence |

## Key resources

- **Prospects** — Create, list, update, and delete prospect records in the workspace
- **Sequences** — Add a prospect to a named outbound sequence
- **Me** — Test that the bearer token is valid for the calling workspace

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 62 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 45 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 46 / 100
- **View full report:** https://jentic.com/apis/oppbot.com/oppbot/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the OppBot API by hand means sending its bearer token on every call and keeping the prospect store, update, delete, and sequence-enrolment routes straight yourself. Through Jentic you install once, import the OppBot API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** OppBot puts the prospect id in the URL path (`/prospect/update/{id}`, `/prospects/delete/{id}`), so a rule can pin your agent to updating one prospect and nothing else. You choose the operations it may call, so deleting a prospect is not included unless you add it.
- **Credential handling:** Your OppBot bearer token is stored once, encrypted, by your own Jentic One instance and injected as the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'add a prospect to oppbot' or 'enrol a prospect in a sequence', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Outreach** — Enterprise sales-engagement platform for outbound sequences
- **Salesloft** — Sales engagement platform with cadences, dialer, and analytics
- **Apollo.io** — B2B contact database used to source the prospects fed into OppBot
- **Clearbit** — Contact and company enrichment used before pushing prospects into outbound

## FAQ

### Why is there no official OpenAPI spec for OppBot API?

OppBot does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call OppBot API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the OppBot API use?

The OppBot API uses an HTTP bearer token issued per workspace. Through Jentic the token is stored encrypted in the vault and added as the Authorization header on each call, so an agent never receives the raw token.

### Can I add a prospect to a sequence in one call with this API?

It takes two calls: POST `/prospect/store` creates the prospect and POST `/prospects/sequences/add` enrolls them in the named sequence. The two operations are commonly chained together by Jentic agents to mirror a one-step user intent.

### What are the rate limits for the OppBot API?

OppBot does not publish a fixed rate limit in this spec. Treat 429 responses with exponential backoff and check the OppBot workspace settings for any per-plan ceilings before running a high-volume sync.

### How do I delete a prospect through Jentic?

Search Jentic for 'delete an oppbot prospect', load the DELETE `/prospects/delete/{id}` operation, and execute it with the prospect ID. The vaulted bearer token is supplied automatically.

### How do I test that my OppBot token is working?

Call GET /me. A 200 response with workspace details confirms the bearer token is valid; any 401 or 403 indicates the token is missing, expired, or scoped to a different workspace.

### Can I limit what my agent is allowed to do with the OppBot API?

Yes. Because you run Jentic One yourself, your own rules decide which OppBot operations your agent may call, so you can allow POST `/prospect/store` and POST `/prospects/sequences/add` while leaving DELETE `/prospects/delete/{id}` off the list entirely. Since OppBot carries the prospect id in the URL path on PUT `/prospect/update/{id}` and DELETE `/prospects/delete/{id}`, a rule can pin the agent to a single prospect id rather than the whole workspace. Your bearer token is stored by your own instance and injected at call time, so the agent only ever exercises the operations and credentials you have granted it.