domains

Turn click or open tracking on, change the tracking subdomain, or turn sending and receiving on or off.

Name, region and return-path cannot change.

patch/domains/{id}

Request

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

Path parameters

idstring required

Domain id (UUID) or name.

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

click_trackingboolean

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

open_trackingboolean

Count opens. Off unless you set this.

tracking_subdomainstring nullable

Change the tracking host label. Null is refused: the host can be renamed, not removed.

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.

nameunknown
regionunknown
return_pathunknown
custom_return_pathunknown

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.