Skip to Content
SendlySendly
API ReferenceDomains

Check a sending domain's logo readiness

GET
/api/v1/domains/{id}/logo/readiness

How ready this identity is to show its logo as the inbox avatar: a list of steps, each met, missing, unknown or not_applicable with a plain-English reason and the inboxes it unlocks, and one checklist per inbox (Gmail, Yahoo, Apple Mail, Fastmail) saying which steps that inbox requires.

The steps are DMARC at enforcement (p=quarantine or p=reject, pct=100) on the sending host and on its registered (organizational) domain, a BIMI record whose l= is an https URL, the SVG Tiny PS logo file at l=, and the mark certificate (VMC or CMC) at the record's a=. For the certificate only "the URL answers with a PEM file" is checked; the certificate chain is not validated. Gmail and Apple Mail show no BIMI logo without a certificate, and Sendly neither issues nor sells them. Two routes that need no BIMI record (a Google account profile photo for Gmail, Apple Branded Mail) are set up with the provider and cannot be seen from outside, so they are always unknown, never met.

An unknown means a lookup failed or the step is self-attested; it is never a pass and never a failure. Readiness is not a promise: providers decide whether to display a logo.

The reading comes from public DNS and from the customer's own web hosts (every lookup has a short timeout and a size cap, and the whole read ends after 5 seconds, when any step not yet read is unknown), so it is held for a minute; checked_at says when it was taken. The readiness object on GET /api/v1/domains/{id}/logo is unchanged and remains DNS-only.

Requires the domains:read scope — View your sending domains and their verification status.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

id*string

Resource id.

Formatuuid

Response Body

The identity's logo readiness, per step and per inbox

application/json
  1. response

How ready a sending domain is to show its logo as the inbox avatar, per step and per inbox. Backed by public DNS and the customer's own web hosts, so a reading is held for a minute.

domain_id*string
Formatuuid
domain*string
checked_at*string

When the lookups ran. A reading is held for a minute, so this can be up to a minute old; a fix to DNS shows after that.

Formatdate-time
items*array<>

dmarc_enforced: DMARC at p=quarantine or p=reject, pct=100, on the sending host and on its registered domain. bimi_record: a default._bimi TXT record whose l= is an https URL. logo_file: the file at l= is SVG Tiny PS (the file Sendly serves is always checked as served). mark_certificate: the record's a= URL answers with a PEM certificate (VMC or CMC); only that is checked, not the certificate chain. gmail_profile_photo and apple_branded_mail: routes that need no BIMI record and are set up with the provider, so they are always unknown (or not_applicable) and never met.

providers*array<>

One checklist per inbox, in the order the steps should be done.

Example Request
curl -X GET 'https://api.sendly.now/api/v1/domains/497f6eca-6276-4993-bfeb-53cbbbba6f08/logo/readiness'
Example Response
{  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",  "domain": "string",  "checked_at": "2019-08-24T14:15:22Z",  "items": [    {      "key": "dmarc_enforced",      "status": "met",      "reason": "string",      "unlocks": [        "gmail"      ],      "evidence": "string"    }  ],  "providers": [    {      "inbox": "gmail",      "status": "ready",      "checklist": [        {          "item": "dmarc_enforced",          "requirement": "required",          "status": "met"        }      ]    }  ]}