> For the complete documentation index, see [llms.txt](https://docs.toolhouse.ai/toolhouse/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toolhouse.ai/toolhouse/integrations/toneden.md). # Toneden Your Toolhouse AI Worker can connect to Toneden using 26 specialized tools. ## Auth Connection This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under [Auth Connections](https://toolhouse.app/auth-connections?authkit_slugs=toneden). ## Tools (26) ### `Toneden Create Advertising Campaign` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------------------------- | ------- | :------: | -------------------- | ---------------------------------------------------------------------- | | `title` | string | | `"Test Campaign"` | 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"` | The advertising platform to use (facebook or google). | | `audiences` | array | ✅ | `[]` | Array of audience objects for targeting. Structure varies by platform. | | `creatives` | object | ✅ | `{}` | 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"` | Budget allocation strategy (daily or lifetime). | | `target_type` | string | | — | Campaign objective type (e.g., conversions, reach, engagement). | | `budget_amount` | number | ✅ | `1000` | 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 | ✅ | `"test_account_123"` | ID of the external ad account on the platform. | | `disable_all_notifications` | boolean | | — | If true, disables all email notifications for this campaign. | *** ### `Toneden Create Attachment` Integration name: **TONEDEN\_CREATE\_ATTACHMENT** Tool to create an attachment. Use when you need to programmatically create a social unlock or contest attachment after gathering all required parameters. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------------- | ------ | :------: | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | `type` | string | ✅ | `"unlock"` | Attachment type: 'unlock' for social unlock or 'contest' for a contest attachment. | | `platform` | string | | — | 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 | | `"DISCOUNT2021"` | Coupon code text to display. Required when unlock\_type='coupon'. | | `unlock_type` | string | | `"download"` | Reward type for social unlocks. Required when type='unlock'. | | `download_url` | string | | `"https://example.com/file.mp3"` | URL of the file to download or link target. Required when unlock\_type='download' or 'link'. | | `messenger_page_id` | string | | `"123456789"` | Facebook Page ID to subscribe on Messenger. Required when platform='facebook-messenger'. | | `stream_unlock_url` | string | | `"https://youtube.com/watch?v=12345"` | URL of the unlisted video to stream. Required when unlock\_type='stream'. | *** ### `Toneden Create Link` Integration name: **TONEDEN\_CREATE\_LINK** Tool to create a ToneDen link. Use when you have the target\_type and, if needed, the services array. Supports creation of links for music, podcast, livestream, event, tour, biglink, fundraiser, smartlink, and custom types. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------- | ------ | :------: | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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"` | Determines the link landing page type. | *** ### `Toneden Delete Advertising Campaign` Integration name: **TONEDEN\_DELETE\_ADVERTISING\_CAMPAIGN** Deletes a ToneDen advertising campaign by ID using DELETE /advertising/campaigns/{campaignID}. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ---- | :------: | --------- | ---------------------------------------------------------------- | | `campaignID` | — | ✅ | `"12345"` | ID of the advertising campaign to delete. Accepts string or int. | *** ### `Toneden Delete Link` Integration name: **TONEDEN\_DELETE\_LINK** Deletes a ToneDen link by ID using DELETE /links/{linkID}. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ---- | :------: | ------- | ------------------------------------------------ | | `link_id` | — | ✅ | — | ID of the link to delete. Accepts string or int. | *** ### `Toneden Delete Playbook Campaign` Integration name: **TONEDEN\_DELETE\_PLAYBOOK\_CAMPAIGN** Deletes a ToneDen playbook campaign by ID using DELETE /playbooks/campaigns/{campaignID}. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------- | ---- | :------: | ------- | ------------------------------------------------------------- | | `campaign_id` | — | ✅ | — | ID of the playbook campaign to delete. Accepts string or int. | *** ### `Toneden Expand Link Template` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `url` | string | | `"https://open.spotify.com/track/12345"` | Optional source URL for music or podcast; when provided, the API generates a services array linking to that track across platforms. | *** ### `Toneden Get Advertising Campaign` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | --------- | ----------------------------------------------- | | `campaignID` | string | ✅ | `"12345"` | The ID of the advertising campaign to retrieve. | *** ### `Toneden Get Advertising Campaign Creative Insights` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | --------- | --------------------------------------------------------------------- | | `campaignID` | string | ✅ | `"12345"` | The ID of the advertising campaign to retrieve creative insights for. | *** ### `Toneden Get Advertising Campaign Insights` Integration name: **TONEDEN\_GET\_ADVERTISING\_CAMPAIGN\_INSIGHTS** Retrieve performance insights for a specific advertising campaign using ToneDen's API. Endpoint: GET /advertising/campaigns/{campaignID}/insights. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | --------- | ------------------------------------------------------------ | | `campaignID` | string | ✅ | `"12345"` | The ID of the advertising campaign to retrieve insights for. | *** ### `Toneden Get Attachment` Integration name: **TONEDEN\_GET\_ATTACHMENT** Tool to retrieve an attachment by ID. Use when you need to fetch details of an existing attachment by its ID. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------ | :------: | ---------------------------- | ---------------------------------------------------- | | `attachmentID` | string | ✅ | `"5f8d0d55e3a8a30017e5b9c1"` | The unique identifier of the attachment to retrieve. | *** ### `Toneden Get Attachment Entries Time Series` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------ | :------: | ---------------------------- | ------------------------------------------------------------------------------------- | | `attachmentID` | string | ✅ | `"5f8d0d55e3a8a30017e5b9c1"` | The unique identifier of the attachment for which to retrieve entry time-series data. | *** ### `Toneden Get Attachment Entries Totals` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------ | :------: | ---------------------------- | --------------------------------------------------------------------------- | | `attachmentID` | string | ✅ | `"5f8d0d55e3a8a30017e5b9c1"` | The unique identifier of the attachment for which to retrieve entry totals. | *** ### `Toneden Get Attachment Unlocks By Platform` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------ | :------: | ---------------------------- | ---------------------------------------------------------------------------------------- | | `attachmentID` | string | ✅ | `"5f8d0d55e3a8a30017e5b9c1"` | The unique identifier of the attachment for which to retrieve unlock counts by platform. | *** ### `Toneden Get Attachment Unlocks Time Series` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------ | :------: | ---------------------------- | -------------------------------------------------------------------------------------- | | `attachmentID` | string | ✅ | `"5f8d0d55e3a8a30017e5b9c1"` | The unique identifier of the attachment for which to retrieve unlock time-series data. | *** ### `Toneden Get Link` Integration name: **TONEDEN\_GET\_LINK** Tool to retrieve a specific ToneDen link by its ID. Use when you need to fetch details about an existing link. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------- | :------: | ------- | ----------------------------------- | | `linkID` | integer | ✅ | `1` | Numeric ID of the link to retrieve. | *** ### `Toneden Get Link Insights` Integration name: **TONEDEN\_GET\_LINK\_INSIGHTS** Tool to retrieve detailed insights for a ToneDen link. Use when you have a link ID and need metrics such as clicks, clickthroughs, email clicks, etc. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------------- | ------- | :------: | ------------------------ | ---------------------------------------------------------------------------------------------------------------- | | `linkID` | string | ✅ | `"3458509"` | Numeric ID of the link to retrieve performance data for. | | `metric` | string | ✅ | `"clicks"` | Which action type to query results for. 'rsvps' is only a valid value for livestream links. | | `end_date` | string | | `"2025-12-31T23:59:59Z"` | If provided, only actions that occurred before the specified date will be counted. Should be in ISO 8601 format. | | `start_date` | string | | `"2025-01-01T00:00:00Z"` | If provided, only actions that occurred after the specified date will be counted. Should be in ISO 8601 format. | | `aggregate_geo` | string | | `"country"` | 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"` | Groups results by specified time interval. | | `aggregate_by_service` | boolean | | — | Groups results by service clicked. | | `aggregate_by_referrer` | boolean | | — | Groups results by referring domain. | *** ### `Toneden Get Link Insights Overview` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ---------- | ----------------------------------------------------------- | | `linkID` | string | ✅ | `"abc123"` | The unique identifier of the link to retrieve insights for. | *** ### `Toneden Get User` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ----------------------------------------------------------------------------------------------------------- | | `user_id` | string | ✅ | `"me"` | ID of the user to retrieve. Use 'me' to get the currently-authenticated user, or provide a numeric user ID. | *** ### `Toneden List Playbook Campaigns` Integration name: **TONEDEN\_LIST\_PLAYBOOK\_CAMPAIGNS** Tool to list playbook campaigns. Use when you need to retrieve a paginated list of all playbook campaigns. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------- | :------: | ------- | ------------------------------------------------------------------------------------ | | `limit` | integer | | `20` | Maximum number of campaigns to return; must be >= 1. | | `offset` | integer | | `0` | Number of campaigns to skip before starting to collect the result set; must be >= 0. | *** ### `Toneden List User Attachments` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------- | :------: | ------------ | ----------------------------------------------------------------------------------- | | `type` | string | ✅ | `"unlock"` | Type of attachments to list: 'unlock' for social unlocks or 'contest' for contests. | | `limit` | integer | | `10` | Maximum number of results to return. | | `offset` | integer | | `0` | Pagination offset for results. | | `userID` | string | ✅ | `"77689382"` | Numeric ID of the user whose attachments to list. | *** ### `Toneden List User Lists` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `userID` | string | ✅ | `"me"` | 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. | *** ### `Toneden Update Attachment` Integration name: **TONEDEN\_UPDATE\_ATTACHMENT** Tool to update an existing attachment. Use when you need to flexibly modify any attachment field (or add custom fields) after its creation. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------------- | ------ | :------: | ----------------------------------------- | --------------------------------------------------------------------------------- | | `type` | string | | `"unlock"` | 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"` | Social action for single-action attachments. Required when type='unlock' | | `link_path` | string | | `"my-custom-link"` | Custom path segment for the attachment's landing page | | `platforms` | array | | `["facebook","twitter-tweet"]` | List of social actions for multi-action attachments. Required when type='contest' | | `unlock_text` | string | | `"DISCOUNT2021"` | Coupon code text when unlock\_type is 'coupon' | | `unlock_type` | string | | `"download"` | Type of unlock for social unlock attachments | | `attachmentID` | string | ✅ | — | ID of the attachment to update | | `download_url` | string | | `"https://example.com/download/file.mp3"` | URL for download or link when unlock\_type is 'download' or 'link' | | `messenger_page_id` | string | | `"1234567890"` | Facebook Page ID for Messenger subscriptions when platform='facebook-messenger' | | `stream_unlock_url` | string | | `"https://youtube.com/watch?v=xyz"` | Streaming URL when unlock\_type is 'stream' | *** ### `Toneden Update Playbook Campaign` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------- | ------ | :------: | ------- | ------------------------------------------------------------------------------------------ | | `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` | — | ✅ | — | ID of the playbook campaign to update. Accepts string or int. | *** ### `Toneden Update User` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------------------- | ------ | :------: | --------------------------------- | --------------------------------------------------------------------------- | | `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 | ✅ | `"me"` | ID of the user to update; use 'me' to target the current authenticated user | | `profile_url` | string | | `"https://example.com/myprofile"` | URL to the user's public profile page | | `display_name` | string | | — | New display name for the user | | `timezone_name` | string | | `"America/Los_Angeles"` | 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 | *** ### `Toneden Validate Link Path` Integration name: **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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------- | ------- | :------: | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `path` | string | ✅ | `"test-link"` | The shortened\_path to check for validity. | | `link_id` | integer | | `123456` | 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 | | `"mysubdomain"` | The subdomain to check for validity. | ***