Skip to content

Create a bundle

POST
/developer/organizations/{organizationId}/bundles
curl --request POST \
--url https://qinto-api.blotout.io/developer/organizations/9c1d2b34-5e67-4f89-a0b1-2c3d4e5f6a7b/bundles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "Growth Stack", "description": "Everything a store needs to measure its marketing.", "longDescription": "Who the bundle is for.\n\nHow support works.", "audience": "public", "appMode": "selected", "appIds": [ "7f3a1c92-4b6d-4e8a-b1d3-5c9e2f7a6b10" ], "pricingModel": "fixed", "basePriceCents": 7200000, "billingInterval": "monthly", "trialDays": 14, "siteLimit": 3, "extraSitePriceCents": 50000, "services": [ { "name": "Priority support", "detail": "", "priceCents": 20000, "basis": "monthly" } ], "usageCapCents": 50000, "meterTerms": [ { "appId": "7f3a1c92-4b6d-4e8a-b1d3-5c9e2f7a6b10", "key": "events", "name": "", "unit": "", "includedAmount": 0, "priceMicros": 500000, "perUnits": 1000 } ] }'

Creates a Draft bundle under the organization. A Draft needs only a name; the returned bundleId is what the other bundle operations reference.

Required permissions

  • None beyond a valid token; requires an OAuth token with the developer or bundles scope, for an owner of the addressed organization or a member with the bundles finance area and all apps
organizationId
required

Unique id (UUID) of the organization that owns the bundles, as listed by GET /me under organizations.

string format: uuid

Example

9c1d2b34-5e67-4f89-a0b1-2c3d4e5f6a7b

Unique id (UUID) of the organization that owns the bundles, as listed by GET /me under organizations.

The new bundle’s name, and its optional descriptions, audience, apps and pricing.

Media typeapplication/json
object
name
required

Display name of the bundle, 1-100 characters.

string
>= 1 characters <= 100 characters

Example

Growth Stack
description

One line about what a team gets, at most 200 characters and with no line break. Omit for none.

string
<= 200 characters

Example

Everything a store needs to measure its marketing.
longDescription

Longer description, at most 5000 characters. Its line breaks are kept. Omit for none.

string
<= 5000 characters

Example

Who the bundle is for.
How support works.
audience

Who can reach the bundle. A new bundle without it is private, and an update without it keeps the current audience. Only a Draft can change it.

string
Allowed values: public private

Example

public
appMode

How the bundle picks its apps. A new bundle without it is selected, and an update without it keeps the current mode. all stores no list.

string
Allowed values: selected all exclude

Example

exclude
appIds

The app list for selected or exclude, as listed by the bundle apps operation. Omit to keep the current list. An id that is not a published app of this organization is refused, and so is a list with all.

Array<string>
pricingModel

How the bundle charges. A new bundle without it is fixed, and an update without it keeps the current model. Publish refuses a field the model doesn’t use; a Draft can hold one.

string
Allowed values: fixed fixed_usage usage free

Example

fixed
basePriceCents

Base price per team, in US cents, at most 100000000. fixed and fixed_usage need one above 0 to publish. Omit to keep the current value, or send null to clear it.

integer | null
<= 100000000

Example

7200000
billingInterval

How often the base price is billed. fixed and fixed_usage need one to publish. Omit to keep the current value, or send null to clear it.

string | null
Allowed values: monthly yearly one_time

Example

yearly
trialDays

Length of the free trial, 0 to 30 days. free has none. Omit to keep the current value, or send null to clear it.

integer | null
<= 30

Example

14
siteLimit
Any of:

The number of sites, 1 to 10000.

integer
>= 1 <= 10000

Example

3
extraSitePriceCents

Price of each site past the limit, in US cents. Only a base price model with a fixed limit can sell extra sites, and then the price must be above 0 to publish. Omit to keep the current value, or send null to stop selling them.

integer | null
<= 100000000

Example

50000
services

The services the bundle price covers, at most 20. Omit to keep the current list.

Array<object>
<= 20 items

One service the developer delivers.

object
name
required

Name of the service, at most 100 characters. Needed to publish.

string
<= 100 characters

Example

Priority support
detail

What the team gets, at most 200 characters.

string
"" <= 200 characters

Example

4-hour response
priceCents
required

What the service costs on its own, in US cents. A price above 0 is needed to publish.

integer | null
<= 100000000

Example

20000
basis
required

How the price on its own is billed.

string
Allowed values: monthly one_time

Example

monthly
usageCapCents

The most usage can add to a team’s bill each month, in US cents, at most 100000000. fixed_usage and usage need one above 0 to publish, and the other models refuse one. Omit to keep the current value, or send null to clear it.

integer | null
<= 100000000

Example

50000
meterTerms

The meter terms of a usage model, priced or not, at most 100. Omit to keep the current list. Publish refuses a term no app in the bundle reports, and any term on fixed or free; a Draft can hold one.

Array<object>
<= 100 items

What one meter of one app costs on the bundle.

object
appId
required

Unique id (UUID) of the app that reports the meter.

string format: uuid

Example

7f3a1c92-4b6d-4e8a-b1d3-5c9e2f7a6b10
key
required

Key of the meter in that app.

string
/^[a-z][a-z0-9_]{0,39}$/

Example

events
name

Name of the meter on the bundle, at most 60 characters. Blank uses the key.

string
"" <= 60 characters

Example

Events
unit

Plural unit, at most 60 characters. Needed to publish.

string
"" <= 60 characters

Example

events
includedAmount

Units included each month for the whole team, across its sites.

integer
0 <= 1000000000000

Example

100000
priceMicros
required

Price past the included amount, in US micro-dollars. Null or 0 leaves the meter free, and stores no term.

integer | null
<= 1000000000

Example

500000
perUnits
required

How many units that price covers. Needed to publish.

integer | null
>= 1 <= 1000000

Example

1000

The Draft was created; the response echoes its stored representation.

Media typeapplication/json
object
bundle
required

An offer that sells several of an organization’s apps to a team on one subscription line.

object
bundleId
required

Server-assigned unique id of the bundle. Address the bundle with it in the get, update and delete operations.

string
organizationId
required

Id of the organization that owns the bundle.

string
name
required

Display name of the bundle.

string
description
required

One-line description of what a team gets. Null when not set.

string | null
longDescription
required

Longer description with its line breaks kept. Null when not set.

string | null
status
required

Where the bundle is in its life: draft is not published yet, live is on sale, paused is stopped by Blotout, and retired is no longer sold.

string
Allowed values: draft live paused retired
audience
required

Who can reach the bundle: public is offered in the app store, and private only through bundle links. It locks when the bundle first leaves Draft.

string
Allowed values: public private
appMode
required

How the bundle picks its apps: selected takes the listed apps, all takes every eligible app of the organization, and exclude takes every eligible app except the listed ones. all and exclude add future apps.

string
Allowed values: selected all exclude
pricingModel
required

How the bundle charges: fixed is a base price, fixed_usage a base price and usage, usage only usage, and free nothing. A new bundle without it is fixed.

string
Allowed values: fixed fixed_usage usage free
basePriceCents
required

Base price per team, in US cents. Null when not set.

integer | null
billingInterval
required

How often the base price is billed. Null when not set.

string | null
Allowed values: monthly yearly one_time
trialDays
required

Length of the free trial in days. Null when not set.

integer | null
siteLimit
required
Any of:

The number of sites a team can use the bundle on.

integer
extraSitePriceCents
required

Price of each site past the limit in US cents, billed like the base price. Null when extra sites aren’t sold.

integer | null
services
required

The services the bundle price covers.

Array<object>

A service the developer delivers, which the bundle price covers.

object
name
required

Name of the service. Empty only on a bundle that isn’t published yet.

string
detail
required

What the team gets. Empty when not set.

string
priceCents
required

What the service costs on its own, in US cents. Null only on a bundle that isn’t published yet.

integer | null
basis
required

How the price on its own is billed.

string
Allowed values: monthly one_time
usageCapCents
required

The most usage can add to a team’s bill each month, in US cents. Null when not set.

integer | null
meterTerms
required

The priced meters. Any other meter the apps report is free.

Array<object>

What one meter of one app costs on a bundle. A meter with no term is free.

object
appId
required

Id of the app that reports the meter.

string
key
required

Key of the meter in that app. The same key in two apps is two terms.

string
name
required

Name of the meter on the bundle.

string
unit
required

Plural unit, as the bill shows it. Empty only on a bundle that isn’t published yet.

string
includedAmount
required

Units included each month for the whole team, across its sites.

number
priceMicros
required

Price past the included amount, in US micro-dollars.

integer
perUnits
required

How many units that price covers. Null only on a bundle that isn’t published yet.

integer | null
listedApps
required

The stored app list of a selected or exclude bundle. Empty for all.

Array<object>

An app of the organization, by id and name.

object
appId
required

Unique id of the app.

string
name
required

Display name of the app.

string
apps
required

The apps the bundle holds right now, computed on read: a public bundle takes only apps in the app store, and a private bundle takes every app with a published version that isn’t suspended.

Array<object>

An app of the organization, by id and name.

object
appId
required

Unique id of the app.

string
name
required

Display name of the app.

string
canBeSold
required

Whether the bundle can be sold right now, computed on read: it is live, holds at least one app, and none of the apps a selected bundle lists is unavailable.

boolean
needsAttention
required

Whether the bundle’s apps stop it from selling, computed on read: on a live or paused bundle, an app a selected bundle lists is unavailable, or no app remains. Always false on draft and retired. It clears by itself when Blotout lifts a suspension or approves a new store submission.

boolean
attentionReason
required

Why the bundle needs attention, written for the developer. Null when needsAttention is false.

string | null
affectedApps
required

The unavailable apps behind needsAttention, empty when it is false: the apps a selected bundle lists that were removed from the app store, suspended or taken down, or the apps of an all or exclude bundle that Blotout removed or suspended. May be empty when needsAttention is true, if no Blotout action explains the missing apps; attentionReason still says why.

Array<object>

An app of the organization, by id and name.

object
appId
required

Unique id of the app.

string
name
required

Display name of the app.

string
pauseReason
required

Why Blotout paused the bundle. Null unless the status is paused, and a lift clears it.

string | null
createdAt
required

When the bundle was created, as an ISO 8601 UTC timestamp.

string format: date-time
updatedAt
required

When the bundle was last updated, as an ISO 8601 UTC timestamp.

string format: date-time

Example

{
"bundle": {
"bundleId": "2b7e4d10-8a3c-4f56-9e21-7c0d5b8f3a64",
"organizationId": "9c1d2b34-5e67-4f89-a0b1-2c3d4e5f6a7b",
"name": "Growth Stack",
"description": "Everything a store needs to measure its marketing.",
"longDescription": "Who the bundle is for.\n\nHow support works.",
"status": "draft",
"audience": "public",
"appMode": "selected",
"pricingModel": "fixed",
"basePriceCents": 7200000,
"billingInterval": "monthly",
"trialDays": 14,
"siteLimit": 3,
"extraSitePriceCents": 50000,
"services": [
{
"name": "Priority support",
"detail": "4-hour response, shared Slack channel",
"priceCents": 20000,
"basis": "monthly"
}
],
"usageCapCents": 50000,
"meterTerms": [
{
"appId": "7f3a1c92-4b6d-4e8a-b1d3-5c9e2f7a6b10",
"key": "events",
"name": "Events",
"unit": "events",
"includedAmount": 100000,
"priceMicros": 500000,
"perUnits": 1000
}
],
"listedApps": [
{
"appId": "7f3a1c92-4b6d-4e8a-b1d3-5c9e2f7a6b10",
"name": "Facebook CAPI"
}
],
"apps": [
{
"appId": "7f3a1c92-4b6d-4e8a-b1d3-5c9e2f7a6b10",
"name": "Facebook CAPI"
}
],
"canBeSold": true,
"needsAttention": false,
"attentionReason": "No apps remain, so this bundle can’t be sold. Unavailable: Facebook CAPI.",
"affectedApps": [
{
"appId": "7f3a1c92-4b6d-4e8a-b1d3-5c9e2f7a6b10",
"name": "Facebook CAPI"
}
],
"pauseReason": "The listing promises a discount the price does not give.",
"createdAt": "2026-11-05T00:00:00.000Z",
"updatedAt": "2026-11-05T00:00:00.000Z"
}
}

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter. invalid_body — The JSON body is unparseable or failed schema validation; details pinpoints the offending fields when the body could be parsed. invalid_bundle — The bundle details were rejected, such as a name or description that is empty or too long, a description with a line break, an app that is not a published app of the organization, or a price, trial, site limit, service, link label or link limit out of range. message states which.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: invalid_params invalid_body invalid_bundle
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string
details

Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.

object
key
additional properties

Example

{
"error": "invalid_params",
"message": "The Cloudflare API token is invalid or expired.",
"details": {
"errors": [],
"properties": {
"teamId": {
"errors": [
"Invalid UUID"
]
}
}
}
}

unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: unauthenticated

Example

{
"error": "unauthenticated"
}

forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known. bundles_scope_required — The bearer credential has neither the developer nor the bundles scope, so it reaches no bundle operation whatever the role of its user. Authorize again to get a token with one of them.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: forbidden bundles_scope_required
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "forbidden",
"message": "The Cloudflare API token is invalid or expired."
}

internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: internal

Example

{
"error": "internal"
}