Skip to main content
POST
Create recipient rule
Requires the IAM action notifications:Publish. 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
match_type
enum<string>
required

Exact local part, local-part prefix, or catch-all for this identity. Exact matches take precedence, then the longest prefix, then catch-all.

Available options:
exact,
prefix,
all
topic
string
required

Notifications topic name, UUID or CRN. Requires notifications:Publish on the same-account topic.

local_part
string

Required for exact and prefix; empty or omitted for all.

Maximum string length: 64
enabled
boolean
default:true

Response

Success

rule
object
required