Справочник API публикуется на английском языке.
Create or attach an agent email inbox
/api/companies/{companyId}/email/inboxesCreate or attach an agent email inbox.
AgentMail email connection. Available without the experimental chat setting. Internal comments never send email. Agent sends require assigned inbox and task ownership, active run authority, and configured action policies. Preserve the same idempotencyKey and payload across retries. New conversations create an email child task; replies require conversationId and replyToMessageId. Reply-all is deliberate and never includes Bcc.
Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.
Авторизация
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.
Параметры пути
Тело запроса
application/json · обязательно
1–4096 charactersat most 320 charactersat most 64 characterspattern: ^[a-zA-Z0-9._-]+$at most 253 charactersone of: "websocket", "webhook"Ответы
details names each field that failed.Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.