Allocate capacity to a channel

Reserves part of a pool for one commercial channel (e.g. Eden 30 of 50). Shares are exclusive: what no allocation claims is the organization's own share, and a channel never sells past the pool's total. Channel slugs are case-insensitive.

POST
/v1/reservations/pools/{poolId}/allocations

Reserves part of a pool for one commercial channel (e.g. Eden 30 of 50). Shares are exclusive: what no allocation claims is the organization's own share, and a channel never sells past the pool's total. Channel slugs are case-insensitive.

Authorization

AuthorizationBearer <token>

The organization API key, sent as Authorization: Bearer <key>.

In: header

Path Parameters

poolId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

capacityNominal*integer
Range1 <= value
channel*string
Length1 <= length
endsOn?|

A calendar day in YYYY-MM-DD.

Match^\d{4}-\d{2}-\d{2}$
slotKey?string|null
startsOn?|

A calendar day in YYYY-MM-DD.

Match^\d{4}-\d{2}-\d{2}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/reservations/pools/string/allocations" \  -H "Content-Type: application/json" \  -d '{    "capacityNominal": 1,    "channel": "string"  }'
{  "capacityNominal": 0,  "channel": "string",  "createdAt": "2019-08-24T14:15:22Z",  "endsOn": "string",  "id": "string",  "poolId": "string",  "slotKey": "string",  "startsOn": "string",  "updatedAt": "2019-08-24T14:15:22Z"}