sendraven-ai · Schema

SendingDomain

A sending identity: a domain SendRaven may put in the From line, with one risk class. Transactional and marketing mail go out from separate subdomains (mail. and news.) with separate SES configuration sets, because mailbox providers score reputation on the From domain.

CompanyEmailArtificial IntelligenceInfrastructure

Properties

Name Type Description
id string Every /v1/domains/{id} path takes this, not the domain name.
domain string Fully-qualified, lower-cased, e.g. mail.example.com.
risk_class string
status string SES's DKIM verdict. Only this verdict changes it. A failed domain is not re-checked by the background monitor; call POST /v1/domains/{id}/verify after fixing its records.
configuration_set string The SES configuration set this identity's mail is sent through.
dns_records array
click_tracking object Null when no tracking hostname has been registered for this identity; the next check retries.
mail_from object Null until the first check that reaches SES.
utm_tags object
verified_at stringnull When a check first found the domain verified. Written once and never moved.
created_at string
View JSON Schema on GitHub

JSON Schema

sendraven-ai-sending-domain-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/sendraven-ai/json-schema/sendraven-ai-sending-domain-schema.json",
  "title": "SendingDomain",
  "description": "A sending identity: a domain SendRaven may put in the From line, with one risk class. Transactional and marketing mail go out from separate subdomains (mail. and news.) with separate SES configuration sets, because mailbox providers score reputation on the From domain.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sendraven-ai-domains-api-openapi.yml#/components/schemas/SendingDomain",
  "type": "object",
  "required": [
    "id",
    "domain",
    "risk_class",
    "status",
    "configuration_set",
    "dns_records",
    "click_tracking",
    "mail_from",
    "utm_tags",
    "verified_at",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Every /v1/domains/{id} path takes this, not the domain name."
    },
    "domain": {
      "type": "string",
      "description": "Fully-qualified, lower-cased, e.g. mail.example.com."
    },
    "risk_class": {
      "type": "string",
      "enum": [
        "transactional",
        "marketing"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "verified",
        "failed",
        "temporary_failure"
      ],
      "description": "SES's DKIM verdict. Only this verdict changes it. A failed domain is not re-checked by the background monitor; call POST /v1/domains/{id}/verify after fixing its records."
    },
    "configuration_set": {
      "type": "string",
      "description": "The SES configuration set this identity's mail is sent through."
    },
    "dns_records": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SendingDomainDnsRecord"
      }
    },
    "click_tracking": {
      "description": "Null when no tracking hostname has been registered for this identity; the next check retries.",
      "anyOf": [
        {
          "$ref": "#/$defs/SendingDomainClickTracking"
        },
        {
          "type": "null"
        }
      ]
    },
    "mail_from": {
      "description": "Null until the first check that reaches SES.",
      "anyOf": [
        {
          "$ref": "#/$defs/SendingDomainMailFrom"
        },
        {
          "type": "null"
        }
      ]
    },
    "utm_tags": {
      "$ref": "#/$defs/SendingDomainUtmTags"
    },
    "verified_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When a check first found the domain verified. Written once and never moved."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "$defs": {
    "SendingDomainClickTracking": {
      "type": "object",
      "description": "The link.<domain> hostname that carries click and open tracking on the customer's own name. Links are rewritten and opens counted only while status is active; tracking is never served from a shared SendRaven or Amazon hostname.",
      "required": [
        "hostname",
        "status",
        "active_at",
        "error"
      ],
      "properties": {
        "hostname": {
          "type": "string",
          "description": "link. followed by the sending domain."
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "active",
            "failed"
          ],
          "description": "pending until the CNAME resolves and a certificate is issued; active once it has; failed when that failed."
        },
        "active_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "When tracking first became active."
        },
        "error": {
          "type": [
            "string",
            "null"
          ],
          "description": "Why the hostname failed. Cleared when a later check finds it pending or active, but not when the CNAME stops resolving, so it can remain while status is pending."
        }
      }
    },
    "SendingDomainDnsRecord": {
      "type": "object",
      "description": "One DNS record to publish, with the result of the last live check.",
      "required": [
        "kind",
        "name",
        "type",
        "value",
        "priority",
        "observed",
        "ok",
        "optional"
      ],
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "dkim",
            "spf",
            "dmarc",
            "mail_from_mx",
            "mail_from_spf",
            "inbound_mx",
            "click_tracking"
          ],
          "description": "What the record is for. dkim (three CNAMEs) is what SES verifies the domain from. mail_from_mx and mail_from_spf put the bounce path on bounce.<domain>. dmarc is recommended. inbound_mx (receiving replies) and click_tracking (the link.<domain> CNAME) are optional features."
        },
        "name": {
          "type": "string",
          "description": "The hostname to publish the record at."
        },
        "type": {
          "type": "string",
          "enum": [
            "CNAME",
            "TXT",
            "MX"
          ]
        },
        "value": {
          "type": "string",
          "description": "The value to publish. Copy it from here: DKIM tokens are per domain and targets depend on the region."
        },
        "priority": {
          "type": [
            "integer",
            "null"
          ],
          "description": "MX priority on MX records; null on the others."
        },
        "observed": {
          "type": [
            "string",
            "null"
          ],
          "description": "The first answer the last DNS check saw at name, or null when nothing was there or no check has run."
        },
        "ok": {
          "type": "boolean",
          "description": "Whether the last check found the expected value. DMARC matches any v=DMARC1 record and SPF any value including amazonses.com. A check that cannot reach a resolver keeps the previous ok and observed. A record showing ok does not verify the domain by itself; only SES's DKIM verdict sets status."
        },
        "optional": {
          "type": "boolean",
          "description": "True for records that turn on a feature (inbound_mx, click_tracking); leaving them out never holds up verification."
        }
      }
    },
    "SendingDomainMailFrom": {
      "type": "object",
      "description": "Whether SES has adopted bounce.<domain> as the Return-Path. Tracked beside verification, never part of it: mail is delivered throughout, on an amazonses.com Return-Path (SPF then aligns with Amazon rather than the customer's domain) until this is active.",
      "required": [
        "domain",
        "status",
        "active_at"
      ],
      "properties": {
        "domain": {
          "type": "string",
          "description": "The bounce subdomain, e.g. bounce.mail.example.com."
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "active",
            "failed"
          ],
          "description": "pending while SES polls for the mail_from_mx record, active once adopted, failed when SES gave up. SES's 72-hour polling window starts when the domain is added, not when the MX record is published. A later check that sees the MX resolve restarts SES's verification and returns this to pending."
        },
        "active_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "When the bounce path first became active."
        }
      }
    },
    "SendingDomainUtmTags": {
      "type": "object",
      "description": "UTM parameters added to the links in this domain's mail, off until turned on. When on, every http(s) link in the HTML gets utm_source, utm_medium and, for a campaign or automation, utm_campaign (the campaign's name or the automation's slug, lower-cased and hyphenated), before click tracking, so a tracked link redirects to the tagged URL. A link that already has any utm_ parameter is left as written, and so are the unsubscribe link, mailto: and tel: links, anchors, the web version and anything on the link. tracking host. Add data-utm=\"off\" to an anchor to skip it. The text part is not changed.",
      "required": [
        "enabled",
        "source",
        "medium",
        "include_transactional",
        "hosts"
      ],
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "false on every domain that has not turned it on."
        },
        "source": {
          "type": "string",
          "maxLength": 100,
          "description": "utm_source. Defaults to newsletter."
        },
        "medium": {
          "type": "string",
          "maxLength": 100,
          "description": "utm_medium. Defaults to email."
        },
        "include_transactional": {
          "type": "boolean",
          "description": "Also tag transactional messages sent from this domain. false by default: only marketing mail is tagged."
        },
        "hosts": {
          "type": "array",
          "maxItems": 50,
          "items": {
            "type": "string"
          },
          "description": "Only links to these hosts or their subdomains are tagged (example.com covers www.example.com). Empty tags every eligible link."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/sendraven-ai-sending-domain"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.