Skip to main content
Toneden logo
  • Category: social media marketing
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 26
  • Triggers: 0
  • Slug: TONEDEN
  • Version: 20261101_00

Tools

Slug: TONEDEN_CREATE_ADVERTISING_CAMPAIGNTool 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

string
Campaign name/title for identification.
string
Initial campaign status (e.g., draft, active, paused).
string
URL or object ID to promote.
string
Currency code for the budget (e.g., USD, EUR).
string ("facebook" | "google")
required
The advertising platform to use (facebook or google).
array
required
Array of audience objects for targeting. Structure varies by platform.
object
required
Creative assets for the campaign. Structure varies by platform.
string
Marketing objective for the campaign.
object
Additional targeting parameters for the campaign.
string ("daily" | "lifetime")
required
Budget allocation strategy (daily or lifetime).
string
Campaign objective type (e.g., conversions, reach, engagement).
number
required
Numeric budget value in the specified currency.
integer
UNIX timestamp for when the campaign should end.
boolean
If true, the campaign runs indefinitely (no end date).
array
Email addresses to receive campaign reports.
string
Optimization goal identifier for the campaign.
integer
UNIX timestamp for when the campaign should start.
URL to direct users to when they click the ad.
string
ID of the external poster/page for the campaign.
string
Instagram account ID for Instagram placements (Facebook platform).
string
required
ID of the external ad account on the platform.
boolean
If true, disables all email notifications for this campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_CREATE_ATTACHMENTCreate a social unlock or contest attachment. The response includes the HTTP status and may contain an error instead of a created attachment.

Input Parameters

string ("unlock" | "contest")
required
Attachment type: ‘unlock’ for social unlock or ‘contest’ for a contest attachment.
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.
array
List of social actions for multi-action attachments. Required when type=‘contest’ or multiple unlock actions.
string
Coupon code text to display. Required when unlock_type=‘coupon’.
string ("download" | "coupon" | "link" | "stream")
Reward type for social unlocks. Required when type=‘unlock’.
string
URL of the file to download or link target. Required when unlock_type=‘download’ or ‘link’.
string
Facebook Page ID to subscribe on Messenger. Required when platform=‘facebook-messenger’.
string
URL of the unlisted video to stream. Required when unlock_type=‘stream’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_DELETE_ADVERTISING_CAMPAIGNDelete a ToneDen advertising campaign by ID. The response includes the HTTP status and may contain an error rather than confirming deletion.

Input Parameters

string
required
ID of the advertising campaign to delete. Accepts string or int.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_DELETE_PLAYBOOK_CAMPAIGNDeletes a ToneDen playbook campaign by ID using DELETE /playbooks/campaigns/{campaignID}.

Input Parameters

string
required
ID of the playbook campaign to delete. Accepts string or int.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_GET_ADVERTISING_CAMPAIGNRetrieve 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

string
required
The ID of the advertising campaign to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_GET_ADVERTISING_CAMPAIGN_CREATIVE_INSIGHTSRetrieve 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

string
required
The ID of the advertising campaign to retrieve creative insights for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_GET_ADVERTISING_CAMPAIGN_INSIGHTSRetrieve performance insights for a specific advertising campaign using ToneDen’s API. Endpoint: GET /advertising/campaigns/{campaignID}/insights.

Input Parameters

string
required
The ID of the advertising campaign to retrieve insights for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_GET_ATTACHMENTTool to retrieve an attachment by ID. Use when you need to fetch details of an existing attachment by its ID.

Input Parameters

string
required
The unique identifier of the attachment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_GET_ATTACHMENT_ENTRIES_TIME_SERIESTool to fetch time-series entry statistics for a specific attachment. Use when you need chronological entry data points for an attachment.

Input Parameters

string
required
The unique identifier of the attachment for which to retrieve entry time-series data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_GET_ATTACHMENT_ENTRIES_TOTALSTool to fetch summary counts of entries for an attachment. Use when you need aggregate entry counts over day, week, month, and lifetime.

Input Parameters

string
required
The unique identifier of the attachment for which to retrieve entry totals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_GET_ATTACHMENT_UNLOCKS_BY_PLATFORMTool 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

string
required
The unique identifier of the attachment for which to retrieve unlock counts by platform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_GET_ATTACHMENT_UNLOCKS_TIME_SERIESTool to fetch time-series unlock statistics for a specific attachment. Use when you need chronological unlock data points for an attachment.

Input Parameters

string
required
The unique identifier of the attachment for which to retrieve unlock time-series data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_GET_USERTool 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

string
required
ID of the user to retrieve. Use ‘me’ to get the currently-authenticated user, or provide a numeric user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_LIST_PLAYBOOK_CAMPAIGNSTool to list playbook campaigns. Use when you need to retrieve a paginated list of all playbook campaigns.

Input Parameters

integer
Maximum number of campaigns to return; must be >= 1.
integer
Number of campaigns to skip before starting to collect the result set; must be >= 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_LIST_USER_ATTACHMENTSTool to list attachments for a user. Use when you need to retrieve social unlocks or contest attachments belonging to a specific user.

Input Parameters

string ("unlock" | "contest")
required
Type of attachments to list: ‘unlock’ for social unlocks or ‘contest’ for contests.
integer
Maximum number of results to return.
integer
Pagination offset for results.
string
required
Numeric ID of the user whose attachments to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_LIST_USER_LISTSTool 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_UPDATE_ATTACHMENTUpdate 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

string ("unlock" | "contest")
Attachment type: ‘unlock’ for social unlock or ‘contest’ for multi-action contest
object
Additional arbitrary fields to merge into the update payload
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’
Custom path segment for the attachment’s landing page
array
List of social actions for multi-action attachments. Required when type=‘contest’
string
Coupon code text when unlock_type is ‘coupon’
string ("download" | "coupon" | "link" | "stream")
Type of unlock for social unlock attachments
string
required
ID of the attachment to update
string
URL for download or link when unlock_type is ‘download’ or ‘link’
string
Facebook Page ID for Messenger subscriptions when platform=‘facebook-messenger’
string
Streaming URL when unlock_type is ‘stream’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_UPDATE_PLAYBOOK_CAMPAIGNUpdates 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

string
Name of the playbook campaign
string
Optional notes or description for the campaign
number
Optional budget value for the campaign
string
Status of the campaign (if supported by API)
object
Additional arbitrary fields for the update payload when not covered by explicit parameters
string
ISO8601 end date string (if supported by API)
object
Arbitrary metadata dictionary to include in the update
string
ISO8601 start date string (if supported by API)
string
required
ID of the playbook campaign to update. Accepts string or int.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TONEDEN_UPDATE_USERTool 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

string
City where the user is located
string
Bio or about text for the user
string
State or province of the user
string
Custom policy text for the user
string
Country code (e.g., ‘US’)
string
required
ID of the user to update; use ‘me’ to target the current authenticated user
string
URL to the user’s public profile page
string
New display name for the user
string
IANA timezone string (e.g., ‘America/Los_Angeles’)
array
List of additional email addresses for the user
object
User interface preference settings
object
User advertising preference settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not