Skip to main content
POST
This endpoint returns the DNS records Forge needs. Add them to your DNS and call Verify Domain with scope: ["forge"], then poll Retrieve Domain until each of these records has the status verified. Calling this endpoint again just returns the current state.
  • Sending: a Forge SPF record of type CNAME.
  • Receiving: when the domain also receives email, Forge moves receiving too. The Receiving record of type MX gets a new value and the status pending. Replace your current MX record with it.
The domain keeps sending through its current records while the Forge record verifies, so there is no interruption.
The domain must be a sending domain. Receive-only domains, domains on a dedicated IP, and domains with legacy DKIM get a forge_unavailable error.

Path Parameters

Body Parameters

Headers

string
Add an idempotency key to enable Forge only once.
  • Should be unique per API request
  • Idempotency keys expire after 24 hours
  • Have a maximum length of 256 characters
  • A retry with the same key returns the first successful response, with the idempotent-replayed: true header
  • A failed request is not stored, so you can retry it with the same key
  • Reusing the key with a different body, or while the first request is still running, returns a 409
Learn more