API reference

Domains

You send from your own domains. Add a domain, prove you own it with a TXT record, publish its SPF and DKIM records, and it is ready to send.

Every endpoint can also return the common errors listed in the overview, and all of them need a full-access key (a sending-access key gets 401 restricted_api_key). For the DNS steps in detail see Domains and DNS.

The domain object

Each entry of records:

Until ownership is proven, records holds only the Ownership TXT record. After that it lists SPF and DKIM (both needed to send), DMARC (recommended) and MX.

GET /domains

Lists the company's domains, newest first.

Permission: full access; the key's creator needs the API controls privilege.

Query

Request

curl https://send.tsmart.ai/domains \
  -H "Authorization: Bearer $TSMART_API_KEY"

Response

List entries have no open_tracking, click_tracking or records.

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "domain",
      "id": "a3b1c5d2-7e8f-4a6b-9c0d-1e2f3a4b5c6d",
      "name": "yourdomain.com",
      "status": "verified",
      "created_at": "2026-10-09 08:15:02.123456+00",
      "region": "eu-central",
      "capabilities": { "sending": "enabled", "receiving": "disabled" }
    }
  ]
}

Errors

POST /domains

Adds a domain and returns the TXT record that proves you own it.

Permission: full access; the key's creator needs the Domains privilege.

Body

Request

curl -X POST https://send.tsmart.ai/domains \
  -H "Authorization: Bearer $TSMART_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "yourdomain.com" }'

const { data, error } = await tsmart.domains.create({ name: "yourdomain.com" });

domain = client.domains.create({"name": "yourdomain.com"})

Response

{
  "object": "domain",
  "id": "a3b1c5d2-7e8f-4a6b-9c0d-1e2f3a4b5c6d",
  "name": "yourdomain.com",
  "status": "not_started",
  "created_at": "2026-10-12 09:30:11.402871+00",
  "region": "eu-central",
  "capabilities": { "sending": "disabled", "receiving": "disabled" },
  "open_tracking": false,
  "click_tracking": false,
  "records": [
    {
      "record": "Ownership",
      "name": "_tsmart-verify.yourdomain.com",
      "type": "TXT",
      "ttl": "Auto",
      "status": "pending",
      "value": "tsmart-verify=Qm8x2LkP0aZ7vB1nR4tYc9Wd"
    }
  ]
}

Publish the Ownership record, then call POST /domains/{id}/verify. A domain whose ownership is not proven within 7 days of when the company first added it expires and has to be added again; deleting and re-adding it does not restart the 7 days. A domain.created webhook event is sent.

Errors

GET /domains/{id}

Returns one domain with its status, tracking settings and DNS records.

Permission: full access; the key's creator needs the API controls privilege.

Path

Request

curl https://send.tsmart.ai/domains/a3b1c5d2-7e8f-4a6b-9c0d-1e2f3a4b5c6d \
  -H "Authorization: Bearer $TSMART_API_KEY"

Response

A domain whose ownership is proven, with SPF published and DKIM still missing:

{
  "object": "domain",
  "id": "a3b1c5d2-7e8f-4a6b-9c0d-1e2f3a4b5c6d",
  "name": "yourdomain.com",
  "status": "partially_verified",
  "created_at": "2026-10-12 09:30:11.402871+00",
  "region": "eu-central",
  "capabilities": { "sending": "enabled", "receiving": "disabled" },
  "open_tracking": false,
  "click_tracking": false,
  "records": [
    {
      "record": "SPF",
      "name": "yourdomain.com",
      "type": "TXT",
      "ttl": "Auto",
      "status": "verified",
      "value": "v=spf1 ip4:91.99.133.27 ~all"
    },
    {
      "record": "DKIM",
      "name": "ts2610._domainkey.yourdomain.com",
      "type": "TXT",
      "ttl": "Auto",
      "status": "pending",
      "value": "v=DKIM1;k=rsa;t=s;s=email;p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA..."
    },
    {
      "record": "DMARC",
      "name": "_dmarc.yourdomain.com",
      "type": "TXT",
      "ttl": "Auto",
      "status": "pending",
      "value": "v=DMARC1; p=none; rua=mailto:reports@system.tsmart.ai; fo=1"
    },
    {
      "record": "MX",
      "name": "yourdomain.com",
      "type": "MX",
      "ttl": "Auto",
      "status": "pending",
      "value": "mail.tsmart.ai.",
      "priority": 10
    }
  ]
}

The values above are examples: always publish the values from your own response. If your domain already has an SPF record, the SPF value is your record with the sending server added, so you keep one SPF record.

Errors

PATCH /domains/{id}

Switches open and click tracking for emails sent from the domain.

Permission: full access; the key's creator needs the Domains privilege.

Path

Body

Omitted fields keep their value; a body without either field changes nothing. Tracking applies to emails sent after the change, and only to their HTML part. Tracked links are signed: they can only lead to the URL your email contained. Links to your company's verified domains (and their subdomains) redirect at once; links to any other website first show a short page on send.tsmart.ai that names the destination, and the reader continues from there.

Request

curl -X PATCH https://send.tsmart.ai/domains/a3b1c5d2-7e8f-4a6b-9c0d-1e2f3a4b5c6d \
  -H "Authorization: Bearer $TSMART_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "open_tracking": true, "click_tracking": true }'

Response

{
  "object": "domain",
  "id": "a3b1c5d2-7e8f-4a6b-9c0d-1e2f3a4b5c6d"
}

A change sends a domain.updated webhook event.

Errors

DELETE /domains/{id}

Removes a domain from the company. Emails can no longer be sent from it.

Permission: full access; the key's creator must be the company owner.

Path

Request

curl -X DELETE https://send.tsmart.ai/domains/a3b1c5d2-7e8f-4a6b-9c0d-1e2f3a4b5c6d \
  -H "Authorization: Bearer $TSMART_API_KEY"

Response

{
  "object": "domain",
  "id": "a3b1c5d2-7e8f-4a6b-9c0d-1e2f3a4b5c6d",
  "deleted": true
}

A domain.deleted webhook event is sent.

Errors

POST /domains/{id}/verify

Checks the domain's DNS: the first time it looks for the Ownership TXT record and, once found, sets the domain up for sending; after that it checks the SPF, DKIM, DMARC and MX records again.

Permission: full access; the key's creator needs the Domains privilege.

Path

Request

curl -X POST https://send.tsmart.ai/domains/a3b1c5d2-7e8f-4a6b-9c0d-1e2f3a4b5c6d/verify \
  -H "Authorization: Bearer $TSMART_API_KEY"

Response

{
  "object": "domain",
  "id": "a3b1c5d2-7e8f-4a6b-9c0d-1e2f3a4b5c6d"
}

The check runs during the call. Read the result with GET /domains/{id}: after ownership is proven, records lists the SPF and DKIM records to publish. Publish them and call verify again until status is verified. When the status changes, a domain.updated webhook event is sent.

Sending uses the stored result of the last check, not a live DNS lookup: after you publish or fix the records, call verify again before sending. The platform also re-checks verified domains periodically, so a record that is removed later changes the status and stops sending from the domain. Status changes found by this periodic check send no domain.updated event.

Errors