> For the complete documentation index, see [llms.txt](https://docs.zaia.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zaia.app/documentation/api-reference-alpha/reference/connections.md).

# Connections

## GET /api/v1/connections

> Retrieves multiple connections.

```json
{"openapi":"3.1.0","info":{"title":"Public API","version":"1.0.0"},"servers":[{"description":"API Server","url":"https://api.endless.zaia.app"}],"paths":{"/api/v1/connections":{"get":{"description":"Retrieves multiple connections.","tags":["Connections"],"parameters":[{"schema":{"anyOf":[{"type":"array","items":{"type":"string","enum":["channels"]}},{"type":"string","enum":["channels"]}],"default":[]},"required":false,"name":"joins","in":"query"},{"schema":{"type":"number","minimum":1,"default":1,"description":"The page number."},"required":false,"description":"The page number.","name":"pageNumber","in":"query"},{"schema":{"type":"number","minimum":1,"maximum":100,"default":10,"description":"The page size."},"required":false,"description":"The page size.","name":"pageSize","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Search term to filter connections by name or description."},"required":false,"description":"Search term to filter connections by name or description.","name":"search","in":"query"},{"schema":{"anyOf":[{"type":"string","enum":["composio-airtable"]},{"type":"string","enum":["composio-asana"]},{"type":"string","enum":["composio-bannerbear"]},{"type":"string","enum":["composio-browseai"]},{"type":"string","enum":["composio-calendly"]},{"type":"string","enum":["composio-clickup"]},{"type":"string","enum":["composio-discord"]},{"type":"string","enum":["composio-dropbox"]},{"type":"string","enum":["composio-facebook"]},{"type":"string","enum":["composio-figma"]},{"type":"string","enum":["composio-genderize"]},{"type":"string","enum":["composio-github"]},{"type":"string","enum":["composio-gitlab"]},{"type":"string","enum":["composio-gmail"]},{"type":"string","enum":["composio-google-analytics"]},{"type":"string","enum":["composio-google-calendar"]},{"type":"string","enum":["composio-google-docs"]},{"type":"string","enum":["composio-google-drive"]},{"type":"string","enum":["composio-google-maps"]},{"type":"string","enum":["composio-google-meet"]},{"type":"string","enum":["composio-google-sheets"]},{"type":"string","enum":["composio-google-slides"]},{"type":"string","enum":["composio-google-tasks"]},{"type":"string","enum":["composio-hubspot"]},{"type":"string","enum":["composio-hugging-face"]},{"type":"string","enum":["composio-instagram"]},{"type":"string","enum":["composio-linear"]},{"type":"string","enum":["composio-linkedin"]},{"type":"string","enum":["composio-mailersend"]},{"type":"string","enum":["composio-manus"]},{"type":"string","enum":["composio-mem0"]},{"type":"string","enum":["composio-meta-ads"]},{"type":"string","enum":["composio-microsoft-clarity"]},{"type":"string","enum":["composio-miro"]},{"type":"string","enum":["composio-mixpanel"]},{"type":"string","enum":["composio-monday"]},{"type":"string","enum":["composio-notion"]},{"type":"string","enum":["composio-one-drive"]},{"type":"string","enum":["composio-openweather-api"]},{"type":"string","enum":["composio-outlook"]},{"type":"string","enum":["composio-polygon-io"]},{"type":"string","enum":["composio-postman"]},{"type":"string","enum":["composio-prisma"]},{"type":"string","enum":["composio-pushbullet"]},{"type":"string","enum":["composio-reddit"]},{"type":"string","enum":["composio-resend"]},{"type":"string","enum":["composio-salesforce"]},{"type":"string","enum":["composio-scrape-do"]},{"type":"string","enum":["composio-search-api"]},{"type":"string","enum":["composio-sendgrid"]},{"type":"string","enum":["composio-sentry"]},{"type":"string","enum":["composio-serpapi"]},{"type":"string","enum":["composio-short-io"]},{"type":"string","enum":["composio-short-menu"]},{"type":"string","enum":["composio-slack"]},{"type":"string","enum":["composio-slackbot"]},{"type":"string","enum":["composio-stripe"]},{"type":"string","enum":["composio-supabase"]},{"type":"string","enum":["composio-tavily"]},{"type":"string","enum":["composio-teams"]},{"type":"string","enum":["composio-telegram"]},{"type":"string","enum":["composio-ticktick"]},{"type":"string","enum":["composio-todoist"]},{"type":"string","enum":["composio-trello"]},{"type":"string","enum":["composio-twitter"]},{"type":"string","enum":["composio-typeform"]},{"type":"string","enum":["composio-youtube"]},{"type":"string","enum":["composio-zenrows"]},{"type":"string","enum":["waha"]},{"type":"string","enum":["whatsapp"]},{"type":"string","enum":["instagram"]},{"type":"string","enum":["telegram"]}],"description":"The type of the detail of the connection."},"required":false,"description":"The type of the detail of the connection.","name":"type","in":"query"},{"schema":{"type":"string","description":"The API key to use for authentication. Can be created in the api keys section on the workspace settings page."},"required":true,"description":"The API key to use for authentication. Can be created in the api keys section on the workspace settings page.","name":"authorization","in":"header"}],"responses":{"200":{"description":"Retrieves all connections for the workspace.","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"isRemoved":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"description":{"type":"string","nullable":true,"minLength":3,"maxLength":250,"description":"The internal description of the connection."},"detail":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-airtable"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-asana"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-bannerbear"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-browseai"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-calendly"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-clickup"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-discord"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-dropbox"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-facebook"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-figma"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-genderize"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-github"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-gitlab"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-gmail"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-analytics"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-calendar"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-docs"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-drive"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-maps"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-meet"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-sheets"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-slides"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-tasks"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-hubspot"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-hugging-face"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"sourceConnectionId":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-instagram"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-linear"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-linkedin"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-mailersend"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-manus"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-mem0"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-meta-ads"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-microsoft-clarity"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-miro"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-mixpanel"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-monday"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-notion"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-one-drive"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-openweather-api"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-outlook"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-polygon-io"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-postman"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-prisma"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-pushbullet"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-reddit"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-resend"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-salesforce"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-scrape-do"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-search-api"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-sendgrid"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-sentry"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-serpapi"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-short-io"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-short-menu"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-slack"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-slackbot"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-stripe"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-supabase"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-tavily"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-teams"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-telegram"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-ticktick"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-todoist"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-trello"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-twitter"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-typeform"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-youtube"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-zenrows"]}},"required":["id","status","type"]},{"type":"object","properties":{"accountId":{"type":"string","nullable":true,"description":"The provider account ID associated with the Instagram connection detail."},"code":{"type":"string","description":"The provider authorization code associated with the Instagram connection detail."},"id":{"type":"string","description":"The provider ID associated with the Instagram connection detail."},"name":{"type":"string","nullable":true,"minLength":3,"maxLength":50,"description":"The display name returned by the provider for the Instagram connection detail."},"reason":{"type":"string","nullable":true,"maxLength":500,"description":"The reason associated with the current Instagram connection status, when one exists."},"status":{"type":"string","enum":["pending","active","failed"],"description":"The lifecycle status of the Instagram connection detail."},"token":{"type":"string","nullable":true,"description":"The access token associated with the Instagram connection detail."},"type":{"type":"string","enum":["instagram"],"description":"The connection detail subtype represented by this payload."}},"required":["accountId","code","id","name","status","token","type"]},{"type":"object","properties":{"botId":{"type":"string","nullable":true,"description":"The Telegram bot ID associated with the connection detail."},"id":{"type":"string","description":"The provider ID associated with the Telegram connection detail."},"reason":{"type":"string","nullable":true,"maxLength":500,"description":"The reason associated with the current Telegram connection status, when one exists."},"status":{"type":"string","enum":["pending","active","failed"],"description":"The lifecycle status of the Telegram connection detail."},"token":{"type":"string","nullable":true,"description":"The bot token associated with the Telegram connection detail."},"type":{"type":"string","enum":["telegram"],"description":"The connection detail subtype represented by this payload."},"username":{"type":"string","nullable":true,"minLength":3,"maxLength":50,"description":"The display username returned by Telegram for the bot."},"webhookSecret":{"type":"string","nullable":true,"description":"The secret token used to validate Telegram webhook requests."}},"required":["botId","id","status","token","type","username","webhookSecret"]},{"type":"object","properties":{"id":{"type":"string"},"instanceId":{"type":"number","nullable":true},"lid":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"status":{"type":"string","enum":["pending","active","failed","inactive"]},"type":{"type":"string","enum":["waha"]}},"required":["id","instanceId","lid","phoneNumber","status","type"]},{"type":"object","properties":{"code":{"type":"string","description":"The provider authorization code associated with the WhatsApp connection detail."},"id":{"type":"string","description":"The provider ID associated with the WhatsApp connection detail."},"name":{"type":"string","nullable":true,"minLength":3,"maxLength":50,"description":"The display name returned by the provider for the WhatsApp connection detail."},"phoneNumber":{"type":"string","nullable":true,"description":"The phone number associated with the WhatsApp connection detail."},"phoneNumberId":{"type":"string","nullable":true,"description":"The provider phone number ID associated with the WhatsApp connection detail."},"reason":{"type":"string","nullable":true,"maxLength":500,"description":"The reason associated with the current WhatsApp connection status, when one exists."},"status":{"type":"string","enum":["pending","active","failed"],"description":"The lifecycle status of the WhatsApp connection detail."},"token":{"type":"string","nullable":true,"description":"The access token associated with the WhatsApp connection detail."},"type":{"type":"string","enum":["whatsapp"],"description":"The connection detail subtype represented by this payload."},"wabaId":{"type":"string","description":"The WABA ID associated with the WhatsApp connection detail."}},"required":["code","id","name","phoneNumber","phoneNumberId","status","token","type","wabaId"]}]},"name":{"type":"string","minLength":3,"maxLength":50,"description":"The display name of the connection."},"referenceId":{"type":"string","nullable":true,"format":"uuid","description":"The optional reference ID associated with the connection."},"workspaceId":{"type":"string","format":"uuid","description":"The workspace ID that owns the connection."},"channel":{"type":"object","nullable":true,"properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"isRemoved":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"delay":{"type":"integer","minimum":1,"maximum":60,"description":"The delay between the last user message and the beginning of the response generation."},"description":{"type":"string","nullable":true,"minLength":3,"maxLength":250,"description":"The internal description of the channel."},"detail":{"anyOf":[{"type":"object","properties":{"initialMessage":{"type":"string","nullable":true,"minLength":1,"maxLength":250,"description":"The initial message to be displayed when the API is used."},"responseWebhookUrl":{"type":"string","minLength":3,"maxLength":500,"format":"uri","description":"The webhook URL that receives responses produced through the API channel."},"type":{"type":"string","enum":["api"],"description":"The channel subtype represented by this detail payload."}},"required":["initialMessage","responseWebhookUrl","type"]},{"type":"object","properties":{"allowClientSideMcp":{"type":"boolean","description":"Whether registering tools from the widget's parent page is allowed."},"initialMessage":{"type":"string","nullable":true,"minLength":1,"maxLength":250,"description":"The initial message to be displayed when the widget is opened."},"loading":{"type":"string","enum":["private","named","explained"],"description":"The level of detail to be included in the loading message when the widget is opened."},"openOnLoad":{"type":"boolean","description":"Whether the widget should be opened automatically when the page is loaded."},"themes":{"type":"object","properties":{"dark":{"type":"object","properties":{"ownerMessageBackground":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"ownerMessageColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"responderMessageBackground":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"responderMessageColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"}},"required":["ownerMessageBackground","ownerMessageColor","responderMessageBackground","responderMessageColor"]},"light":{"type":"object","properties":{"ownerMessageBackground":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"ownerMessageColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"responderMessageBackground":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"responderMessageColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"}},"required":["ownerMessageBackground","ownerMessageColor","responderMessageBackground","responderMessageColor"]}},"required":["dark","light"],"description":"The widget theme palette configuration for the channel."},"type":{"type":"string","enum":["widget","widget-test"],"description":"The channel subtype represented by this detail payload."}},"required":["allowClientSideMcp","initialMessage","loading","openOnLoad","themes","type"]},{"type":"object","properties":{"connectionId":{"type":"string","nullable":true,"format":"uuid","description":"The backing connection ID used by this channel, when one exists."},"reactionTakeover":{"type":"object","properties":{"handoverEmojis":{"type":"array","items":{"type":"string","enum":["✅","✔️","☑️","📥","📩","📤","👍","🙌","🤝","👌","❤️"]},"minItems":1,"description":"The emojis that will handover the chat back to the agent."},"status":{"type":"boolean","description":"Whether the reaction takeover is enabled."}},"required":["handoverEmojis","status"],"description":"The reaction-based takeover policy configured for the channel."},"splitLongerMessages":{"type":"boolean","description":"Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account."},"type":{"type":"string","enum":["waha"],"description":"The channel subtype represented by this detail payload."}},"required":["connectionId","reactionTakeover","splitLongerMessages","type"]},{"type":"object","properties":{"connectionId":{"type":"string","nullable":true,"format":"uuid","description":"The backing connection ID used by this channel, when one exists."},"reactionTakeover":{"type":"object","properties":{"handoverEmojis":{"type":"array","items":{"type":"string","enum":["✅","✔️","☑️","📥","📩","📤","👍","🙌","🤝","👌","❤️"]},"minItems":1,"description":"The emojis that will handover the chat back to the agent."},"status":{"type":"boolean","description":"Whether the reaction takeover is enabled."}},"required":["handoverEmojis","status"],"description":"The reaction-based takeover policy configured for the channel."},"splitLongerMessages":{"type":"boolean","description":"Weather longer messages should be split when delivering them to the connected WhatsApp account."},"type":{"type":"string","enum":["whatsapp"],"description":"The channel subtype represented by this detail payload."}},"required":["connectionId","reactionTakeover","splitLongerMessages","type"]},{"type":"object","properties":{"connectionId":{"type":"string","nullable":true,"format":"uuid","description":"The backing connection ID used by this channel, when one exists."},"reactionTakeover":{"type":"object","properties":{"handoverEmojis":{"type":"array","items":{"type":"string","enum":["✅","✔️","☑️","📥","📩","📤","👍","🙌","🤝","👌","❤️"]},"minItems":1,"description":"The emojis that will handover the chat back to the agent."},"status":{"type":"boolean","description":"Whether the reaction takeover is enabled."}},"required":["handoverEmojis","status"],"description":"The reaction-based takeover policy configured for the channel."},"splitLongerMessages":{"type":"boolean","description":"Weather longer messages should be split when delivering them to the connected Instagram account."},"type":{"type":"string","enum":["instagram"],"description":"The channel subtype represented by this detail payload."}},"required":["connectionId","reactionTakeover","splitLongerMessages","type"]},{"type":"object","properties":{"connectionId":{"type":"string","nullable":true,"format":"uuid","description":"The backing connection ID used by this channel, when one exists."},"splitLongerMessages":{"type":"boolean","description":"Whether longer messages should be split when delivering them to the connected Telegram account."},"type":{"type":"string","enum":["telegram"],"description":"The channel subtype represented by this detail payload."}},"required":["connectionId","splitLongerMessages","type"]}]},"maxAssistantMessagesPerChatOwner":{"type":"integer","nullable":true,"minimum":0,"exclusiveMinimum":true},"name":{"type":"string","minLength":3,"maxLength":50,"description":"The display name of the channel."},"prompt":{"type":"string","nullable":true,"minLength":3,"maxLength":500,"description":"A prompt to be passed down to the agent in the context of this channel."},"responderId":{"type":"string","nullable":true,"format":"uuid","description":"The super identity of the responder (agents or squads) of the channel"},"showSenderName":{"type":"boolean","description":"Whether to display sender names in chat messages."},"status":{"type":"string","enum":["active","inactive"],"description":"The lifecycle status of the channel."},"useVoice":{"type":"string","enum":["on-audio/without-transcription","on-audio/with-transcription","always/without-transcription","always/with-transcription","never"],"description":"The voice behavior mode configured for the channel."},"workspaceId":{"type":"string","format":"uuid","description":"The workspace ID that owns the channel."}},"required":["createdAt","id","isRemoved","updatedAt","delay","description","detail","maxAssistantMessagesPerChatOwner","name","prompt","responderId","showSenderName","status","useVoice","workspaceId"]}},"required":["createdAt","id","isRemoved","updatedAt","description","detail","name","referenceId","workspaceId","channel"]},{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"isRemoved":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"},"description":{"type":"string","nullable":true,"minLength":3,"maxLength":250,"description":"The internal description of the connection."},"detail":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-airtable"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-asana"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-bannerbear"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-browseai"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-calendly"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-clickup"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-discord"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-dropbox"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-facebook"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-figma"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-genderize"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-github"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-gitlab"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-gmail"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-analytics"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-calendar"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-docs"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-drive"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-maps"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-meet"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-sheets"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-slides"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-google-tasks"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-hubspot"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-hugging-face"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"sourceConnectionId":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-instagram"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-linear"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-linkedin"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-mailersend"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-manus"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-mem0"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-meta-ads"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-microsoft-clarity"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-miro"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-mixpanel"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-monday"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-notion"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-one-drive"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-openweather-api"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-outlook"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-polygon-io"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-postman"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-prisma"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-pushbullet"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-reddit"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-resend"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-salesforce"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-scrape-do"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-search-api"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-sendgrid"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-sentry"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-serpapi"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-short-io"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-short-menu"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-slack"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-slackbot"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-stripe"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-supabase"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-tavily"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-teams"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-telegram"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-ticktick"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-todoist"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-trello"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-twitter"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-typeform"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-youtube"]}},"required":["id","status","type"]},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","active","failed"]},"type":{"type":"string","enum":["composio-zenrows"]}},"required":["id","status","type"]},{"type":"object","properties":{"accountId":{"type":"string","nullable":true,"description":"The provider account ID associated with the Instagram connection detail."},"code":{"type":"string","description":"The provider authorization code associated with the Instagram connection detail."},"id":{"type":"string","description":"The provider ID associated with the Instagram connection detail."},"name":{"type":"string","nullable":true,"minLength":3,"maxLength":50,"description":"The display name returned by the provider for the Instagram connection detail."},"reason":{"type":"string","nullable":true,"maxLength":500,"description":"The reason associated with the current Instagram connection status, when one exists."},"status":{"type":"string","enum":["pending","active","failed"],"description":"The lifecycle status of the Instagram connection detail."},"token":{"type":"string","nullable":true,"description":"The access token associated with the Instagram connection detail."},"type":{"type":"string","enum":["instagram"],"description":"The connection detail subtype represented by this payload."}},"required":["accountId","code","id","name","status","token","type"]},{"type":"object","properties":{"botId":{"type":"string","nullable":true,"description":"The Telegram bot ID associated with the connection detail."},"id":{"type":"string","description":"The provider ID associated with the Telegram connection detail."},"reason":{"type":"string","nullable":true,"maxLength":500,"description":"The reason associated with the current Telegram connection status, when one exists."},"status":{"type":"string","enum":["pending","active","failed"],"description":"The lifecycle status of the Telegram connection detail."},"token":{"type":"string","nullable":true,"description":"The bot token associated with the Telegram connection detail."},"type":{"type":"string","enum":["telegram"],"description":"The connection detail subtype represented by this payload."},"username":{"type":"string","nullable":true,"minLength":3,"maxLength":50,"description":"The display username returned by Telegram for the bot."},"webhookSecret":{"type":"string","nullable":true,"description":"The secret token used to validate Telegram webhook requests."}},"required":["botId","id","status","token","type","username","webhookSecret"]},{"type":"object","properties":{"id":{"type":"string"},"instanceId":{"type":"number","nullable":true},"lid":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"status":{"type":"string","enum":["pending","active","failed","inactive"]},"type":{"type":"string","enum":["waha"]}},"required":["id","instanceId","lid","phoneNumber","status","type"]},{"type":"object","properties":{"code":{"type":"string","description":"The provider authorization code associated with the WhatsApp connection detail."},"id":{"type":"string","description":"The provider ID associated with the WhatsApp connection detail."},"name":{"type":"string","nullable":true,"minLength":3,"maxLength":50,"description":"The display name returned by the provider for the WhatsApp connection detail."},"phoneNumber":{"type":"string","nullable":true,"description":"The phone number associated with the WhatsApp connection detail."},"phoneNumberId":{"type":"string","nullable":true,"description":"The provider phone number ID associated with the WhatsApp connection detail."},"reason":{"type":"string","nullable":true,"maxLength":500,"description":"The reason associated with the current WhatsApp connection status, when one exists."},"status":{"type":"string","enum":["pending","active","failed"],"description":"The lifecycle status of the WhatsApp connection detail."},"token":{"type":"string","nullable":true,"description":"The access token associated with the WhatsApp connection detail."},"type":{"type":"string","enum":["whatsapp"],"description":"The connection detail subtype represented by this payload."},"wabaId":{"type":"string","description":"The WABA ID associated with the WhatsApp connection detail."}},"required":["code","id","name","phoneNumber","phoneNumberId","status","token","type","wabaId"]}]},"name":{"type":"string","minLength":3,"maxLength":50,"description":"The display name of the connection."},"referenceId":{"type":"string","nullable":true,"format":"uuid","description":"The optional reference ID associated with the connection."},"workspaceId":{"type":"string","format":"uuid","description":"The workspace ID that owns the connection."}},"required":["createdAt","id","isRemoved","updatedAt","description","detail","name","referenceId","workspaceId"]}]}}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The error code."},"cta":{"type":"object","properties":{"type":{"type":"string","enum":["support-contact"]},"url":{"type":"string","format":"uri"}},"required":["type","url"],"description":"The error call-to-action."},"feedback":{"type":"object","properties":{"enUs":{"type":"string"},"esEs":{"type":"string"},"ptBr":{"type":"string"}},"description":"The error feedback."},"message":{"type":"string","description":"The error message."},"name":{"type":"string","description":"The error name."}},"required":["feedback","message","name"],"description":"The description of a known exception."}}}}}}}}}
```

## POST /api/v1/connections/{id}/send-message

> Sends a message through a connection.

```json
{"openapi":"3.1.0","info":{"title":"Public API","version":"1.0.0"},"servers":[{"description":"API Server","url":"https://api.endless.zaia.app"}],"paths":{"/api/v1/connections/{id}/send-message":{"post":{"description":"Sends a message through a connection.","tags":["Connections"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"required":true,"description":"A UUID v4 string that identifies an entity.","name":"id","in":"path"},{"schema":{"type":"string","description":"The API key to use for authentication. Can be created in the api keys section on the workspace settings page."},"required":true,"description":"The API key to use for authentication. Can be created in the api keys section on the workspace settings page.","name":"authorization","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1}},"required":["text"]},{"type":"object","properties":{"attachments":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"base64":{"type":"string","pattern":"^data:.*;base64,","description":"A base64 encoded string with prefix."},"extension":{"type":"string","enum":["png"]},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"name":{"type":"string","minLength":1}},"required":["base64","extension","id","name"]},{"type":"object","properties":{"base64":{"type":"string","pattern":"^data:.*;base64,","description":"A base64 encoded string with prefix."},"extension":{"type":"string","enum":["pdf"]},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"name":{"type":"string","minLength":1}},"required":["base64","extension","id","name"]},{"type":"object","properties":{"base64":{"type":"string","pattern":"^data:.*;base64,","description":"A base64 encoded string with prefix."},"extension":{"type":"string","enum":["wav"]},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"mode":{"type":"string","enum":["message"]}},"required":["base64","extension","id","mode"]},{"type":"object","properties":{"base64":{"type":"string","pattern":"^data:.*;base64,","description":"A base64 encoded string with prefix."},"extension":{"type":"string","enum":["wav"]},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"mode":{"type":"string","enum":["attachment"]},"name":{"type":"string","minLength":1}},"required":["base64","extension","id","mode","name"]}]}}},"required":["attachments"]},{"type":"object","properties":{"attachments":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"base64":{"type":"string","pattern":"^data:.*;base64,","description":"A base64 encoded string with prefix."},"extension":{"type":"string","enum":["png"]},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"name":{"type":"string","minLength":1}},"required":["base64","extension","id","name"]},{"type":"object","properties":{"base64":{"type":"string","pattern":"^data:.*;base64,","description":"A base64 encoded string with prefix."},"extension":{"type":"string","enum":["pdf"]},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"name":{"type":"string","minLength":1}},"required":["base64","extension","id","name"]},{"type":"object","properties":{"base64":{"type":"string","pattern":"^data:.*;base64,","description":"A base64 encoded string with prefix."},"extension":{"type":"string","enum":["wav"]},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"mode":{"type":"string","enum":["message"]}},"required":["base64","extension","id","mode"]},{"type":"object","properties":{"base64":{"type":"string","pattern":"^data:.*;base64,","description":"A base64 encoded string with prefix."},"extension":{"type":"string","enum":["wav"]},"id":{"type":"string","format":"uuid","description":"A UUID v4 string that identifies an entity."},"mode":{"type":"string","enum":["attachment"]},"name":{"type":"string","minLength":1}},"required":["base64","extension","id","mode","name"]}]}},"text":{"type":"string","minLength":1}},"required":["attachments","text"]},{"type":"object","properties":{"template":{"type":"object","properties":{"body":{"type":"object","properties":{"text":{"type":"string"},"variables":{"type":"array","items":{"type":"object","properties":{"parameterName":{"type":"string"},"value":{"type":"string"}},"required":["parameterName","value"]},"default":[]}}},"buttons":{"type":"object","properties":{"texts":{"type":"array","items":{"type":"string","maxLength":25}},"urlVariables":{"type":"array","items":{"type":"object","properties":{"buttonIndex":{"type":"number"},"value":{"type":"string","maxLength":2000}},"required":["buttonIndex","value"]}}}},"category":{"type":"string","nullable":true,"enum":["AUTHENTICATION","MARKETING","UTILITY",null]},"footer":{"type":"string","maxLength":60},"header":{"type":"object","properties":{"imageUrl":{"type":"string"},"text":{"type":"string","maxLength":60},"variables":{"type":"array","items":{"type":"object","properties":{"parameterName":{"type":"string"},"value":{"type":"string"}},"required":["parameterName","value"]}}}},"language":{"type":"string","minLength":1},"name":{"type":"string","minLength":1}},"required":["language","name"]}},"required":["template"]}]},"externalId":{"type":"string","nullable":true},"identifier":{"type":"string","nullable":true}},"required":["content","externalId","identifier"]}}}},"responses":{"200":{"description":"Message sent successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"An informative message for a call that has no effective result to be returned."}},"required":["message"]}}}},"404":{"description":"Connection not found.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The error code."},"cta":{"type":"object","properties":{"type":{"type":"string","enum":["support-contact"]},"url":{"type":"string","format":"uri"}},"required":["type","url"],"description":"The error call-to-action."},"feedback":{"type":"object","properties":{"enUs":{"type":"string"},"esEs":{"type":"string"},"ptBr":{"type":"string"}},"description":"The error feedback."},"message":{"type":"string","description":"The error message."},"name":{"type":"string","description":"The error name."}},"required":["feedback","message","name"],"description":"The description of a known exception."}}}},"500":{"description":"Failed to send message.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The error code."},"cta":{"type":"object","properties":{"type":{"type":"string","enum":["support-contact"]},"url":{"type":"string","format":"uri"}},"required":["type","url"],"description":"The error call-to-action."},"feedback":{"type":"object","properties":{"enUs":{"type":"string"},"esEs":{"type":"string"},"ptBr":{"type":"string"}},"description":"The error feedback."},"message":{"type":"string","description":"The error message."},"name":{"type":"string","description":"The error name."}},"required":["feedback","message","name"],"description":"The description of a known exception."}}}}}}}}}
```