Add notification recipients
π Admin only. Requires administrator privileges β the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
Subscribes one or more recipients (1β1000 per request) to a notification. Each recipient is one of: a main console USER (identified by userId or email); an EMBED_USER (identified by embedTenantName + externalId, auto-provisioned if it does not yet exist, and optionally given securityContext, userAttributes, and groups that drive per-recipient rendering); or SLACK β not yet supported, a request containing a Slack recipient is rejected with 400. Every recipient must resolve to a valid email (an embed userβs email, or an email-shaped externalId); otherwise the whole request fails with 400 before anything is written. The operation is idempotent: the response buckets each recipient into createdRecipients, updatedRecipients (an existing recipient whose embed properties changed), or unchangedRecipients.
Authorizations
API key authentication. Send Authorization: Api-Key <YOUR_API_KEY>.
Path Parameters
Numeric id of the deployment that owns the notification.
Numeric id of the notification (scheduled run).
Body
AddNotificationRecipientsInput
Recipients to subscribe (1β1000 per request)
1 - 1000 elementsResponse
Recipients newly subscribed by this request
Recipients that already existed and were left unchanged
Existing recipients whose properties (e.g. embed security context / attributes / groups, or Slack channel name) were updated