Remove notification recipients

curl --request DELETE \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": [
    {
      "id": 123,
      "embedTenantName": "<string>"
    }
  ]
}
'

Notifications

Remove 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.

Unsubscribes one or more recipients (1–1000 per request) from a notification. Each entry is identified by type plus the id returned by the API — userId for USER, embedUserId for EMBED_USER, or channelId for SLACK. EMBED_USER entries must also include embedTenantName, which locates the recipient’s storage partition. Removals are idempotent (deleting a recipient that isn’t subscribed is a no-op). Returns 204 No Content, or 404 if the notification is not part of this deployment.

DELETE

deployments

{deploymentId}

notifications

{id}

recipients

Remove notification recipients

curl --request DELETE \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": [
    {
      "id": 123,
      "embedTenantName": "<string>"
    }
  ]
}
'

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.

integer

required

Numeric id of the notification (scheduled run).

Body

application/json

RemoveNotificationRecipientsInput

recipients

object[]

required

Recipients to unsubscribe (1–1000 per request)

Required array length: 1 - 1000 elements

Show child attributes

Response

Successful response

Add notification recipients List shared workspace items

⌘I