OutreachAgent
Sign InDeploy Agent

Documentation

DocsAPI ReferenceDomains API

Domains API

GET/v1/domains

List all domains.

TypeScript
const domains = await client.listDomains();
curl
curl https://api.outreachagent.dev/v1/domains \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"
POST/v1/domains

Add a domain for verification. Returns required DNS records.

ParameterTypeRequiredDescription
namestringYesDomain name (e.g., yourdomain.com)
TypeScript
const domain = await client.createDomain("yourdomain.com");
console.log(domain.dnsRecords); // [{type, host, value}]
curl
curl -X POST https://api.outreachagent.dev/v1/domains \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "yourdomain.com"}'
GET/v1/domains/:domainId

Get domain verification status and DNS records.

TypeScript
const domain = await client.getDomain("dom_abc123");
console.log(domain.dkimStatus); // "verified"
console.log(domain.spfStatus);  // "pending"
curl
curl https://api.outreachagent.dev/v1/domains/dom_abc123 \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"
DELETE/v1/domains/:domainId

Remove a domain.

TypeScript
await client.deleteDomain("dom_abc123");
curl
curl -X DELETE https://api.outreachagent.dev/v1/domains/dom_abc123 \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"
POST/v1/domains/:domainId/warmup/start

Start opt-in warm-up for a domain. Begins the daily send limit ramp schedule.

TypeScript
await client.startDomainWarmup("dom_abc123");
curl
curl -X POST https://api.outreachagent.dev/v1/domains/dom_abc123/warmup/start \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"
POST/v1/domains/:domainId/warmup/stop

Stop warm-up and remove daily send limits for this domain.

TypeScript
await client.stopDomainWarmup("dom_abc123");
curl
curl -X POST https://api.outreachagent.dev/v1/domains/dom_abc123/warmup/stop \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"