Creates one dashboard, report, or commitment subscription with one, two, or three scheduled subscriptions: dashboard-subscription, report-subscription, and commitment-manager. Create does not accept alert or budget. Each type appears at most once. The response is that subscription. Nested entries are ordered by type. name is {source name} (Dashboard Subscription), (Report Subscription), or (Commitment Subscription), taken from the nested type that sorts first. createdBy is the caller.
subscriptions must contain one to three entries. A repeated type is 422 customers.duplicate_subscription_type. An alert or budget type, an empty subscriptions array, or any server-set field (id, name, createdBy, etag, permissions, source.name, schedule.nextAt) is 422 validation_failed. source.id must belong to the tenant. A missing or foreign source is 422 validation_failed. Recipient and schedule value rules are on CustomerSubscriptionRecipients and CustomerSubscriptionScheduleInput.
The caller must be allowed to manage every sent type: a DoiT employee, Manage Settings, or the permission for that type. Users Manager alone grants no access.
Idempotency-Key is required. The same key, caller, customer, method, path, and body replays the stored success response. A different body for that key is 422 idempotency_key_reused. A missing key is 400 idempotency_key_required. While the first request is in progress, another request with that key is 409 idempotency_request_in_progress. A 4xx response releases the key. dryRun=true does not reserve the key. It returns the would-be subscription with id and etag null and writes nothing.
Reads are immediately consistent. After a 201, a GET of that id returns the created subscription. The first delivery can take up to an hour.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||