Skip to main content

SetupEmailDomain initiates email domain configuration.

POST 
/api/v1/engagements/integrations/email/setup

Creates a new channel configuration and email domain config. For sandbox domains, the configuration is immediately usable. For custom domains, DNS records must be configured and verified.

Sandbox Domain​

  • Uses Mailgun's existing sandbox domain
  • Limited to authorized recipients only
  • Immediately active after setup

Custom Domain​

  • Creates or retrieves domain in Mailgun
  • Returns required DNS records (SPF, DKIM, MX)
  • Requires VerifyEmailDomain call after DNS setup

Errors​

  • INVALID_ARGUMENT: Invalid API key or domain format
  • ALREADY_EXISTS: Domain already configured for this organization
  • FAILED_PRECONDITION: Mailgun API key is invalid

Request​

Responses​

A successful response.