Setup

email_create_api_key

Mint an API key for the company's app (POST /api/v1/emails).

write email_create_api_key

Mint an API key for the company's app (POST /api/v1/emails). The secret is returned ONCE — relay it to the human immediately. Pick a role: 'app' (sends + manages content — what an app needs, the default), 'content' (manages templates and contacts but can NEVER send), 'read' (view only), 'admin' (workspace settings, can send). Requires an 'admin' credential.

Parameters

ParameterTypeRequiredDescription
namestringYes
roleapp | content | read | adminNoWhat the key may do. Defaults to 'app' — the credential an application authenticates sends with. Use 'content' only when the key must never deliver mail.
projectIdstringNoTarget company (project id) — required on company-scoped tools. Call email_list_projects to enumerate companies.

On this page