curl -X POST https://api.gork.email/v1/domains \
-H "Authorization: Bearer gork_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"domain": "outbound.yourdomain.com"
}'
import { Gork } from "@gork/sdk"
const gork = new Gork({ apiKey: process.env.GORK_API_KEY })
const domain = await gork.domains.create({
domain: "outbound.yourdomain.com",
})
console.log(domain.dnsInstructions)
{
"data": {
"id": "dom_83fa90bc712e",
"domainName": "outbound.yourdomain.com",
"status": "pending",
"dnsInstructions": [
{
"type": "TXT",
"name": "_gork-challenge.outbound.yourdomain.com",
"value": "gork-verification=37a1c890f42b",
"purpose": "Domain Ownership Verification"
},
{
"type": "MX",
"name": "outbound.yourdomain.com",
"value": "inbound-smtp.ap-southeast-2.amazonaws.com",
"priority": 10,
"purpose": "Inbound Email Routing via Amazon SES"
},
{
"type": "TXT",
"name": "outbound.yourdomain.com",
"value": "v=spf1 include:amazonses.com ~all",
"purpose": "SPF Sender Authorization"
},
{
"type": "TXT",
"name": "_dmarc.outbound.yourdomain.com",
"value": "v=DMARC1; p=quarantine; pct=100;",
"purpose": "DMARC Policy"
},
{
"type": "CNAME",
"name": "a1b2c3d4._domainkey.outbound.yourdomain.com",
"value": "a1b2c3d4.dkim.amazonses.com",
"purpose": "Easy-DKIM 2048-bit Cryptographic Key"
},
{
"type": "CNAME",
"name": "e5f6g7h8._domainkey.outbound.yourdomain.com",
"value": "e5f6g7h8.dkim.amazonses.com",
"purpose": "Easy-DKIM 2048-bit Cryptographic Key"
},
{
"type": "CNAME",
"name": "i9j0k1l2._domainkey.outbound.yourdomain.com",
"value": "i9j0k1l2.dkim.amazonses.com",
"purpose": "Easy-DKIM 2048-bit Cryptographic Key"
}
]
}
}
Domains
Create Domain
Register a custom domain to enable sending and receiving from branded email addresses.
POST
/
v1
/
domains
curl -X POST https://api.gork.email/v1/domains \
-H "Authorization: Bearer gork_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"domain": "outbound.yourdomain.com"
}'
import { Gork } from "@gork/sdk"
const gork = new Gork({ apiKey: process.env.GORK_API_KEY })
const domain = await gork.domains.create({
domain: "outbound.yourdomain.com",
})
console.log(domain.dnsInstructions)
{
"data": {
"id": "dom_83fa90bc712e",
"domainName": "outbound.yourdomain.com",
"status": "pending",
"dnsInstructions": [
{
"type": "TXT",
"name": "_gork-challenge.outbound.yourdomain.com",
"value": "gork-verification=37a1c890f42b",
"purpose": "Domain Ownership Verification"
},
{
"type": "MX",
"name": "outbound.yourdomain.com",
"value": "inbound-smtp.ap-southeast-2.amazonaws.com",
"priority": 10,
"purpose": "Inbound Email Routing via Amazon SES"
},
{
"type": "TXT",
"name": "outbound.yourdomain.com",
"value": "v=spf1 include:amazonses.com ~all",
"purpose": "SPF Sender Authorization"
},
{
"type": "TXT",
"name": "_dmarc.outbound.yourdomain.com",
"value": "v=DMARC1; p=quarantine; pct=100;",
"purpose": "DMARC Policy"
},
{
"type": "CNAME",
"name": "a1b2c3d4._domainkey.outbound.yourdomain.com",
"value": "a1b2c3d4.dkim.amazonses.com",
"purpose": "Easy-DKIM 2048-bit Cryptographic Key"
},
{
"type": "CNAME",
"name": "e5f6g7h8._domainkey.outbound.yourdomain.com",
"value": "e5f6g7h8.dkim.amazonses.com",
"purpose": "Easy-DKIM 2048-bit Cryptographic Key"
},
{
"type": "CNAME",
"name": "i9j0k1l2._domainkey.outbound.yourdomain.com",
"value": "i9j0k1l2.dkim.amazonses.com",
"purpose": "Easy-DKIM 2048-bit Cryptographic Key"
}
]
}
}
Register a custom sending/receiving domain with your Gork organization. Once registered, Gork generates SPF, DKIM, DMARC, and MX records for DNS authentication.
Body
string
required
The domain or subdomain to register (e.g.
mail.yourdomain.com or outbound.company.com).Response
object
curl -X POST https://api.gork.email/v1/domains \
-H "Authorization: Bearer gork_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"domain": "outbound.yourdomain.com"
}'
import { Gork } from "@gork/sdk"
const gork = new Gork({ apiKey: process.env.GORK_API_KEY })
const domain = await gork.domains.create({
domain: "outbound.yourdomain.com",
})
console.log(domain.dnsInstructions)
{
"data": {
"id": "dom_83fa90bc712e",
"domainName": "outbound.yourdomain.com",
"status": "pending",
"dnsInstructions": [
{
"type": "TXT",
"name": "_gork-challenge.outbound.yourdomain.com",
"value": "gork-verification=37a1c890f42b",
"purpose": "Domain Ownership Verification"
},
{
"type": "MX",
"name": "outbound.yourdomain.com",
"value": "inbound-smtp.ap-southeast-2.amazonaws.com",
"priority": 10,
"purpose": "Inbound Email Routing via Amazon SES"
},
{
"type": "TXT",
"name": "outbound.yourdomain.com",
"value": "v=spf1 include:amazonses.com ~all",
"purpose": "SPF Sender Authorization"
},
{
"type": "TXT",
"name": "_dmarc.outbound.yourdomain.com",
"value": "v=DMARC1; p=quarantine; pct=100;",
"purpose": "DMARC Policy"
},
{
"type": "CNAME",
"name": "a1b2c3d4._domainkey.outbound.yourdomain.com",
"value": "a1b2c3d4.dkim.amazonses.com",
"purpose": "Easy-DKIM 2048-bit Cryptographic Key"
},
{
"type": "CNAME",
"name": "e5f6g7h8._domainkey.outbound.yourdomain.com",
"value": "e5f6g7h8.dkim.amazonses.com",
"purpose": "Easy-DKIM 2048-bit Cryptographic Key"
},
{
"type": "CNAME",
"name": "i9j0k1l2._domainkey.outbound.yourdomain.com",
"value": "i9j0k1l2.dkim.amazonses.com",
"purpose": "Easy-DKIM 2048-bit Cryptographic Key"
}
]
}
}