Skip to main content
POST
/
v1
/
deployments
/
{deploymentId}
/
notifications
/
{id}
/
recipients
Add notification recipients
curl --request POST \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": [
    {
      "channelId": "<string>",
      "channelName": "<string>",
      "email": "<string>",
      "embedTenantName": "<string>",
      "externalId": "<string>",
      "groups": [
        "<string>"
      ],
      "securityContext": {},
      "userAttributes": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "userId": 123
    }
  ]
}
'
{
  "createdRecipients": [
    {
      "channelId": "<string>",
      "channelName": "<string>",
      "email": "<string>",
      "embedTenantName": "<string>",
      "embedUserId": 123,
      "externalId": "<string>",
      "userId": 123
    }
  ],
  "unchangedRecipients": [
    {
      "channelId": "<string>",
      "channelName": "<string>",
      "email": "<string>",
      "embedTenantName": "<string>",
      "embedUserId": 123,
      "externalId": "<string>",
      "userId": 123
    }
  ],
  "updatedRecipients": [
    {
      "channelId": "<string>",
      "channelName": "<string>",
      "email": "<string>",
      "embedTenantName": "<string>",
      "embedUserId": 123,
      "externalId": "<string>",
      "userId": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

API key authentication. Send Authorization: Api-Key <YOUR_API_KEY>.

Path Parameters

deploymentId
integer
required

Numeric id of the deployment that owns the notification.

id
integer
required

Numeric id of the notification (scheduled run).

Body

application/json

AddNotificationRecipientsInput

recipients
object[]
required

Recipients to subscribe (1–1000 per request)

Required array length: 1 - 1000 elements

Response

200 - application/json
createdRecipients
object[]
required

Recipients newly subscribed by this request

unchangedRecipients
object[]
required

Recipients that already existed and were left unchanged

updatedRecipients
object[]
required

Existing recipients whose properties (e.g. embed security context / attributes / groups, or Slack channel name) were updated