Skip to Content
SendlySendly
API ReferenceDomains

Upload a sending domain's sender logo

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

Replace the identity's logo with an SVG. The file is rebuilt into the SVG Tiny PS profile mailboxes require: editor bookkeeping and unsupported attributes are dropped, and the result is what the URL serves. It must be square, draw with shapes rather than <text> (convert text to outlines), reference nothing outside itself, and come to at most 32 KB once rebuilt. A file that cannot be rebuilt answers 422 validation_error with a detail naming what to change, and the previous logo stays in place.

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:write scope — Add and remove sending domains, and trigger verification.

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
application/json
  1. body

Body for PUT /api/v1/domains/{id}/logo.

svg*string

The logo as SVG source text, square, at most 64 KB. It is rebuilt into SVG Tiny PS — the profile BIMI requires — before it is stored; a file that cannot be (text not converted to outlines, a raster image, a sheet, a canvas that is not square, over 32 KB once cleaned) is refused with a message naming what to change.

Length1 <= length <= 65536

Response Body

The identity's sender logo, now the uploaded file

application/json
  1. response

The logo mailboxes show beside mail from a sending identity, published through BIMI.

domain_id*string
Formatuuid
source*string

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

Value in"uploaded""default"
url*string

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.

Formaturi
png_url?string

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.

Formaturi
serving*boolean

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

svg*string

The SVG Tiny PS file url serves.

sha256*string
size_bytes*integer
updated_at*|

When the upload was stored; null for default.

Formatdate-time
bimi_record*

The DNS record that makes a mailbox fetch url. Publish it once.

readiness*

What public DNS says right now. A provider shows the logo only when DMARC is enforced (p=quarantine or p=reject at pct=100) and the record is published. unknown means the lookup failed, not that the record is absent. Providers decide whether to display a logo. Gmail additionally requires a VMC or CMC certificate, which this does not check. DNS readiness alone does not guarantee display.

Example Request
curl -X PUT 'https://api.sendly.now/api/v1/domains/497f6eca-6276-4993-bfeb-53cbbbba6f08/logo' \  -H 'Content-Type: application/json' \  -d '{  "svg": "string"}'
Example Response
{  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",  "source": "uploaded",  "url": "http://example.com",  "png_url": "http://example.com",  "serving": true,  "svg": "string",  "sha256": "string",  "size_bytes": 0,  "updated_at": "2019-08-24T14:15:22Z",  "bimi_record": {    "type": "TXT",    "name": "string",    "value": "string"  },  "readiness": {    "dmarc": {      "status": "enforced",      "policy": "string",      "pct": 0,      "found_at": "string"    },    "bimi_record": {      "status": "published",      "found_at": "string",      "location": "string"    }  }}