Email

Set the inbox logo (BIMI) of a sending domain

Sets the BIMI record default._bimi.<domain> with the logo (and the mark certificate, if the user has one). First checks that DMARC is quarantine or reject for all mail (otherwise bimi_not_ready; we never change DMARC ourselves) and that the logo is an SVG Tiny PS file mailboxes accept: version 1.2 with baseProfile tiny-ps, a <title>, square, no scripts or external files, at most 32 KB, on an https address without a redirect. When the domain's DNS is hosted here we set or update the record; otherwise record_to_add is the record to add at the DNS provider.

post/email-domains/{id}/bimi

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/email-domains/{id}/bimi
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:write)

Path parameters

idstring uuid required

The id of the sending domain.

Request body

logo_urlstring required

The https address of your logo as an SVG Tiny PS file (square, with a <title>, at most 32 KB), for example on your own site.

certificate_urlstring

Optional: the https address of your mark certificate (VMC or CMC, a .pem file). Gmail needs one; Apple Mail needs a VMC.

Response

The record is set (or record_to_add says what to add).

email_domain_idstring required
domainstring required
readyboolean required
dns_managedboolean required

The DNS is hosted here, so set_email_bimi sets the record itself.

stepsstring[] required
notestring required

Which mailboxes show the logo, and what they need.

Changes

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