La référence de l'API est publiée en anglais.

Create or attach an agent email inbox

POST/api/companies/{companyId}/email/inboxes
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

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.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

companyIdstring (uuid)ObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

assignedAgentIdstring (uuid)Obligatoire
applicationIdstring (uuid)Facultatif
apiKeystringFacultatif1–4096 characters
credentialConnectionIdstring (uuid)Facultatif
inboxIdstring (email)Facultatifat most 320 characters
usernamestringFacultatifat most 64 characterspattern: ^[a-zA-Z0-9._-]+$
domainstringFacultatifat most 253 characters
receiveModestringFacultatifone of: "websocket", "webhook"
idempotencyKeystring (uuid)Obligatoire

Réponses

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

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Email