POST/domains/claim

Claim a domain

Start a claim for a domain that another Resend account has already verified. The domain is recreated under your account with fresh DKIM keys, so the previous account's DNS records cannot be reused. Returns a TXT record to add to your DNS to prove ownership. Uses the same request body as creating a domain.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields
namestringrequired
The name of the domain you want to claim.
regionstringoptional
The region where emails will be sent from. Possible values are us-east-1 | eu-west-1 | sa-east-1 | ap-northeast-1
Allowed:us-east-1eu-west-1sa-east-1ap-northeast-1Default:us-east-1
custom_return_pathstringoptional
For advanced use cases, choose a subdomain for the Return-Path address. Defaults to 'send' (i.e., send.yourdomain.tld).
Default:send
open_trackingbooleanoptional
Track the open rate of each email.
click_trackingbooleanoptional
Track clicks within the body of each HTML email.
tracking_subdomainstringoptional
The subdomain to use for click and open tracking.

2 status codes
200An identical pending claim already existed and was returned unchanged.
objectstringoptional
The type of object.
idstringoptional
The ID of the claim.
namestringoptional
The name of the domain being claimed.
statusstringoptional
The status of the claim.
Allowed:pendingverifiedcompletedblockedexpiredsupersededcanceledfailed
domain_idstringoptional
The ID of the placeholder domain created for the claim.
regionstringoptional
The region where the claimed domain will send from.
Allowed:us-east-1eu-west-1sa-east-1ap-northeast-1null
recordobjectoptional
The TXT record to add to your DNS to prove ownership of the claimed domain.
blocked_reasonstringoptional
Why the claim is currently blocked, if applicable.
Allowed:grace_periodrecent_owner_activitypending_scheduled_emailsnull
failure_reasonstringoptional
Why the claim failed, if applicable.
created_atstringoptional
The date and time the claim was created.
expires_atstringoptional
The date and time the claim expires if not verified.
201Claim created.
objectstringoptional
The type of object.
idstringoptional
The ID of the claim.
namestringoptional
The name of the domain being claimed.
statusstringoptional
The status of the claim.
Allowed:pendingverifiedcompletedblockedexpiredsupersededcanceledfailed
domain_idstringoptional
The ID of the placeholder domain created for the claim.
regionstringoptional
The region where the claimed domain will send from.
Allowed:us-east-1eu-west-1sa-east-1ap-northeast-1null
recordobjectoptional
The TXT record to add to your DNS to prove ownership of the claimed domain.
blocked_reasonstringoptional
Why the claim is currently blocked, if applicable.
Allowed:grace_periodrecent_owner_activitypending_scheduled_emailsnull
failure_reasonstringoptional
Why the claim failed, if applicable.
created_atstringoptional
The date and time the claim was created.
expires_atstringoptional
The date and time the claim expires if not verified.