concierge.v1.MailRelayService

SendGovernanceMail

Enqueue one governance mail. Idempotent by dedupe_key, so an at-least-once caller may retry without sending twice.

post/concierge.v1.MailRelayService/SendGovernanceMail

Request

  • The document declares no server URL.
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

kind'GOVERNANCE_MAIL_KIND_UNSPECIFIED' | 'GOVERNANCE_MAIL_KIND_PAYOUT_APPROVAL' | 'GOVERNANCE_MAIL_KIND_PAYOUT_OUTCOME' | 'GOVERNANCE_MAIL_KIND_APPROVAL_TOKEN_BURNED' | 'GOVERNANCE_MAIL_KIND_PAYMENT_CONSENT' | 'GOVERNANCE_MAIL_KIND_PAYMENT_APPROVAL' | 'GOVERNANCE_MAIL_KIND_FEE_POLICY_APPROVAL' | 'GOVERNANCE_MAIL_KIND_FEE_POLICY_NOTICE' | 'GOVERNANCE_MAIL_KIND_PAYMENT_OUTCOME'

The typed governance mails this plane knows how to render.

user_idstring

Concierge canonical user id of the recipient. The address is resolved HERE, from the identity record, so the money plane cannot redirect a governance mail.

dedupe_keystring

Idempotency key. The same key never sends twice.

A key names ONE mail: one kind, to one recipient. Reusing a key for the same mail is a retry and answers enqueued: false; reusing it for a different recipient or kind is refused ALREADY_EXISTS, because the key is unique across the whole queue. So a kind told to several people — PAYMENT_OUTCOME to the subject and to each staff member — needs a key per copy.

Response

Success

enqueuedboolean

False when dedupe_key had already been accepted.

Changes

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