The same CRM your team uses
Leads, contacts, companies, and opportunities, with the same status values the product uses. A related company, contact, or opportunity has to already belong to that workspace.
← Back to home
IntegrationREST APIProfessional & Enterprise
Your CRM, research, and email — from the application you build
The YouEx.ai REST API is the contract for your own application. It covers the CRM operations an assistant can already perform, plus engagement, email drafts, lists, and campaigns. Calls run as a signed-in user, inside one workspace.
Base URL
https://engage.youex.ai/api/v1
Production. Paths below are relative to this base. Included on Professional and Enterprise.
- Create, read, update, and delete leads, contacts, companies, and opportunities
- Read engagement and stored research, and start a new research run
- Draft, send, and schedule email, and manage lists and campaigns
- OAuth for a signed-in user, scoped to one workspace
- Included on Professional and Enterprise
Choose a surface
REST when the caller is your code
MCP
For Claude, ChatGPT, and other assistants. The REST API covers the same CRM operations except the three ChatGPT widgets, which are not REST resources.
Learn moreZapier
For no-code workflows. Zapier uses its own API and is included on Professional and Enterprise.
Learn moreSalesforce
The AgentExchange app runs inside Salesforce. The REST API is for an application you build.
Learn moreWhat you can build
A supported way to operate the live workspace
Use it when the work belongs in your product: a routing service, an internal console, a data sync, or a partner integration. Records, research, and email stay in YouEx.ai. Your application calls them.
Research and engagement
Pull a workspace summary, a lead’s page views, conversations, and history, and the stored research report for a lead, contact, or company. Start a new research run when the brief is stale.
Actions and reminders
Log or schedule a meeting, text, email, call, or other action, and read or update reminders. Actions attach to a lead, contact, company, or opportunity.
Email your application can send
Create, update, send, and schedule drafts for leads and contacts. Manage topics, lists, list members, and campaigns from the same API.
One workspace at a time
Every call runs in a workspace the user belongs to. A token does not open every workspace on the account. Send X-YouEx-Workspace-Id when the user has more than one.
Resources
82 routes on engage.youex.ai/api/v1
Ids travel in the path. Filters travel in the query. Creates and updates are JSON. A path id overrides the same field in the body. Lists accept cursor, limit, searchTerm, and, where that route publishes them, status, tag, and timeframe. When a list has more rows, send the returned cursor back as cursor.
Workspace summary
Counts and pipeline totals for the workspace.
| Method | Path | Scope | Purpose |
|---|---|---|---|
| GET | /summary | crm:read | Workspace summary |
Leads
List, find, create, update, and delete leads. Read engagement, page views, conversations, history, and research, or start a new research run. Bulk delete matches exact email addresses.
| Method | Path | Scope | Purpose |
|---|---|---|---|
| GET | /leads | crm:read | List leads |
| POST | /leads | crm:write | Create a lead |
| GET | /leads/find | crm:read | Find leads |
| POST | /leads/bulk-delete | crm:write | Delete leads by email |
| GET | /leads/:id | crm:read | Read one lead |
| PATCH | /leads/:id | crm:write | Update a lead |
| DELETE | /leads/:id | crm:write | Delete a lead |
| GET | /leads/:id/engagement | crm:read | Page views, clicks, and chats |
| GET | /leads/:id/page-views | crm:read | Page-view events |
| GET | /leads/:id/conversations | crm:read | Chat transcripts |
| GET | /leads/:id/history | crm:read | Lifecycle history |
| GET | /leads/:id/research | crm:read | Stored research report |
| POST | /leads/:id/research | crm:write | Start a research run |
Contacts
The same record operations as leads, including stored research and a new research run.
| Method | Path | Scope | Purpose |
|---|---|---|---|
| GET | /contacts | crm:read | List contacts |
| POST | /contacts | crm:write | Create a contact |
| GET | /contacts/find | crm:read | Find contacts |
| GET | /contacts/:id | crm:read | Read one contact |
| PATCH | /contacts/:id | crm:write | Update a contact |
| DELETE | /contacts/:id | crm:write | Delete a contact |
| GET | /contacts/:id/research | crm:read | Stored research report |
| POST | /contacts/:id/research | crm:write | Start a research run |
Companies
Company records with industry, website, type, and status, plus research.
| Method | Path | Scope | Purpose |
|---|---|---|---|
| GET | /companies | crm:read | List companies |
| POST | /companies | crm:write | Create a company |
| GET | /companies/find | crm:read | Find companies |
| GET | /companies/:id | crm:read | Read one company |
| PATCH | /companies/:id | crm:write | Update a company |
| DELETE | /companies/:id | crm:write | Delete a company |
| GET | /companies/:id/research | crm:read | Stored research report |
| POST | /companies/:id/research | crm:write | Start a research run |
Opportunities
Deals with amount, stage, probability, and close date. Opportunities do not have a research report.
| Method | Path | Scope | Purpose |
|---|---|---|---|
| GET | /opportunities | crm:read | List opportunities |
| POST | /opportunities | crm:write | Create an opportunity |
| GET | /opportunities/find | crm:read | Find opportunities |
| GET | /opportunities/:id | crm:read | Read one opportunity |
| PATCH | /opportunities/:id | crm:write | Update an opportunity |
| DELETE | /opportunities/:id | crm:write | Delete an opportunity |
Actions and reminders
Logged or scheduled actions use the types meeting, text, email, call, and other. List actions with objectType and objectId.
| Method | Path | Scope | Purpose |
|---|---|---|---|
| GET | /crm-actions | crm:read | List actions for a record |
| POST | /crm-actions | crm:write | Log or schedule an action |
| PATCH | /crm-actions/:id | crm:write | Update an action |
| DELETE | /crm-actions/:id | crm:write | Delete an action |
| GET | /crm-reminders | crm:read | List CRM reminders |
| GET | /reminders | crm:read | List reminders |
| POST | /reminders | crm:write | Create a reminder |
| GET | /reminders/:id | crm:read | Read one reminder |
| PATCH | /reminders/:id | crm:write | Update a reminder |
| DELETE | /reminders/:id | crm:write | Delete a reminder |
Email drafts
Drafts belong to a lead or a contact. Send from the draft path. Schedule with recordType of lead or contact, the record id, and scheduledAt.
| Method | Path | Scope | Purpose |
|---|---|---|---|
| GET | /leads/:leadId/email-drafts | crm:read | List lead drafts |
| POST | /leads/:leadId/email-drafts | crm:write | Create a lead draft |
| GET | /leads/:leadId/email-drafts/:draftId | crm:read | Read a lead draft |
| PATCH | /leads/:leadId/email-drafts/:draftId | crm:write | Update a lead draft |
| DELETE | /leads/:leadId/email-drafts/:draftId | crm:write | Delete a lead draft |
| POST | /leads/:leadId/email-drafts/:draftId/send | crm:write | Send a lead draft |
| GET | /contacts/:contactId/email-drafts | crm:read | List contact drafts |
| POST | /contacts/:contactId/email-drafts | crm:write | Create a contact draft |
| GET | /contacts/:contactId/email-drafts/:draftId | crm:read | Read a contact draft |
| PATCH | /contacts/:contactId/email-drafts/:draftId | crm:write | Update a contact draft |
| DELETE | /contacts/:contactId/email-drafts/:draftId | crm:write | Delete a contact draft |
| POST | /contacts/:contactId/email-drafts/:draftId/send | crm:write | Send a contact draft |
| POST | /email-drafts/:draftId/schedule | crm:write | Schedule a draft |
Topics, lists, and campaigns
Topics, lists, and campaigns for outbound email. Add list members directly, from tags, or from a date range, then read and update the campaign and its drafts.
| Method | Path | Scope | Purpose |
|---|---|---|---|
| GET | /email-topics | crm:read | List topics |
| POST | /email-topics | crm:write | Create a topic |
| GET | /email-topics/:id | crm:read | Read a topic |
| PATCH | /email-topics/:id | crm:write | Update a topic |
| DELETE | /email-topics/:id | crm:write | Delete a topic |
| GET | /email-lists | crm:read | List email lists |
| POST | /email-lists | crm:write | Create an email list |
| GET | /email-lists/:id | crm:read | Read an email list |
| PATCH | /email-lists/:id | crm:write | Update an email list |
| DELETE | /email-lists/:id | crm:write | Delete an email list |
| GET | /email-lists/:emailListId/members | crm:read | List members |
| POST | /email-lists/:emailListId/members | crm:write | Add members |
| POST | /email-lists/:emailListId/members/from-tags | crm:write | Add members from tags |
| POST | /email-lists/:emailListId/members/from-date-range | crm:write | Add members from a date range |
| GET | /email-lists/:emailListId/members/:leadId | crm:read | Read a list member |
| DELETE | /email-lists/:emailListId/members/:leadId | crm:write | Remove a list member |
| GET | /email-lists/:emailListId/campaigns | crm:read | Campaigns on a list |
| GET | /email-list-campaigns/:campaignId | crm:read | Read a campaign |
| PATCH | /email-list-campaigns/:campaignId | crm:write | Update a campaign |
| DELETE | /email-list-campaigns/:campaignId | crm:write | Delete a campaign |
| GET | /email-list-campaigns/:campaignId/members | crm:read | Campaign members |
| PATCH | /email-list-campaigns/:campaignId/drafts/:draftId | crm:write | Update a campaign draft |
| DELETE | /email-list-campaigns/:campaignId/drafts/:draftId | crm:write | Delete a campaign draft |
Security
Workspace data stays in that workspace
- Calls run as the signed-in user, in one workspace that user belongs to
- Owners and Admins provision the OAuth client. YouEx registers the redirect URL
- Engagement reads omit IP address, precise location, and raw user agent
- Research text is omitted from list and search results
- A reference to a record in another workspace is rejected
Who this is for
Product and engineering
Put YouEx records, research, and email into an internal tool or a product you ship.
RevOps
Keep a warehouse, a routing service, or a custom workflow in step with the live CRM.
Partners
Call a supported contract instead of scraping the app or borrowing another product’s token.
FAQ
Common questions
Which plans include the REST API?
Professional and Enterprise. Seller and Prospector do not include it. A workspace without API access receives 403.
Is there an API key?
No. Your application signs the user in with Authorization Code and PKCE, then sends that user’s access token. There is no shared key and no client-credentials grant.
How do I choose a workspace?
Send X-YouEx-Workspace-Id. If you omit it and the user has one workspace with API access, that workspace is used. If they have several, the API returns 409 and the list of eligible workspaces.
What can a call change?
crm:read covers lists, lookups, the workspace summary, engagement, history, and research reads. crm:write covers create, update, delete, send, schedule, research refresh, and bulk delete. Write does not include read.
How is this different from MCP?
MCP is how an assistant operates the CRM in conversation. The REST API is how your own application does that work over HTTPS. ChatGPT’s interactive widgets are MCP-only.
Build against the CRM. Keep the workspace in YouEx.
The REST API, Zapier, and the Salesforce package are included on Professional and Enterprise. MCP is included on every plan.