Skip to navigation

Get the caller's approved email recipients

Beta

The caller’s email preferences for agent-sent mail in their current workspace: the domains and specific addresses they have approved as recipients, plus their custom drafting instruction. Built for computer-asset apps that compose or send email on the user’s behalf, so they apply the same recipient policy the chat email tools enforce — a recipient is approved when its full address is in approved_emails or its domain is in approved_domains (both compared case-insensitively). Read-only: the policy is edited from Settings → Email & Meetings (manage_url).

Authentication

X-API-KEYstring
API Key authentication via header

Headers

X-Athena-Session-CredentialstringOptional

Response

Successful Response
approved_domainslist of strings

Domains the agent may email anyone at, as bare lowercase domains (acme.com). Match a recipient's domain against this list.

approved_emailslist of strings

Specific addresses the agent may email, lowercase (user@acme.com). Match the whole recipient address against this list.

manage_urlstring

Where the user edits this policy (Settings → Email & Meetings). Send the user here when a recipient is not approved; the policy cannot be changed through this API.

custom_instructionstring or nullOptional

Free-text guidance the user wants followed whenever an agent drafts email on their behalf; null when none is set.