# Toneden

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

- **Category:** social media marketing
- **Auth:** API_KEY, OAUTH2
- **Composio Managed App Available?** Yes
- **Tools:** 26
- **Triggers:** 0
- **Slug:** `TONEDEN`
- **Version:** 20260227_00

## Tools

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

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

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

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("unlock" | "contest") | Yes | 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") | No | Social action for single-action attachments. Required when type='unlock' and only one social action. |
| `platforms` | array | No | List of social actions for multi-action attachments. Required when type='contest' or multiple unlock actions. |
| `unlock_text` | string | No | Coupon code text to display. Required when unlock_type='coupon'. |
| `unlock_type` | string ("download" | "coupon" | "link" | "stream") | No | Reward type for social unlocks. Required when type='unlock'. |
| `download_url` | string | No | URL of the file to download or link target. Required when unlock_type='download' or 'link'. |
| `messenger_page_id` | string | No | Facebook Page ID to subscribe on Messenger. Required when platform='facebook-messenger'. |
| `stream_unlock_url` | string | No | URL of the unlisted video to stream. Required when unlock_type='stream'. |

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

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `services` | array | No | 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") | Yes | Determines the link landing page type. |

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

**Slug:** `TONEDEN_DELETE_ADVERTISING_CAMPAIGN`

Deletes a ToneDen advertising campaign by ID using DELETE /advertising/campaigns/{campaignID}.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaignID` | string | Yes | ID of the advertising campaign to delete. Accepts string or int. |

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

**Slug:** `TONEDEN_DELETE_LINK`

Deletes a ToneDen link by ID using DELETE /links/{linkID}.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_id` | string | Yes | ID of the link to delete. Accepts string or int. |

#### 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 ToneDen Playbook Campaign

**Slug:** `TONEDEN_DELETE_PLAYBOOK_CAMPAIGN`

Deletes a ToneDen playbook campaign by ID using DELETE /playbooks/campaigns/{campaignID}.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | ID of the playbook campaign to delete. Accepts string or int. |

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

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Optional source URL for music or podcast; when provided, the API generates a services array linking to that track across platforms. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaignID` | string | Yes | The ID of the advertising campaign to retrieve. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaignID` | string | Yes | The ID of the advertising campaign to retrieve creative insights for. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaignID` | string | Yes | The ID of the advertising campaign to retrieve insights for. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachmentID` | string | Yes | The unique identifier of the attachment to retrieve. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachmentID` | string | Yes | The unique identifier of the attachment for which to retrieve entry time-series data. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachmentID` | string | Yes | The unique identifier of the attachment for which to retrieve entry totals. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachmentID` | string | Yes | The unique identifier of the attachment for which to retrieve unlock counts by platform. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachmentID` | string | Yes | The unique identifier of the attachment for which to retrieve unlock time-series data. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `linkID` | integer | Yes | Numeric ID of the link to retrieve. |

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

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `linkID` | string | Yes | Numeric ID of the link to retrieve performance data for. |
| `metric` | string ("clicks" | "clickthroughs" | "rsvps") | Yes | Which action type to query results for. 'rsvps' is only a valid value for livestream links. |
| `end_date` | string | No | If provided, only actions that occurred before the specified date will be counted. Should be in ISO 8601 format. |
| `start_date` | string | No | 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") | No | Groups results by visitor location. |
| `for_distinct_fans` | boolean | No | If true, only one action per fan will be counted in the stats. |
| `aggregate_interval` | string ("day" | "hour" | "week") | No | Groups results by specified time interval. |
| `aggregate_by_service` | boolean | No | Groups results by service clicked. |
| `aggregate_by_referrer` | boolean | No | Groups results by referring domain. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `linkID` | string | Yes | The unique identifier of the link to retrieve insights for. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ID of the user to retrieve. Use 'me' to get the currently-authenticated user, or provide a numeric user ID. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of campaigns to return; must be >= 1. |
| `offset` | integer | No | Number of campaigns to skip before starting to collect the result set; must be >= 0. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("unlock" | "contest") | Yes | Type of attachments to list: 'unlock' for social unlocks or 'contest' for contests. |
| `limit` | integer | No | Maximum number of results to return. |
| `offset` | integer | No | Pagination offset for results. |
| `userID` | string | Yes | Numeric ID of the user whose attachments to 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 |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `userID` | string | Yes | 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

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

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("unlock" | "contest") | No | Attachment type: 'unlock' for social unlock or 'contest' for multi-action contest |
| `update` | object | No | 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") | No | Social action for single-action attachments. Required when type='unlock' |
| `link_path` | string | No | Custom path segment for the attachment's landing page |
| `platforms` | array | No | List of social actions for multi-action attachments. Required when type='contest' |
| `unlock_text` | string | No | Coupon code text when unlock_type is 'coupon' |
| `unlock_type` | string ("download" | "coupon" | "link" | "stream") | No | Type of unlock for social unlock attachments |
| `attachmentID` | string | Yes | ID of the attachment to update |
| `download_url` | string | No | URL for download or link when unlock_type is 'download' or 'link' |
| `messenger_page_id` | string | No | Facebook Page ID for Messenger subscriptions when platform='facebook-messenger' |
| `stream_unlock_url` | string | No | Streaming URL when unlock_type is 'stream' |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the playbook campaign |
| `notes` | string | No | Optional notes or description for the campaign |
| `budget` | number | No | Optional budget value for the campaign |
| `status` | string | No | Status of the campaign (if supported by API) |
| `update` | object | No | Additional arbitrary fields for the update payload when not covered by explicit parameters |
| `end_date` | string | No | ISO8601 end date string (if supported by API) |
| `metadata` | object | No | Arbitrary metadata dictionary to include in the update |
| `start_date` | string | No | ISO8601 start date string (if supported by API) |
| `campaign_id` | string | Yes | ID of the playbook campaign to update. Accepts string or int. |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City where the user is located |
| `about` | string | No | Bio or about text for the user |
| `state` | string | No | State or province of the user |
| `policy` | string | No | Custom policy text for the user |
| `country` | string | No | Country code (e.g., 'US') |
| `user_id` | string | Yes | ID of the user to update; use 'me' to target the current authenticated user |
| `profile_url` | string | No | URL to the user's public profile page |
| `display_name` | string | No | New display name for the user |
| `timezone_name` | string | No | IANA timezone string (e.g., 'America/Los_Angeles') |
| `additional_emails` | array | No | List of additional email addresses for the user |
| `interface_settings` | object | No | User interface preference settings |
| `advertising_settings` | object | No | User advertising preference settings |

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

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `path` | string | Yes | The shortened_path to check for validity. |
| `link_id` | integer | No | 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 | No | The subdomain to check for validity. |

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