Skip to main content
POST
Create subscription allocation

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_subscription_allocation.

subscription_sid
string
required

The subscription whose pool is shared (bl_sb_...); the caller must be its buyer.

Required string length: 18
Pattern: ^bl_sb_
team_sid
string
required

The workspace that gets the share (ts_tm_...): the buyer's own, or a client workspace of a brand the buyer's team owns.

Required string length: 18
Pattern: ^ts_tm_
linkedin_sender_profiles
integer

LinkedIn sender profiles (accounts) for the workspace; default 0.

Required range: x >= 0
email_inboxes
integer

Inboxes for the workspace; default 0.

Required range: x >= 0
credits_per_month
integer

Platform credits granted every month; default 0.

Required range: x >= 0
whitelabel
integer

1 to let the workspace register brands; default 0.

Required range: 0 <= x <= 1

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required