API referansı İngilizce yayımlanır.

Create or attach an agent email inbox

POST/api/companies/{companyId}/email/inboxes
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Create 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.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstring (uuid)ZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

assignedAgentIdstring (uuid)Zorunlu
applicationIdstring (uuid)İsteğe bağlı
apiKeystringİsteğe bağlı1–4096 characters
credentialConnectionIdstring (uuid)İsteğe bağlı
inboxIdstring (email)İsteğe bağlıat most 320 characters
usernamestringİsteğe bağlıat most 64 characterspattern: ^[a-zA-Z0-9._-]+$
domainstringİsteğe bağlıat most 253 characters
receiveModestringİsteğe bağlıone of: "websocket", "webhook"
idempotencyKeystring (uuid)Zorunlu

Yanıtlar

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Email