Skip to main content

Bundles

A bundle groups an account configuration and optional video configuration for a specific country and platform. Bundles are the core unit of work in the TokPortal API.

Authentication

All endpoints require an API key passed via the X-API-Key header.

X-API-Key: tok_live_xxx

Base URL

https://app.tokportal.com/api/ext

Bundle Types

TypeDescription
account_onlyAccount creation and setup only. No videos.
account_and_videosAccount creation with video uploads.
videos_onlyVideo uploads on an existing account.

Lifecycle

Bundles follow a strict lifecycle:

pending_setup → published → accepted → completed

For bundles that include videos, the video phase adds intermediate states:

accepted → in_review → finalized → completed
StatusDescription
pending_setupBundle created, awaiting configuration.
publishedConfiguration complete, submitted for processing.
acceptedAccount work has been accepted by an operator.
in_reviewVideos are being reviewed.
finalizedVideos have been finalized.
completedAll work is done.

Platforms

PlatformValue
TikToktiktok
Instagraminstagram
YouTubeyoutube

Options

OptionDescriptionRestrictions
niche_warmingWarm the account by engaging with niche-relevant content before publishing.Cannot combine with deep_warming.
deep_warmingExtended warming with deeper engagement signals.Instagram only. Cannot combine with niche_warming.
moderationEnable content moderation on the account.
editingInclude video editing services.
auto_finalize_videosAutomatically finalize videos once ready.

Endpoints

MethodPathDescription
POST/bundlesCreate a bundle
GET/bundlesList all bundles
GET/bundles/:idGet a single bundle
POST/bundles/:id/publishPublish a bundle
POST/bundles/:id/unpublishUnpublish a bundle

List Bundles

Retrieve all bundles for your organization.

GET /bundles

Example

curl -X GET https://app.tokportal.com/api/ext/bundles \
-H "X-API-Key: tok_live_xxx"

Response

{
"data": [
{
"id": "bnd_abc123",
"type": "account_and_videos",
"platform": "tiktok",
"country": "US",
"status": "published",
"options": {
"niche_warming": true,
"deep_warming": false,
"moderation": false,
"editing": false,
"auto_finalize_videos": false
},
"created_at": "2026-01-15T10:30:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
]
}

Get Bundle

Retrieve a single bundle by ID.

GET /bundles/:id

Example

curl -X GET https://app.tokportal.com/api/ext/bundles/bnd_abc123 \
-H "X-API-Key: tok_live_xxx"

Response

{
"data": {
"id": "bnd_abc123",
"type": "account_and_videos",
"platform": "tiktok",
"country": "US",
"status": "published",
"options": {
"niche_warming": true,
"deep_warming": false,
"moderation": false,
"editing": false,
"auto_finalize_videos": false
},
"videos_quantity": 3,
"edits_quantity": 0,
"account": {
"username": "cooluser123",
"visible_name": "Cool User",
"biography": "Just vibes.",
"profile_picture_url": "https://example.com/pic.jpg"
},
"created_at": "2026-01-15T10:30:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
}