canonical: https://jentic.com/apis/yespo.io/yespo-api

# Yespo API

Yespo omnichannel customer data and messaging platform API. Supports contacts, email, SMS, mobile push, Viber, Telegram, App Inbox messaging, broadcasts, events, orders, and account management. The API exposes 100 endpoints secured with basic authentication.

## For AI agents

Programmatically add or update a contact, delete contact by external id. Covers 100 operations with basic authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Add or update a contact
- Delete contact by external ID
- Subscribe a contact
- Search for contacts
- Get contact by ID

## Use cases

### CRM Operations

Use the Yespo API to perform crm operations programmatically. The API provides 100 endpoints covering core functionality including add or update a contact, delete contact by external id, subscribe a contact.

Example prompt: Call POST `/v1/contact` to add or update a contact

### Automated Account Management

Automate account operations by combining multiple Yespo API endpoints. Agents can delete contact by external id and then subscribe a contact in a single workflow.

Example prompt: Call DELETE `/v1/contact/{externalCustomerId}` to delete contact by external id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Yespo API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'add or update a contact', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/contact` | Add or update a contact |
| DELETE | `/v1/contact/{externalCustomerId}` | Delete contact by external ID |
| POST | `/v1/contact/subscribe` | Subscribe a contact |
| GET | `/v1/contacts` | Search for contacts |
| POST | `/v1/contacts/bulk` | Add or update contacts in bulk |
| POST | `/v1/contacts/file` | Add contacts from external file |
| GET | `/v1/contact/{id}` | Get contact by ID |
| PUT | `/v1/contact/{id}` | Update contact |

## Key resources

- **Account** — Operations for account
- **Addressbooks** — Operations for addressbooks
- **App** — Operations for app
- **App Inbox** — Operations for app inbox
- **Broadcast** — Operations for broadcast

## Why Jentic

- **Setup:** Wiring Yespo by hand means setting up HTTP basic auth against api.yespo.io/api, working through its large contact surface, and handling retries yourself. Through Jentic you install once, import Yespo from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Yespo puts the contact id in the URL path (`/contact/{id}`), so a rule can pin your agent to one contact: it can read and update that contact and nothing else. You choose the operations it may call, so destructive ones like deleting a contact or bulk imports are not included unless you add them.
- **Credential handling:** Your Yespo credential 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 'add or update a contact' or 'subscribe a contact', and Jentic returns the matching Yespo operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Yespo API use?

The Yespo API uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I add or update a contact with the Yespo API?

Yes. Use the POST `/v1/contact` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

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

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I add or update a contact through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'add or update a contact'. Jentic returns the matching Yespo API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Yespo API have?

The Yespo API exposes 100 endpoints covering account, addressbooks, app operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Yespo operations and credentials the agent may use, and it can only call the endpoints you allow. Since Yespo puts the contact id in the URL path, such as `/v1/contact/{id}`, you can pin the agent to a single contact so it reads and updates only that record. Destructive operations like DELETE `/v1/contact/{externalCustomerId}` or bulk imports through `/v1/contacts/bulk` stay off limits unless you explicitly grant them.