Domains

Retrieve a sending domain's sender logo

The logo this identity serves to mailboxes, the DNS record that makes them fetch it, and whether they will show it today.

A mailbox that supports BIMI shows this logo beside mail from the identity, once two DNS records are in place: a default._bimi.<host> TXT record naming the logo's URL (returned as bimi_record), and a DMARC policy of p=quarantine or p=reject applied to all mail. readiness is a fresh reading of both from public DNS. Providers decide whether to display a logo, so DNS readiness alone does not guarantee display. Gmail additionally requires a VMC or CMC certificate, which Sendly neither issues nor checks.

The URL is keyed by the identity and never changes, so the record is published once. Until a logo is uploaded it serves a default: the domain's initial on a coloured square. It serves nothing (serving is false) until the identity verifies, and nothing while the project is disabled.

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

get/api/v1/domains/{id}/logo

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/domains/{id}/logo
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: domains:read)

Path parameters

idstring uuid required

Resource id.

Response

The identity's sender logo

domain_idstring uuid required
png_urlstring uri

The same logo as a 1024x1024 PNG, for the places that take no SVG (a Google account's profile photo, Apple Branded Mail). Served under the same rules as url.

servingboolean required

Whether url answers today. It answers only once the identity has verified.

sha256string required
size_bytesinteger required
source'uploaded' | 'default' required

default is a monogram of the domain's initial, served until a logo is uploaded and again after one is removed.

svgstring required

The SVG Tiny PS file url serves.

updated_atstring date-time nullable required

When the upload was stored; null for default.

urlstring uri required

Where the logo is served. Stable for the life of the identity, so the BIMI record is published once and a new upload needs no DNS change.

Changes

No recorded changes to this operation across all 1 revision of this API.