API referansı İngilizce yayımlanır.

Explicitly send email: start a child task or reply to a bound conversation

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

Explicitly send email: start a child task or reply to a bound conversation.

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

endpointIdstring (uuid)Zorunlu
parentIssueIdstring (uuid)İsteğe bağlı
conversationIdstring (uuid)İsteğe bağlı
replyToMessageIdstringİsteğe bağlı1–998 characters
replyAllbooleanİsteğe bağlı
toarray<string (email)>İsteğe bağlıeach at most 320 characters
ccarray<string (email)>İsteğe bağlıeach at most 320 characters
bccarray<string (email)>İsteğe bağlıeach at most 320 characters
subjectstringİsteğe bağlı1–998 characterspattern: ^[^\r\n]+$
textstringZorunlu1–100000 characters
attachmentIdsarray<string (uuid)>İsteğe bağlı
idempotencyKeystring (uuid)Zorunlu

Yanıtlar

202SuccessAccepted; the work continues in the background.
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