Skip to main content
PATCH
Update 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.

Path Parameters

sid
string
required

Subscription allocation sid (bl_al_...).

Required string length: 18
Pattern: ^bl_al_

Body

application/json

Request body of update_subscription_allocation.

linkedin_sender_profiles
integer

New LinkedIn sender profile (account) count.

Required range: x >= 0
email_inboxes
integer

New inbox count.

Required range: x >= 0
credits_per_month
integer

New credits a month.

Required range: x >= 0
whitelabel
integer

1 or 0: the White label entitlement.

Required range: 0 <= x <= 1

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.