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

# Vibe

Vibe is a streaming TV advertising platform for managing advertisers, audiences, campaigns, creatives, strategies, and reporting.

- **Category:** ads & conversion
- **Auth:** OAUTH2, S2S_OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 13
- **Triggers:** 0
- **Slug:** `VIBE`
- **Version:** 00000000_00

## Tools

### Change Campaign Delivery

**Slug:** `VIBE_CHANGE_CAMPAIGN_DELIVERY`

Pause or activate a campaign. WARNING: ACTIVATE can resume paid delivery and spend. Use only after reviewing the campaign, strategies, budget, schedule, targeting, and creatives.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string ("PAUSE" | "ACTIVATE") | Yes | PAUSE stops delivery. ACTIVATE resumes delivery and can resume paid spend. |
| `account_id` | integer | No | Vibe account ID. Required only for embedded apps. |
| `campaign_id` | string | Yes | Campaign whose delivery lifecycle will change. |

#### 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 |

### Change Strategy Delivery

**Slug:** `VIBE_CHANGE_STRATEGY_DELIVERY`

Pause or activate a strategy. WARNING: ACTIVATE can immediately resume paid delivery and spend under a published campaign; use it only after reviewing the budget, schedule, targeting, and creatives.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string ("PAUSE" | "ACTIVATE") | Yes | PAUSE stops strategy delivery. ACTIVATE resumes delivery and can immediately resume paid spend under a published campaign. |
| `account_id` | integer | No | Vibe account ID, required only for embedded apps. |
| `strategy_id` | string | Yes | Strategy whose delivery state will change. |

#### 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 |

### Create Campaign

**Slug:** `VIBE_CREATE_CAMPAIGN`

Create a draft campaign configuration for an advertiser. This does not publish or start delivery; review the draft before changing delivery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goal` | string ("AWARENESS" | "INSTALL" | "TRAFFIC" | "RETARGETING" | "SALES" | "LEADS" | "ABM") | Yes | Business outcome the campaign optimizes for. |
| `name` | string | Yes | Campaign name, between 10 and 100 characters. |
| `active` | boolean | No | Whether the draft should be active when it is later published. |
| `countries` | array | Yes | Target countries. Vibe currently requires exactly ["USA"]. |
| `account_id` | integer | No | Vibe account ID. Required only for embedded apps. |
| `advertiser_id` | string | Yes | Advertiser that owns the campaign. |
| `optimization_goal` | object | Yes | Optimization metric and target value in USD. |
| `attribution_window` | string ("TWELVE_HOURS" | "ONE_DAY" | "FORTY_EIGHT_HOURS" | "SEVENTY_TWO_HOURS" | "SEVEN_DAYS" | "THIRTY_DAYS") | No | Conversion attribution window. Omit to use Vibe's default. |

#### 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 |

### Create Strategy

**Slug:** `VIBE_CREATE_STRATEGY`

Create a budgeted, scheduled targeting strategy under a campaign. This configures potential spend but does not publish the parent campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Strategy name, between 3 and 100 characters. |
| `active` | boolean | No | Whether the strategy should be active when its campaign delivers. |
| `budget` | integer | Yes | Whole-dollar budget amount in USD. This is not an amount in cents. |
| `ends_at` | string | No | Delivery end timestamp. Required when budget_type is GLOBAL. |
| `starts_at` | string | Yes | Delivery start timestamp. |
| `targeting` | object | No | Optional geo, inventory, demographic, audience, and schedule targeting. |
| `account_id` | integer | No | Vibe account ID. Required only for embedded apps. |
| `budget_type` | string ("DAILY" | "GLOBAL") | Yes | DAILY applies the budget per day; GLOBAL applies it to the whole strategy. |
| `campaign_id` | string | Yes | Campaign that owns the strategy. |
| `creative_ids` | array | No | Existing creative IDs to attach to the strategy. |

#### 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 |

### Delete Draft Campaign

**Slug:** `VIBE_DELETE_DRAFT_CAMPAIGN`

Permanently delete one draft campaign. Vibe only allows deletion while the campaign is a draft; published campaigns must not use this tool.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | No | Vibe account ID. Required only for embedded apps. |
| `campaign_id` | string | Yes | ID of the draft campaign to permanently delete. |

#### 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 |

### Delete Strategy

**Slug:** `VIBE_DELETE_STRATEGY`

Permanently delete one strategy. Use only when the strategy should no longer exist; pause delivery instead when temporary suspension is intended.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | No | Vibe account ID. Required only for embedded apps. |
| `strategy_id` | string | Yes | ID of the strategy to permanently delete. |

#### 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 |

### Find Advertisers

**Slug:** `VIBE_FIND_ADVERTISERS`

Find advertisers visible to the connection, or return one advertiser when advertiser_id is provided. Use the returned advertiser ID in campaign and reporting workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Case-insensitive advertiser URL filter; list mode only. |
| `name` | string | No | Case-insensitive advertiser name filter; list mode only. |
| `limit` | integer | No | Maximum advertisers in this page; list mode only. |
| `offset` | integer | No | Advertisers to skip on the first page; list mode only. |
| `account_id` | integer | No | Vibe account ID, required only for embedded apps. |
| `next_cursor` | string | No | Opaque cursor returned by a prior list call. Omit for the first page. |
| `advertiser_id` | string | No | Exact advertiser ID. When set, return that advertiser instead of a list. |

#### 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 |

### Find Campaigns

**Slug:** `VIBE_FIND_CAMPAIGNS`

Search campaigns, or return one campaign when campaign_id is provided. Results include delivery state, budget, optimization settings, and linked strategy summaries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum campaigns in this page in list mode (1-5000). |
| `offset` | integer | No | Campaigns to skip on the first page in list mode. |
| `search` | string | No | Case-insensitive campaign name search in list mode (at least 2 characters). |
| `statuses` | array | No | Campaign statuses to include in list mode. Each status is sent as a repeated status query parameter. |
| `account_id` | integer | No | Vibe account ID, required only for embedded apps. |
| `campaign_id` | string | No | Exact campaign ID. When set, return that campaign instead of a list. |
| `next_cursor` | string | No | Opaque cursor returned by a prior list call. Omit for the first page. |
| `advertiser_id` | string | No | Filter campaigns by advertiser in list mode. |

#### 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 |

### Find Strategies

**Slug:** `VIBE_FIND_STRATEGIES`

Search campaign strategies, or return one strategy when strategy_id is provided. Results include budget, schedule, targeting, creative IDs, and delivery state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum strategies in this page in list mode (1-5000). |
| `active` | boolean | No | Filter strategies by active flag in list mode. |
| `offset` | integer | No | Strategies to skip on the first page in list mode. |
| `ends_at` | string | No | Filter by strategy end timestamp in list mode. |
| `starts_at` | string | No | Filter by strategy start timestamp in list mode. |
| `account_id` | integer | No | Vibe account ID, required only for embedded apps. |
| `campaign_id` | string | No | Filter strategies by campaign in list mode. |
| `next_cursor` | string | No | Opaque cursor returned by a prior list call. Omit for the first page. |
| `strategy_id` | string | No | Exact strategy ID. When set, return that strategy instead of a list. |
| `advertiser_id` | string | No | Filter strategies by advertiser in list mode. |

#### 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 |

### Find Targeting Options

**Slug:** `VIBE_FIND_TARGETING_OPTIONS`

Return valid Vibe targeting IDs for one category before creating or updating a strategy. Supports channels, devices, geographic locations, ages, genders, and interests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum results for channels, locations, or interests. Locations allow at most 100; a location search may return more rows than this value. |
| `offset` | integer | No | Results to skip on the first page of channels, locations, or interests. |
| `search` | string | No | Case-insensitive name or label search for channels, locations, or interests. For locations, omit search only when location_type is provided. Search must contain at least two characters. |
| `category` | string ("channels" | "devices" | "locations" | "ages" | "genders" | "interests") | Yes | Targeting option category to return. |
| `channel_id` | string | No | Exact channel ID. Valid only for category='channels'; returns one channel. |
| `next_cursor` | string | No | Opaque cursor returned by a prior channels, locations, or interests call. Omit for the first page. |
| `channel_type` | string ("APPS_AND_CHANNELS" | "LIVE_SPORTS") | No | Limit channel inventory to apps/channels or live sports. |
| `location_type` | string ("REGION" | "METRO" | "CITY" | "ZIPCODE") | No | Limit results to a strategy-supported location type: REGION, METRO, CITY, or ZIPCODE. Valid only for locations. |
| `channel_category` | string | No | Channel category name filter; valid only for channels. |
| `include_deprecated` | boolean | No | Include deprecated channels or locations; valid only for those categories. |

#### 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 |

### Publish Campaign

**Slug:** `VIBE_PUBLISH_CAMPAIGN`

Submit a draft campaign for review and publication. WARNING: publication can begin paid delivery and spend; use only after reviewing its strategies, budget, schedule, targeting, and creatives.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | No | Vibe account ID. Required only for embedded apps. |
| `campaign_id` | string | Yes | Draft campaign to submit for review and publication. |

#### 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 |

### Update Campaign

**Slug:** `VIBE_UPDATE_CAMPAIGN`

Update selected campaign configuration fields without publishing, pausing, or activating delivery. Omitted fields remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goal` | string ("AWARENESS" | "INSTALL" | "TRAFFIC" | "RETARGETING" | "SALES" | "LEADS" | "ABM") | No | New business goal. |
| `name` | string | No | New campaign name. |
| `active` | boolean | No | New active configuration flag. This does not publish, pause, or activate campaign delivery. |
| `account_id` | integer | No | Vibe account ID, required only for embedded apps. |
| `campaign_id` | string | Yes | Campaign to update. |
| `optimization_goal` | object | No | New optimization metric and target value in USD. |
| `attribution_window` | string ("TWELVE_HOURS" | "ONE_DAY" | "FORTY_EIGHT_HOURS" | "SEVENTY_TWO_HOURS" | "SEVEN_DAYS" | "THIRTY_DAYS") | No | New conversion attribution window. |

#### 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 |

### Update Strategy

**Slug:** `VIBE_UPDATE_STRATEGY`

Update selected strategy budget, schedule, targeting, creatives, or configuration. This can change future spend or reach but does not publish the parent campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New strategy name. |
| `active` | boolean | No | New active configuration flag. |
| `budget` | integer | No | New budget amount in USD. |
| `ends_at` | string | No | New delivery end timestamp. Set explicitly to null to clear it. |
| `starts_at` | string | No | New delivery start timestamp. |
| `targeting` | object | No | Replacement targeting configuration. |
| `account_id` | integer | No | Vibe account ID, required only for embedded apps. |
| `budget_type` | string ("DAILY" | "GLOBAL") | No | New daily or total budget interpretation. |
| `strategy_id` | string | Yes | Strategy to update. |
| `creative_ids` | array | No | Replacement creative IDs. Pass an empty list to detach all creatives. |

#### 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 |