Skip to main content
PATCH
Update receiving configuration
Requires the IAM action email:UpdateReceivingConfiguration. 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
enabled
boolean
attachments_bucket
string | null

Same-account, same-region bucket name, UUID or CRN. Omission preserves the current bucket; null clears it while receiving is disabled. Saving requires storage PutObject and GetObject permission under email/{identity_id}/ in this bucket. Changing the bucket affects new messages only.

Response

Success