> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Toneden

> ToneDen automates social media campaigns, advertising, and landing pages, particularly for music promoters and event organizers looking to boost audience reach

![Toneden logo](https://mintcdn.com/composio-preview/IA0_SoMcsWt17HEC/images/toolkits/toneden.svg?fit=max\&auto=format\&n=IA0_SoMcsWt17HEC\&q=85\&s=d9b56bacf9387b663e62485617e69f1a)

* **Category:** social media marketing
* **Auth:** API\_KEY, OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 26
* **Triggers:** 0
* **Slug:** `TONEDEN`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Advertising Campaign
>
> **Slug:** `TONEDEN_CREATE_ADVERTISING_CAMPAIGN`
>
> Tool to create a ToneDen advertising campaign on Facebook or Google platforms. Use when you need to launch a new ad campaign with specified budget, targeting, and creatives.
>
> #### Input Parameters
>
> **title** `string`
>
> Campaign name/title for identification.
>
> **status** `string`
>
> Initial campaign status (e.g., draft, active, paused).
>
> **target** `string`
>
> URL or object ID to promote.
>
> **currency** `string`
>
> Currency code for the budget (e.g., USD, EUR).
>
> **platform** `string ("facebook" | "google")` *required*
>
> The advertising platform to use (facebook or google).
>
> **audiences** `array` *required*
>
> Array of audience objects for targeting. Structure varies by platform.
>
> **creatives** `object` *required*
>
> Creative assets for the campaign. Structure varies by platform.
>
> **objective** `string`
>
> Marketing objective for the campaign.
>
> **targeting** `object`
>
> Additional targeting parameters for the campaign.
>
> **budget\_type** `string ("daily" | "lifetime")` *required*
>
> Budget allocation strategy (daily or lifetime).
>
> **target\_type** `string`
>
> Campaign objective type (e.g., conversions, reach, engagement).
>
> **budget\_amount** `number` *required*
>
> Numeric budget value in the specified currency.
>
> **end\_timestamp** `integer`
>
> UNIX timestamp for when the campaign should end.
>
> **is\_continuous** `boolean`
>
> If true, the campaign runs indefinitely (no end date).
>
> **report\_emails** `array`
>
> Email addresses to receive campaign reports.
>
> **optimization\_id** `string`
>
> Optimization goal identifier for the campaign.
>
> **start\_timestamp** `integer`
>
> UNIX timestamp for when the campaign should start.
>
> **target\_link\_url** `string`
>
> URL to direct users to when they click the ad.
>
> **external\_poster\_id** `string`
>
> ID of the external poster/page for the campaign.
>
> **instagram\_account\_id** `string`
>
> Instagram account ID for Instagram placements (Facebook platform).
>
> **external\_ad\_account\_id** `string` *required*
>
> ID of the external ad account on the platform.
>
> **disable\_all\_notifications** `boolean`
>
> If true, disables all email notifications for this campaign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Attachment
>
> **Slug:** `TONEDEN_CREATE_ATTACHMENT`
>
> Create a social unlock or contest attachment. The response includes the HTTP status and may contain an error instead of a created attachment.
>
> #### Input Parameters
>
> **type** `string ("unlock" | "contest")` *required*
>
> Attachment type: 'unlock' for social unlock or 'contest' for a contest attachment.
>
> **platform** `string ("facebook" | "facebook-messenger" | "email" | "soundcloud" | "spotify" | "spotify-pre-save" | "apple-music-playlist" | "apple-music-pre-add" | "spotify-save" | "twitch" | "twitter" | "twitter-tweet" | "spotify-stream" | "facebook-share" | "custom-url-visit")`
>
> Social action for single-action attachments. Required when type='unlock' and only one social action.
>
> **platforms** `array`
>
> List of social actions for multi-action attachments. Required when type='contest' or multiple unlock actions.
>
> **unlock\_text** `string`
>
> Coupon code text to display. Required when unlock\_type='coupon'.
>
> **unlock\_type** `string ("download" | "coupon" | "link" | "stream")`
>
> Reward type for social unlocks. Required when type='unlock'.
>
> **download\_url** `string`
>
> URL of the file to download or link target. Required when unlock\_type='download' or 'link'.
>
> **messenger\_page\_id** `string`
>
> Facebook Page ID to subscribe on Messenger. Required when platform='facebook-messenger'.
>
> **stream\_unlock\_url** `string`
>
> URL of the unlisted video to stream. Required when unlock\_type='stream'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create ToneDen Link
>
> **Slug:** `TONEDEN_CREATE_LINK`
>
> Create a ToneDen link for music, podcast, livestream, event, tour, biglink, fundraiser, smartlink, or custom content. A nonempty services array is required for music, podcast, livestream, tour, and biglink; it must be omitted for the other types.
>
> #### Input Parameters
>
> **services** `array`
>
> Conditionally required array of service-specific objects; required for target\_types: music, podcast, livestream, tour, biglink; must be omitted for event, fundraiser, smartlink, custom.
>
> **target\_type** `string ("music" | "podcast" | "livestream" | "event" | "tour" | "biglink" | "fundraiser" | "smartlink" | "custom")` *required*
>
> Determines the link landing page type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Advertising Campaign
>
> **Slug:** `TONEDEN_DELETE_ADVERTISING_CAMPAIGN`
>
> Delete a ToneDen advertising campaign by ID. The response includes the HTTP status and may contain an error rather than confirming deletion.
>
> #### Input Parameters
>
> **campaignID** `string` *required*
>
> ID of the advertising campaign to delete. Accepts string or int.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete ToneDen Link
>
> **Slug:** `TONEDEN_DELETE_LINK`
>
> Deletes a ToneDen link by ID using DELETE /links/\{linkID}.
>
> #### Input Parameters
>
> **link\_id** `string` *required*
>
> ID of the link to delete. Accepts string or int.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete ToneDen Playbook Campaign
>
> **Slug:** `TONEDEN_DELETE_PLAYBOOK_CAMPAIGN`
>
> Deletes a ToneDen playbook campaign by ID using DELETE /playbooks/campaigns/\{campaignID}.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> ID of the playbook campaign to delete. Accepts string or int.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Expand ToneDen Link Template
>
> **Slug:** `TONEDEN_EXPAND_LINK_TEMPLATE`
>
> Tool to expand a ToneDen link template. Use when you need to retrieve the full template link with your tracking pixels and optional service links. Provide a URL to generate platform services for music or podcast content.
>
> #### Input Parameters
>
> **url** `string`
>
> Optional source URL for music or podcast; when provided, the API generates a services array linking to that track across platforms.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Advertising Campaign
>
> **Slug:** `TONEDEN_GET_ADVERTISING_CAMPAIGN`
>
> Retrieve a specific advertising campaign by its ID using ToneDen's API. Endpoint: GET /advertising/campaigns/\{campaignID} Notes: - This endpoint does not require a userID in the path per official docs. - Some accounts may not have advertising access; in such cases, non-2xx responses are still returned here for observability instead of raising, so the caller can inspect the error object.
>
> #### Input Parameters
>
> **campaignID** `string` *required*
>
> The ID of the advertising campaign to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Advertising Campaign Creative Insights
>
> **Slug:** `TONEDEN_GET_ADVERTISING_CAMPAIGN_CREATIVE_INSIGHTS`
>
> Retrieve creative performance insights for a specific advertising campaign using ToneDen's API. Endpoint: GET /advertising/campaigns/\{campaignID}/creativeInsights. Note: Endpoint uses camelCase `creativeInsights` per official docs.
>
> #### Input Parameters
>
> **campaignID** `string` *required*
>
> The ID of the advertising campaign to retrieve creative insights for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Advertising Campaign Insights
>
> **Slug:** `TONEDEN_GET_ADVERTISING_CAMPAIGN_INSIGHTS`
>
> Retrieve performance insights for a specific advertising campaign using ToneDen's API. Endpoint: GET /advertising/campaigns/\{campaignID}/insights.
>
> #### Input Parameters
>
> **campaignID** `string` *required*
>
> The ID of the advertising campaign to retrieve insights for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Attachment
>
> **Slug:** `TONEDEN_GET_ATTACHMENT`
>
> Tool to retrieve an attachment by ID. Use when you need to fetch details of an existing attachment by its ID.
>
> #### Input Parameters
>
> **attachmentID** `string` *required*
>
> The unique identifier of the attachment to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Attachment Entries Time Series
>
> **Slug:** `TONEDEN_GET_ATTACHMENT_ENTRIES_TIME_SERIES`
>
> Tool to fetch time-series entry statistics for a specific attachment. Use when you need chronological entry data points for an attachment.
>
> #### Input Parameters
>
> **attachmentID** `string` *required*
>
> The unique identifier of the attachment for which to retrieve entry time-series data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Attachment Entries Totals
>
> **Slug:** `TONEDEN_GET_ATTACHMENT_ENTRIES_TOTALS`
>
> Tool to fetch summary counts of entries for an attachment. Use when you need aggregate entry counts over day, week, month, and lifetime.
>
> #### Input Parameters
>
> **attachmentID** `string` *required*
>
> The unique identifier of the attachment for which to retrieve entry totals.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Attachment Unlocks By Platform
>
> **Slug:** `TONEDEN_GET_ATTACHMENT_UNLOCKS_BY_PLATFORM`
>
> Tool to fetch counts of unlocks by platform for a specific attachment. Use when you need a breakdown of unlocks across platforms like Spotify, Twitter, etc.
>
> #### Input Parameters
>
> **attachmentID** `string` *required*
>
> The unique identifier of the attachment for which to retrieve unlock counts by platform.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Attachment Unlocks Time Series
>
> **Slug:** `TONEDEN_GET_ATTACHMENT_UNLOCKS_TIME_SERIES`
>
> Tool to fetch time-series unlock statistics for a specific attachment. Use when you need chronological unlock data points for an attachment.
>
> #### Input Parameters
>
> **attachmentID** `string` *required*
>
> The unique identifier of the attachment for which to retrieve unlock time-series data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Link
>
> **Slug:** `TONEDEN_GET_LINK`
>
> Tool to retrieve a specific ToneDen link by its ID. Use when you need to fetch details about an existing link.
>
> #### Input Parameters
>
> **linkID** `integer` *required*
>
> Numeric ID of the link to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Link Insights
>
> **Slug:** `TONEDEN_GET_LINK_INSIGHTS`
>
> Retrieve detailed insights for a ToneDen link by ID, including clicks, clickthroughs, or RSVPs, with optional date and aggregation filters.
>
> #### Input Parameters
>
> **linkID** `string` *required*
>
> Numeric ID of the link to retrieve performance data for.
>
> **metric** `string ("clicks" | "clickthroughs" | "rsvps")` *required*
>
> Which action type to query results for. 'rsvps' is only a valid value for livestream links.
>
> **end\_date** `string`
>
> If provided, only actions that occurred before the specified date will be counted. Should be in ISO 8601 format.
>
> **start\_date** `string`
>
> If provided, only actions that occurred after the specified date will be counted. Should be in ISO 8601 format.
>
> **aggregate\_geo** `string ("city" | "country" | "region")`
>
> Groups results by visitor location.
>
> **for\_distinct\_fans** `boolean`
>
> If true, only one action per fan will be counted in the stats.
>
> **aggregate\_interval** `string ("day" | "hour" | "week")`
>
> Groups results by specified time interval.
>
> **aggregate\_by\_service** `boolean`
>
> Groups results by service clicked.
>
> **aggregate\_by\_referrer** `boolean`
>
> Groups results by referring domain.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Link Insights Overview
>
> **Slug:** `TONEDEN_GET_LINK_INSIGHTS_OVERVIEW`
>
> Tool to retrieve a summary overview of a link's performance insights. Use when you have a link ID and need aggregated metrics across platforms.
>
> #### Input Parameters
>
> **linkID** `string` *required*
>
> The unique identifier of the link to retrieve insights for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get ToneDen User
>
> **Slug:** `TONEDEN_GET_USER`
>
> Tool to retrieve a specific ToneDen user by ID. Use when you need to fetch user profile information or details about the currently authenticated user.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> ID of the user to retrieve. Use 'me' to get the currently-authenticated user, or provide a numeric user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List ToneDen Playbook Campaigns
>
> **Slug:** `TONEDEN_LIST_PLAYBOOK_CAMPAIGNS`
>
> Tool to list playbook campaigns. Use when you need to retrieve a paginated list of all playbook campaigns.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of campaigns to return; must be >= 1.
>
> **offset** `integer`
>
> Number of campaigns to skip before starting to collect the result set; must be >= 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List User Attachments
>
> **Slug:** `TONEDEN_LIST_USER_ATTACHMENTS`
>
> Tool to list attachments for a user. Use when you need to retrieve social unlocks or contest attachments belonging to a specific user.
>
> #### Input Parameters
>
> **type** `string ("unlock" | "contest")` *required*
>
> Type of attachments to list: 'unlock' for social unlocks or 'contest' for contests.
>
> **limit** `integer`
>
> Maximum number of results to return.
>
> **offset** `integer`
>
> Pagination offset for results.
>
> **userID** `string` *required*
>
> Numeric ID of the user whose attachments to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List User Lists
>
> **Slug:** `TONEDEN_LIST_USER_LISTS`
>
> Tool to retrieve a list of a user's advertising user lists. Use when you need to fetch all user lists (custom audiences) for a specific ToneDen user.
>
> #### Input Parameters
>
> **userID** `string` *required*
>
> ID of the user whose user lists to retrieve. Use 'me' to get lists for the currently-authenticated user, or provide a numeric user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Attachment
>
> **Slug:** `TONEDEN_UPDATE_ATTACHMENT`
>
> Update an existing attachment using supplied fields and additional custom payload fields. The response includes the HTTP status and may contain an error instead of confirming an update.
>
> #### Input Parameters
>
> **type** `string ("unlock" | "contest")`
>
> Attachment type: 'unlock' for social unlock or 'contest' for multi-action contest
>
> **update** `object`
>
> Additional arbitrary fields to merge into the update payload
>
> **platform** `string ("facebook" | "facebook-messenger" | "email" | "soundcloud" | "spotify" | "spotify-pre-save" | "apple-music-playlist" | "apple-music-pre-add" | "spotify-save" | "twitch" | "twitter" | "twitter-tweet" | "spotify-stream" | "facebook-share" | "custom-url-visit")`
>
> Social action for single-action attachments. Required when type='unlock'
>
> **link\_path** `string`
>
> Custom path segment for the attachment's landing page
>
> **platforms** `array`
>
> List of social actions for multi-action attachments. Required when type='contest'
>
> **unlock\_text** `string`
>
> Coupon code text when unlock\_type is 'coupon'
>
> **unlock\_type** `string ("download" | "coupon" | "link" | "stream")`
>
> Type of unlock for social unlock attachments
>
> **attachmentID** `string` *required*
>
> ID of the attachment to update
>
> **download\_url** `string`
>
> URL for download or link when unlock\_type is 'download' or 'link'
>
> **messenger\_page\_id** `string`
>
> Facebook Page ID for Messenger subscriptions when platform='facebook-messenger'
>
> **stream\_unlock\_url** `string`
>
> Streaming URL when unlock\_type is 'stream'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update ToneDen Playbook Campaign
>
> **Slug:** `TONEDEN_UPDATE_PLAYBOOK_CAMPAIGN`
>
> Updates a ToneDen playbook campaign by ID using PUT /playbooks/campaigns/\{campaignID}. Note: ToneDen's public docs do not expose the full request body schema for updates. This action sends a flexible JSON payload composed from provided fields and returns diagnostic information without raising on non-2xx responses, to aid real-world testing.
>
> #### Input Parameters
>
> **name** `string`
>
> Name of the playbook campaign
>
> **notes** `string`
>
> Optional notes or description for the campaign
>
> **budget** `number`
>
> Optional budget value for the campaign
>
> **status** `string`
>
> Status of the campaign (if supported by API)
>
> **update** `object`
>
> Additional arbitrary fields for the update payload when not covered by explicit parameters
>
> **end\_date** `string`
>
> ISO8601 end date string (if supported by API)
>
> **metadata** `object`
>
> Arbitrary metadata dictionary to include in the update
>
> **start\_date** `string`
>
> ISO8601 start date string (if supported by API)
>
> **campaign\_id** `string` *required*
>
> ID of the playbook campaign to update. Accepts string or int.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update ToneDen User
>
> **Slug:** `TONEDEN_UPDATE_USER`
>
> Tool to update a ToneDen user's profile. Use when you need to modify user details (e.g., name, location, or settings) after fetching them.
>
> #### Input Parameters
>
> **city** `string`
>
> City where the user is located
>
> **about** `string`
>
> Bio or about text for the user
>
> **state** `string`
>
> State or province of the user
>
> **policy** `string`
>
> Custom policy text for the user
>
> **country** `string`
>
> Country code (e.g., 'US')
>
> **user\_id** `string` *required*
>
> ID of the user to update; use 'me' to target the current authenticated user
>
> **profile\_url** `string`
>
> URL to the user's public profile page
>
> **display\_name** `string`
>
> New display name for the user
>
> **timezone\_name** `string`
>
> IANA timezone string (e.g., 'America/Los\_Angeles')
>
> **additional\_emails** `array`
>
> List of additional email addresses for the user
>
> **interface\_settings** `object`
>
> User interface preference settings
>
> **advertising\_settings** `object`
>
> User advertising preference settings
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Link Path
>
> **Slug:** `TONEDEN_VALIDATE_LINK_PATH`
>
> Tool to check if a link path/subdomain combination is unique and valid. Use when creating or editing a ToneDen link to verify the path is available.
>
> #### Input Parameters
>
> **path** `string` *required*
>
> The shortened\_path to check for validity.
>
> **link\_id** `integer`
>
> Numeric ID of the link being checked for validity. This parameter can be passed when editing a link to prevent the uniqueness check from comparing the link to itself.
>
> **subdomain** `string`
>
> The subdomain to check for validity.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
