---
canonical_url: "https://docs.composio.dev/toolkits/bulkpublish"
markdown_url: "https://docs.composio.dev/toolkits/bulkpublish.md"
product: "platform"
version: null
last_updated: null
---

# BulkPublish

BulkPublish manages, schedules, publishes, and analyzes social media content across multiple platforms.

- **Category:** social media marketing
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `BULKPUBLISH`
- **Version:** 00000000_00

## Tools

### Get Analytics Summary

**Slug:** `BULKPUBLISH_GET_ANALYTICS_SUMMARY`

Summarize post counts by status, platform, and day for a required date range of up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | Yes | Inclusive end date in YYYY-MM-DD format; the range may span up to 30 days. |
| `timezone` | string | No | IANA timezone used for day boundaries. |
| `from_date` | string | Yes | Inclusive start date in YYYY-MM-DD format. |
| `include_heatmap` | boolean | No | Whether to include up to 5,000 raw publish timestamps for a heatmap. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Request Usage

**Slug:** `BULKPUBLISH_GET_API_REQUEST_USAGE`

Return today's organization-wide API request count, daily limit, plan, and per-key breakdown. The call itself consumes one daily request.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Plan Usage

**Slug:** `BULKPUBLISH_GET_PLAN_USAGE`

Return the connected organization's plan, feature limits, and current resource usage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `timezone` | string | No | IANA timezone used to calculate today's scheduled-post count. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Platform Availability

**Slug:** `BULKPUBLISH_GET_PLATFORM_AVAILABILITY`

Return current connection and publishing availability for every supported platform and platform variant.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Activity

**Slug:** `BULKPUBLISH_LIST_ACTIVITY`

Return one page of organization audit activity, optionally filtered by action or resource type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum activity records to return on this page. |
| `action` | string | No | Filter by provider action type. |
| `resource` | string | No | Filter by provider resource type. |
| `next_cursor` | string | No | Continuation cursor from a previous response; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Channels

**Slug:** `BULKPUBLISH_LIST_CHANNELS`

Return active connected social channels by default, or inactive channels when active is false, including platform and token state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active` | boolean | No | Return active channels by default; set false to return inactive channels. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Labels

**Slug:** `BULKPUBLISH_LIST_LABELS`

Return post or media labels available in the connected organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label_type` | string ("post" | "media") | No | Filter labels by 'post' or 'media'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Media

**Slug:** `BULKPUBLISH_LIST_MEDIA`

Search uploaded media by filename or labels and return one page of files.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum files to return on this page. |
| `search` | string | No | Search media by filename. |
| `label_ids` | array | No | Media label IDs used to filter files. |
| `next_cursor` | string | No | Continuation cursor from a previous response; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notifications

**Slug:** `BULKPUBLISH_LIST_NOTIFICATIONS`

Return one page of organization notifications, optionally restricted to unread items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum notifications to return on this page. |
| `next_cursor` | string | No | Continuation cursor from a previous response; omit for the first page. |
| `unread_only` | boolean | No | Return only unread notifications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Posts

**Slug:** `BULKPUBLISH_LIST_POSTS`

Search and filter the connected organization's posts, returning one page and a cursor when more results are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum posts to return on this page (1-500). |
| `search` | string | No | Search within post content. |
| `status` | string ("draft" | "scheduled" | "publishing" | "published" | "processing" | "failed" | "partial") | No | Filter by draft, scheduled, publishing, published, processing, failed, or partial status. |
| `label_ids` | array | No | Label IDs to filter by. |
| `channel_id` | integer | No | Filter by connected channel ID. |
| `created_to` | string | No | Include posts created on or before this YYYY-MM-DD date. |
| `label_mode` | string ("or" | "and") | No | Combine multiple label IDs using 'or' or 'and'. |
| `next_cursor` | string | No | Continuation cursor from a previous response; omit for the first page. |
| `created_from` | string | No | Include posts created on or after this YYYY-MM-DD date. |
| `scheduled_to` | string | No | Include posts scheduled on or before this YYYY-MM-DD date. |
| `recurring_only` | boolean | No | When true, return recurring posts only. |
| `scheduled_from` | string | No | Include posts scheduled on or after this YYYY-MM-DD date. |
| `approval_status` | string ("none" | "pending" | "approved" | "rejected") | No | Filter by none, pending, approved, or rejected approval state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
