Skip to main content
PATCH
Set BIMI logo / VMC URLs
Requires the IAM action email:SetBIMI. See EMAIL permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

identity_id
string<uuid>
required

Body

application/json

Omitted URLs are preserved. Null logo_url clears BIMI, including its certificate; null vmc_url clears only the certificate. A certificate requires a logo.

logo_url
string | null

HTTPS SVG Tiny PS URL; null clears BIMI.

Minimum string length: 1
vmc_url
string | null

Optional HTTPS VMC URL; omission preserves it and null removes the certificate.

Minimum string length: 1

Response

Updated identity.

identity
object
required