canonical: https://jentic.com/apis/boast.io/boast

# Boast API

Jentic publishes the only available OpenAPI specification for Boast API, keeping it validated and agent-ready. Boast is a video and written testimonial collection platform that helps companies request, capture, and showcase customer feedback. The API exposes accounts, contacts, forms, responses, sequences, and webhook subscriptions so teams can automate testimonial outreach and embed responses into marketing workflows. Use it to enrol contacts in request sequences, fetch submitted testimonial responses, and react to new submissions in real time.

## For AI agents

Enrol contacts into testimonial request sequences, retrieve submitted video and written responses, and subscribe to Boast webhooks to react to new testimonials.

## Scope

Does not handle review moderation, video transcoding, or CRM contact sync - use for testimonial collection workflows only.

## Capabilities

- Enrol a contact into a testimonial request sequence and trigger automated outreach
- Retrieve submitted video and written testimonial responses for an account
- Create and remove webhook subscriptions to react to new responses in real time
- List forms used to collect customer testimonials across accounts
- Add new contacts to an account so they can be invited to leave testimonials
- Inspect sequence enrolments to track which contacts have been requested for feedback

## Use cases

### Automated Testimonial Collection

Enrol newly converted customers into a Boast sequence so they automatically receive a request to record a video or written testimonial. The API accepts the contact and sequence identifiers and Boast handles the email cadence, reminders, and form delivery. Teams use this to convert post-purchase signals into social proof without manual outreach.

Example prompt: Create a sequence_enrollment for contact ID 4521 in sequence ID 88 to send the post-purchase testimonial request

### Real-Time Response Pipeline

Subscribe to Boast webhook events to receive new testimonial responses the moment they are submitted, then route them into review, moderation, or publishing systems. The /accounts/{account_id}/webhook_subscriptions endpoints register and deregister these subscriptions. Useful for marketing teams who want to syndicate fresh testimonials to landing pages or CRM activity feeds.

Example prompt: POST a new webhook_subscription for account 17 pointing to https://example.com/webhooks/boast for response.created events

### Testimonial Library Sync

Pull every submitted response for an account on a schedule and sync it into a content management system or testimonial gallery. The /accounts/{account_id}/responses endpoint returns the full archive so agents can incrementally update local mirrors. This keeps marketing sites and sales decks current without manual exports.

Example prompt: GET /accounts/17/responses and write each response payload to the testimonials table

### AI Agent Testimonial Workflows

An AI agent uses Jentic to discover Boast operations by intent, then enrols contacts and registers webhooks without ever handling the bearer token directly. Search the catalogue with the natural-language query, load the operation schema, and execute the call through the Jentic SDK. Integration drops from days of OAuth and webhook plumbing to a single search-load-execute cycle.

Example prompt: Search Jentic for 'enrol a contact into a testimonial sequence', load the operation, and execute it for contact 4521

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /accounts | List accounts the token has access to |
| POST | /accounts/{account_id}/contacts | Create a contact within an account |
| GET | /accounts/{account_id}/responses | List all submitted testimonial responses |
| POST | /accounts/{account_id}/sequence_enrollments | Enrol a contact in a testimonial sequence |
| DELETE | /accounts/{account_id}/sequence_enrollments/{enrollment_id} | Remove a sequence enrolment |
| POST | /accounts/{account_id}/webhook_subscriptions | Subscribe to webhook events |
| DELETE | /accounts/{account_id}/webhook_subscriptions/{webhook_subscription_id} | Remove a webhook subscription |

## Key resources

- **Accounts** — Get the list of accounts you can access and inspect a specific account
- **Contacts** — Create and list contacts that can be invited to leave testimonials
- **Forms** — List the testimonial collection forms available within an account
- **Responses** — Retrieve submitted video and written testimonial responses
- **Sequences** — List request sequences and enrol contacts into them
- **Webhook Subscriptions** — Register and remove webhooks that fire on new responses

## Why Jentic

- **Setup:** Wiring Boast by hand means implementing its bearer auth and threading the account id through each testimonial call yourself. Through Jentic you install once, import Boast from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Boast puts the account id in the URL path (/accounts/{account_id}/contacts, /accounts/{account_id}/responses), so a rule can pin your agent to one account: it can add contacts and read responses there and nothing else. You choose the operations it may call, so deleting a sequence enrollment or webhook subscription is not included unless you add it.
- **Credential handling:** Your Boast bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'enroll a contact in a testimonial sequence' or 'list testimonial responses', and Jentic returns the matching Boast operation with its input schema so the agent calls the right endpoint without browsing the Boast docs.

## Related APIs

- **Bonusly API** — Bonusly captures internal employee recognition while Boast captures external customer testimonials.
- **BookingSync API** — Trigger a Boast testimonial request after a BookingSync rental stay completes.
- **Bonusly Recognition API** — An alternative source of social proof, focused on internal recognition rather than customer voice.

## FAQ

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

Boast does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Boast 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 Boast API use?

Boast uses HTTP Bearer authentication. You obtain an OAuth 2.0 access token by posting to https://app.boast.io/oauth/token, then send it as Authorization: Bearer <token>. Through Jentic the token is stored in the encrypted vault and never reaches the agent context.

### Can I enrol a contact into a testimonial sequence with the Boast API?

Yes. Send POST /accounts/{account_id}/sequence_enrollments with the contact_id and sequence_id in the body. Boast then runs the configured email cadence to request the testimonial.

### How do I subscribe to new testimonial responses in real time?

Register a webhook with POST /accounts/{account_id}/webhook_subscriptions and supply your callback URL. Boast will POST to that URL when new responses are submitted. Remove the subscription with DELETE on the same path.

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

Boast does not publish formal rate limits in this specification. Treat it as a low-volume marketing API and back off on HTTP 429 responses if encountered.

### How do I list all testimonials for my account through Jentic?

Search Jentic for 'list testimonial responses', load the GET /accounts/{account_id}/responses operation, then execute it with your account_id. The Jentic SDK handles auth and pagination.

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

Yes. Because you run Jentic One yourself, your own rules decide which Boast operations and credentials the agent can use. Since Boast puts the account id in the URL path, such as /accounts/{account_id}/contacts and /accounts/{account_id}/responses, you can pin the agent to a single account so it only adds contacts and reads responses there. You also choose the exact operations it may call, so destructive actions like deleting a sequence enrollment or removing a webhook subscription stay off limits unless you add them.