domains

Register a sending domain.

Region is optional and defaults to us (Oregon); the stored value is returned.

post/domains

Request

  • Base URL: https://api.agentisend.com
  • URL: https://api.agentisend.com/domains
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes this call safe to retry. Send the same key with the same body and the original response is replayed instead of the work happening twice. Keys are 1-256 characters and are remembered for 7 days. While the first attempt is still running, a second call with that key returns 409 idempotency_in_flight (Resend calls this concurrent_idempotent_requests); the same key with a different body returns 409 idempotency_payload_mismatch (Resend: invalid_idempotent_request). Resend-Idempotency-Key is accepted as the same header.

Resend-Idempotency-Keystring

Alias of Idempotency-Key. Idempotency-Key wins if both are sent.

Request body

namestring required

The domain you send from, such as yourdomain.com.

region'us' | 'eu'

us or eu. Default us. The region is recorded on the domain. All mail is sent from the US today. For one release the legacy names us-east-1, sa-east-1 and ap-northeast-1 map to us; eu-west-1 maps to eu.

trackingboolean

Whether to publish a tracking host. On by default. Not required to verify the domain.

tracking_subdomainstring

The label of the tracking host. Default links, which publishes links.yourdomain.com.

return_path_subdomainstring

The label of the return-path host. Default send. Up to 63 characters, starting with a letter.

tls_mode'opportunistic' | 'enforced'

opportunistic tries TLS and falls back. enforced refuses a receiver that cannot do TLS.

tls'opportunistic' | 'enforced'

Same as tls_mode. tls_mode wins if both are sent.

open_trackingboolean

Count opens. Off unless you set this.

click_trackingboolean

Rewrite links so clicks can be counted. Off unless you set this.

openTrackingboolean

Same as open_tracking. open_tracking wins if both are sent.

clickTrackingboolean

Same as click_tracking. click_tracking wins if both are sent.

custom_return_pathstring

Same as return_path_subdomain.

customReturnPathstring

Same as custom_return_path.

Response

Success

object'domain' required
idstring uuid required
namestring required
zonestring required
region'us' | 'eu' required
status'pending' | 'verified' | 'failed' | 'partially_verified' | 'partially_failed' required
dkim_selectorstring required
click_trackingboolean required
open_trackingboolean required
tracking_subdomainstring required
return_path_subdomainstring required
tls_mode'opportunistic' | 'enforced' required
created_atstring date-time required
verified_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.