Create Domain
Registers a hostname on the project. Names are unique across Saasco. Reusing one that belongs to another project returns 400. Creating one does not enable sending, receiving, or shortlinks and does not return DNS records. Call Activate Email Sending, Activate Email Receiving, or Enable Shortlink, then read the records from Get Domain (emailConfig.records) or Get Email Receiving Config, add them at the DNS host, and call Verify Email DNS, Verify Email Receiving DNS, or Verify Shortlink.
Authorization
Authorization In: header
Path Parameters
ID of the project that will own the domain.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Hostname to register, without a protocol. Must be unique across Saasco.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/projects/string/domains" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "id": "string", "createdAt": "string", "updatedAt": "string", "emailStatus": "INACTIVE", "emailProvider": "string", "emailProviderDomainId": "string", "emailReceivingStatus": "INACTIVE", "emailReceivingProviderId": "string", "trackingSubdomain": "string", "trackingVerificationStatus": "PENDING", "shortlinkEnabled": true, "vercelConfigured": true, "vercelVerificationStatus": "PENDING", "vercelVerificationError": "string", "vercelVerificationDNS": [ { "domain": "string", "reason": "string", "type": "string", "value": "string" } ], "emailVerificationRequestedAt": "string", "receivingVerificationRequestedAt": "string", "shortlinkVerificationRequestedAt": "string", "senderReputationComputedAt": "string", "warmupStatus": "PENDING", "warmupStartedAt": "string", "warmupWindowStartedAt": "string", "projectId": "string", "name": "string", "senderReputation": 50, "warmupDay": 0, "warmupSentCount": 0}Get Domain
Fetches a domain plus its email DNS config and whether verification jobs are still running. Once a check has been asked for and that capability is not live yet, this also writes the status the provider reports now — sending and tracking from Resend, inbound from Resend, shortlinks from Vercel — so the domain list does not stay Waiting on DNS after the records have verified. Returns 404 if no domain matches.
Update Domain
Updates client-writable domain fields. Only the keys present in changes are written. Status, provider, DNS, verification, reputation, warmup, and the tracking subdomain are ignored even if sent. Do not use this to mark a domain verified or to turn sending on. Call Activate Email Sending, Activate Email Receiving, or Enable Shortlink, then Verify Email DNS, Verify Email Receiving DNS, or Verify Shortlink. DNS records are on Get Domain.