Yespo API
Browse all Yespo APIsOfficial vendor OpenAPI document · agent-readyCRMContact Managementbasic100 EndpointsREST
For Agents
Programmatically add or update a contact, delete contact by external id. Covers 100 operations with basic authentication.
Use for: I need to add or update a contact, I want to contact by external id, Search for subscribe a contact, Find all for contacts
Not supported: Does not handle payments, communications, or developer tools - use for crm only.
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.
Install Jentic One Beta
Connect the Yespo API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Yespo API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fyespo.io%2Fyespo-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fyespo.io%2Fyespo-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Yespo API.
Add or update a contact
Delete contact by external ID
Subscribe a contact
Search for contacts
Get contact by ID
Use Cases
Patterns agents use Yespo API for, with concrete tasks.
★ 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.
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.
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.
Search Jentic for 'add or update a contact', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
100 endpoints — yespo omnichannel customer data and messaging platform api.
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
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
Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Yespo API through Jentic.
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.
GET STARTED