- Category: url shortener
- Auth: API_KEY, OAUTH2
- Composio-managed OAuth available? No
- Tools: 85
- Triggers: 0
- Slug:
BITLY - Version: 20261101_00
Tools
Add Channel Bitlinks
Add Channel Bitlinks
BITLY_ADD_CHANNEL_BITLINKSAdd 1-100 Bitlinks to an existing Bitly channel under a single campaign, without replacing existing channel membership. If needed, the campaign is associated with the channel first. The request is all-or-nothing: if any Bitlink is invalid, nothing is added. Requires a Bitly plan supporting channels; upgrade if Bitly returns 402.Input Parameters
Output
Add Custom Bitlink
Add Custom Bitlink
BITLY_ADD_CUSTOM_BITLINKAdd a custom back-half to an existing Bitlink on an available short domain, or set its initial custom redirect. Supply custom_bitlink and bitlink_id in domain/back-half form; their domains must match. Requires access to the domain and Bitlink. Custom-link availability and limits depend on the plan.Input Parameters
Output
Add Custom Domain
Add Custom Domain
BITLY_ADD_CUSTOM_DOMAINAdd a domain you already own to a Bitly organization and queue DNS verification, or set prevalidate=true to check it without adding it. This does not purchase a domain. Requires an organization admin, control of the domain’s DNS configuration, and a Bitly plan with custom-domain entitlement and available capacity. Verification is asynchronous and can take up to 24 hours; later read GET /custom_domains for validation_status. An existing domain on this organization is requeued for DNS verification; a domain held by another account cannot be added.Input Parameters
Output
Apply Site Template
Apply Site Template
Bulk Update Bitlinks
Bulk Update Bitlinks
BITLY_BULK_UPDATE_BITLINKSAdd or remove tags, or archive/unarchive up to 100 Bitlinks in a Bitly group. Returns the Bitlink IDs that were updated. Availability depends on the connected account’s permissions and Bitly plan; a plan upgrade may be required.Input Parameters
Output
Bulk Update QR Codes
Bulk Update QR Codes
BITLY_BULK_UPDATE_QR_CODESAdd or remove tags, or archive/unarchive up to 100 Bitly QR codes in a group. Pages QR codes cannot be updated with this action. Returns the IDs of QR codes that were updated. Availability depends on the connected account’s permissions and Bitly plan; a plan upgrade may be required.Input Parameters
Output
Clone Site
Clone Site
Create Bitlink
Create Bitlink
BITLY_CREATE_BITLINKCreate a Bitly short link with a title, tags, deep links, expiration, and dynamic routing, or add a keyword override to an existing bitlink_id. Provide exactly one of long_url or bitlink_id. Custom keywords and advanced features depend on your Bitly plan, domain permissions, and monthly limits.Input Parameters
Output
Create Campaign
Create Campaign
Create Channel
Create Channel
Create Group Export
Create Group Export
BITLY_CREATE_GROUP_EXPORTBuild a synchronous CSV export of group link engagements, links, or QR codes. Returns JSON metadata with a base64 CSV data URI. Metrics exports are capped at 200 rows; metadata-only lists at 1000. Check truncated for omitted rows. Availability and metrics history depend on the connected Bitly plan; upgrade if required.Input Parameters
Output
Create QR Code
Create QR Code
BITLY_CREATE_QR_CODECreate a QR code in a Bitly group for an existing Bitlink, Link-in-Bio site, or a stand-alone long URL. Optionally customize appearance, GS1 metadata, expiration, tags, and long-URL dynamic routing. Returns QR metadata and ID, not an image. Creation consumes the group’s QR quota; customizations and advanced features may require a Bitly plan upgrade.Input Parameters
Output
Create Site
Create Site
BITLY_CREATE_SITECreate an empty Bitly Site in a group with default appearance settings. Choose a domain and keyword for its URL. Availability and site limits depend on the connected account’s Bitly plan.Input Parameters
Output
Create Site Block
Create Site Block
BITLY_CREATE_SITE_BLOCKCreate a Bitlink, social, YouTube video, image, digital business card, or text block on a Bitly Site. Supply content matching the selected type; use parent to place it in an existing container. Grid and carousel must be created via the container endpoint instead. Availability and limits depend on the connected account’s Bitly plan.Input Parameters
Output
Create Site Container
Create Site Container
Create Site Image
Create Site Image
BITLY_CREATE_SITE_IMAGEAttach a previously uploaded image to a Bitly Site and return its URL and GUID. This endpoint accepts image references, not base64 image data. Availability depends on the connected account’s Bitly plan and site entitlements.Input Parameters
Output
Create Static QR Code
Create Static QR Code
BITLY_CREATE_STATIC_QR_CODEGenerate a static QR image for raw content without creating or saving a Bitly QR resource. Returns base64 image bytes, not a hosted URL or data URI. Choose SVG or PNG and basic appearance options; gradients, frame, text, and logo are unsupported. Contact your Bitly Account Manager to enable this feature.Input Parameters
Output
Create Webhook
Create Webhook
BITLY_CREATE_WEBHOOKCreate a Bitly webhook for an organization, optionally associated with a group. The destination URL may receive Bitly event data; configure only a trusted endpoint. Webhook availability depends on the connected account’s plan; accounts without webhook entitlement must upgrade. Receiver OAuth client secrets cannot be set with this tool.Input Parameters
Output
Delete Bitlink
Delete Bitlink
Delete QR Code
Delete QR Code
BITLY_DELETE_QR_CODEPermanently delete a QR code that has not been redirected and is not for a custom link. Also deletes the associated link, if applicable. Returns the deletion records reported by Bitly. Access depends on the connected account’s permissions and plan entitlement.Input Parameters
Output
Delete Site
Delete Site
Delete Site Block
Delete Site Block
BITLY_DELETE_SITE_BLOCKDelete a block of any type from a Bitly Site, rather than deactivate it. Deleting a container block (grid or carousel) also deletes its contained blocks. Does not delete the link tied to the block. Returns no content on success. Access depends on the connected account’s permissions and Bitly plan entitlement.Input Parameters
Output
Delete Site Redirect
Delete Site Redirect
Delete Webhook
Delete Webhook
Discard Site Draft
Discard Site Draft
Expand Link
Expand Link
Get Account Context
Get Account Context
Get Aggregate Site Analytics
Get Aggregate Site Analytics
BITLY_GET_AGGREGATE_SITE_ANALYTICSRetrieve aggregate analytics for Bitly Sites: overview, views over time or by city/country/device/referrer, button clicks over time or by city/country/device, top clicked buttons, or digital business card downloads over time. Choose one report per call. Availability depends on the report and plan; detailed traffic breakdowns require a paid analytics entitlement.Input Parameters
Output
Get Bitlink
Get Bitlink
Get Bitlink Activity
Get Bitlink Activity
Get Bitlink Referrer Analytics
Get Bitlink Referrer Analytics
BITLY_GET_BITLINK_REFERRER_ANALYTICSGet Bitlink click analytics by AI agent, referrer name, or referrers grouped by domain. Choose exactly one metric per call. Requires access to the Bitlink and the selected analytics entitlement; some metrics require a paid plan.Input Parameters
Output
Get Bitlink Traffic Sources
Get Bitlink Traffic Sources
Get Campaign
Get Campaign
BITLY_GET_CAMPAIGNRetrieve a Bitly campaign by GUID to inspect its name, description, owning group, creator, timestamps, and resource references. The campaign must be accessible to the authenticated user. Requires a Bitly plan that supports campaigns; upgrade your plan if Bitly returns 402.Input Parameters
Output
Get Channel
Get Channel
BITLY_GET_CHANNELRetrieve a Bitly channel by GUID to inspect its name, owning group, creation and modification timestamps, and resource references. The channel must be accessible to the authenticated user. Requires a Bitly plan that supports channels; upgrade your plan if Bitly returns 402.Input Parameters
Output
Get Custom Bitlink
Get Custom Bitlink
Get Custom Bitlink Analytics
Get Custom Bitlink Analytics
BITLY_GET_CUSTOM_BITLINK_ANALYTICSRetrieve time-bucketed clicks across a Custom Bitlink’s entire history or click counts grouped by its historical destinations. Select clicks or clicks_by_destination and an analytics window. Requires access to the Custom Bitlink and a Bitly plan with the appropriate analytics entitlement.Input Parameters
Output
Get Custom Domain
Get Custom Domain
BITLY_GET_CUSTOM_DOMAINRetrieve a Bitly custom domain’s verification state, group assignments, redirects, deep-link applications, and SSL configuration. Requires membership in a group assigned to the domain or administrator access to its organization. Only organization administrators can read domains awaiting DNS verification. Account entitlements apply; upgrade your plan if Bitly returns 402.Input Parameters
Output
Get Custom Domain DNS
Get Custom Domain DNS
BITLY_GET_CUSTOM_DOMAIN_DNSInspect a Bitly custom domain’s current DNS records, detected DNS provider, required registrar records, and whether the records match a valid configuration. Use the required A records for a root domain or CNAME record for a subdomain to configure DNS at your registrar. Does not modify DNS. Requires access to the specified organization and domain; account entitlements apply. Upgrade your plan if Bitly returns 402.Input Parameters
Output
Get Domain Agreements
Get Domain Agreements
BITLY_GET_DOMAIN_AGREEMENTSRetrieve the registrar agreements a user must accept before Bitly registers a domain. Review their content and pass each accepted agreement_key to POST /domains when purchasing the domain. This read does not accept agreements or purchase a domain. Account entitlements apply; upgrade your plan if Bitly returns 402.Input Parameters
Output
Get Group
Get Group
Get Group Analytics
Get Group Analytics
BITLY_GET_GROUP_ANALYTICSRetrieve one group analytics report: shorten counts, geography/devices/referrers, engagement rankings or timeline, link clicks, QR scans, historical usage, or agentic traffic rollup. Select metric and supply only that endpoint’s parameters. Most metrics require unit and units. Analytics availability depends on Bitly plan entitlements; paid features return 402 without an upgrade. Returns provider fields without combining distinct rankings or response shapes.Input Parameters
Output
Get Group Preferences
Get Group Preferences
Get OAuth App
Get OAuth App
BITLY_GET_OAUTH_APPRetrieve a Bitly OAuth app by client ID to inspect its name, description, link, PKCE requirement, and first-party status. The authenticated account must have access to the app. Availability is subject to Bitly account permissions and entitlements; upgrade your plan if Bitly returns 402.Input Parameters
Output
Get Organization
Get Organization
BITLY_GET_ORGANIZATIONRetrieve a Bitly organization by GUID, including its subscription tier, your role, branded short domains, authentication requirements, timestamps, and resource references. The organization must be accessible to the authenticated user; account entitlements apply.Input Parameters
Output
Get Organization Shorten Counts
Get Organization Shorten Counts
BITLY_GET_ORGANIZATION_SHORTEN_COUNTSRead an organization’s shorten counts over a specified time window, supplying unit and units. Set by_group=true to read counts by group for the current month instead, without time parameters. Returns the provider’s metrics envelope. Availability depends on Bitly plan entitlements; a 402 requires a plan upgrade.Input Parameters
Output
Get QR Code
Get QR Code
BITLY_GET_QR_CODERetrieve a Bitly QR code by ID to inspect its destination, appearance, GS1 metadata, tags, expiration, and dynamic routing. Returns QR metadata, not an image. The connected account must have access to the QR code; feature availability depends on the Bitly plan.Input Parameters
Output
Get QR Code Analytics
Get QR Code Analytics
BITLY_GET_QR_CODE_ANALYTICSGet a QR Code’s scan timeline, total, or country, city, device OS or browser breakdown for a time window. Analytics availability depends on your Bitly plan; detailed reports may require an upgrade.Input Parameters
Output
Get QR Code Image
Get QR Code Image
BITLY_GET_QR_CODE_IMAGERetrieve an existing Bitly QR code’s image as a base64 data URI in qr_code_image, suitable for an HTML image src. Choose SVG or PNG; SVG is the default. This does not create a QR code and does not return a hosted image URL. Access and image features depend on the connected account’s Bitly plan and QR code permissions.Input Parameters
Output
Get Site
Get Site
Get Site Analytics
Get Site Analytics
BITLY_GET_SITE_ANALYTICSRetrieve one Bitly Site analytics report: country, city, device, or referrer views, link performance, a views timeline, or a views summary. Requires the connected account’s site analytics entitlement; some reports require a paid plan. Link performance returns one page with provider pagination, not all pages.Input Parameters
Output
Get Top Group Engagements
Get Top Group Engagements
BITLY_GET_TOP_GROUP_ENGAGEMENTSRetrieve a group’s top Bitlinks and decoupled QR codes ranked together by engagement count over a time window. Returns separate links and qr_codes lists plus sorted_engagements whose IDs preserve the unified ranking. Coupled QR codes are ranked by their Bitlink ID. Returns one bounded result set, not all history pages. Analytics access depends on Bitly plan entitlements.Input Parameters
Output
Get Usage and Limits
Get Usage and Limits
Get Webhook
Get Webhook
BITLY_GET_WEBHOOKRetrieve a Bitly webhook by GUID to inspect its delivery configuration, subscribed event, status, owning organization and group, and lifecycle timestamps. Requires access to the webhook and a Bitly plan supporting webhooks; upgrade your plan if Bitly returns 402.Input Parameters
Output
List Bitlinks
List Bitlinks
BITLY_LIST_BITLINKSList or search Bitlinks owned by a group, one cursor-controlled page at a time.Input Parameters
Output
List Branded Short Domains
List Branded Short Domains
BITLY_LIST_BRANDED_SHORT_DOMAINSList verified custom domains the authenticated user can shorten links with, across all their organizations and groups. Any group member can call this endpoint; no organization-admin role is required. Returns domain names only, not setup or verification state; use List Custom Domains for those details. There are no pagination controls. Availability is subject to account entitlements; upgrade the connected plan if Bitly returns 402.Output
List Campaigns
List Campaigns
BITLY_LIST_CAMPAIGNSList campaigns for the authenticated Bitly user, optionally filtered by group GUID. This endpoint has no documented pagination controls. Requires a Bitly plan with campaign access; upgrade the connected account if Bitly returns 402.Input Parameters
Output
List Channels
List Channels
BITLY_LIST_CHANNELSList channels available to the authenticated Bitly user, optionally filtered by group GUID and campaign GUID. Use the returned channel GUIDs when working with campaigns. This endpoint has no documented pagination controls. Requires a Bitly plan with channel access; upgrade the connected account if Bitly returns 402.Input Parameters
Output
List Custom Domains
List Custom Domains
BITLY_LIST_CUSTOM_DOMAINSList custom domains with verification states, group assignments, HTTPS settings, deep-link applications, and SSL certificate details. Optionally filter by organization GUID; otherwise returns domains for every organization where the authenticated caller is an admin. Organizations where the caller is not an admin are excluded. No pagination controls are documented. Account entitlements apply; upgrade the connected Bitly plan if Bitly returns 402.Input Parameters
Output
List QR Codes
List QR Codes
BITLY_LIST_QR_CODESList one page of QR codes in a Bitly group in reverse chronological order, optionally filtering by search text, destination, creation time, creator, tags, QR type, customization, GS1, archive, expiration, or dynamic routing status. Pass pagination.search_after back as search_after with the same filters to continue. Returns metadata, not images. The connected account must have access to the group; feature availability depends on the Bitly plan.Input Parameters
Output
List Sites
List Sites
BITLY_LIST_SITESList one page of active Bitly Sites owned by a group, optionally filtered by site URL. Pass pagination.search_after as search_after to request the next page. Availability depends on the connected account’s Bitly plan.Input Parameters
Output
List Site Templates
List Site Templates
BITLY_LIST_SITE_TEMPLATESList available Bitly Site templates, optionally by onboarding category. Use a returned template_guid to apply a template to a site. Availability and use of paid templates depend on the connected account’s Bitly plan.Input Parameters
Output
List Sorted Bitlinks
List Sorted Bitlinks
BITLY_LIST_SORTED_BITLINKSRetrieve a group’s Bitlinks ranked by clicks for a time window. Preserve the sorted_links order and join its IDs to links metadata by id, not array position. Returns one size-limited result with no documented continuation token. Requires access to the group and the appropriate Bitly analytics entitlement; upgrade the connected plan if Bitly returns 402.Input Parameters
Output
List Webhooks
List Webhooks
Prevalidate Site YouTube Video
Prevalidate Site YouTube Video
Publish Site
Publish Site
Redirect QR Code
Redirect QR Code
BITLY_REDIRECT_QR_CODEChange the destination URL of a stand-alone Bitly QR code by QR code ID. QR codes already associated with a Bitlink must be updated via the Bitlinks API instead. Returns updated QR metadata, not an image. Redirecting a QR code may require a Bitly plan upgrade.Input Parameters
Output
Register Domain
Register Domain
BITLY_REGISTER_DOMAINRegister (purchase) a domain for a Bitly organization and configure its DNS. This creates a domain registration and consumes the organization’s plan-included domain allowance; it is not a lookup or dry run. It is not a paid-domain checkout: Bitly rejects domains priced at or above the complimentary limit and requests after the included allowance is exhausted. Requires an organization admin and a plan with available included-domain entitlement. Obtain explicit user approval for registration and the agreements before calling. Select a domain from GET /domains and send agreement_keys from GET /domains/{domain}/agreements. DNS verification can take up to 48 hours; later read GET /custom_domains for validation_status.Input Parameters
Output
Search Domains
Search Domains
BITLY_SEARCH_DOMAINSSearch domains Bitly can register for an organization. Returns available domain names and the status of the exact name searched for; this does not register or purchase a domain. Returns one set of up to 25 results with no documented pagination. Domain registration depends on organization plan entitlements; upgrade the connected Bitly plan if Bitly returns 402.Input Parameters
Output
Shorten Link
Shorten Link
Update Bitlink
Update Bitlink
Update Campaign
Update Campaign
BITLY_UPDATE_CAMPAIGNUpdate a Bitly campaign’s name, description, associated group, or channels. Supply campaign_guid and the fields to change; omitted fields are not sent. Returns the updated campaign details. Requires campaign access and a Bitly plan that includes campaigns; upgrade the plan if Bitly returns 402.Input Parameters
Output
Update Channel
Update Channel
BITLY_UPDATE_CHANNELUpdate a Bitly channel’s name, group, or Bitlink campaign associations and return its updated details; supplying Bitlinks replaces the channel’s entire Bitlink membership. Requires channel access and a Bitly plan supporting channels; upgrade if Bitly returns 402.Input Parameters
Output
Update Custom Bitlink
Update Custom Bitlink
BITLY_UPDATE_CUSTOM_BITLINKMove an existing custom keyword (back-half) to a different Bitlink. Supply custom_bitlink and the destination bitlink_id in domain/back-half form; their domains must match. Requires access to the Custom Domain and a Bitly plan with custom-link redirect entitlement. Returns the updated custom redirect, destination Bitlink, and redirect history.Input Parameters
Output
Update Custom Domain
Update Custom Domain
BITLY_UPDATE_CUSTOM_DOMAINChange a verified Bitly custom domain’s redirects and HTTPS/HSTS settings. Supply custom_domain and only the settings to change; an empty root_redirect or wildcard_redirect clears that redirect. Domains awaiting DNS verification cannot be updated. Requires an organization administrator and a Bitly plan with the appropriate custom-domain entitlement. Returns the updated domain.Input Parameters
Output
Update Group
Update Group
BITLY_UPDATE_GROUPUpdate a Bitly group’s name, associated organization, or branded short domains. Supply group_guid and the fields to change; omitted fields are not sent. Returns the updated group details. Requires permission to manage the group; availability depends on the connected account’s Bitly plan.Input Parameters
Output
Update Group Preferences
Update Group Preferences
Update QR Code
Update QR Code
BITLY_UPDATE_QR_CODEUpdate an existing Bitly QR code’s title, appearance, archive status, expiration, tags, or dynamic routing rules by QR code ID. Returns QR metadata, not an image. Dynamic routing replaces all existing rules; an empty array clears them. Customizations and advanced features may require a Bitly plan upgrade.Input Parameters
Output
Update Site
Update Site
BITLY_UPDATE_SITEUpdate a Bitly Site’s URI, display name, description, or attached QR code. Changing the URI creates a redirect from the previous URI. A QR code can only be attached when the site does not already have one. Availability depends on the connected account’s Bitly plan.Input Parameters
Output
Update Site Appearance
Update Site Appearance
Update Site Block
Update Site Block
BITLY_UPDATE_SITE_BLOCKUpdate an existing Bitly Site block’s content, appearance, schedule, active or pinned state, or parent container. Send content fields appropriate to the stored block type; the type is derived from the existing block and cannot be changed. Availability depends on the connected account’s Bitly plan.Input Parameters
Output
Update User
Update User
Update Webhook
Update Webhook
BITLY_UPDATE_WEBHOOKUpdate an existing Bitly webhook’s delivery destination, event, activity, organization, group, or OAuth settings. Supply webhook_guid for the path and guid for the required body identifier, plus the fields to change; omitted fields are not sent. Returns updated webhook details. Requires webhook access and a Bitly plan supporting webhooks; upgrade if Bitly returns 402. Receiver OAuth client secrets cannot be changed with this tool.Input Parameters
Output
Upgrade QR Code to Bitlink
Upgrade QR Code to Bitlink
BITLY_UPGRADE_QR_CODE_TO_BITLINKUpgrade a standalone (decoupled) QR code to a coupled QR code by associating it with its underlying Bitly short link. Returns Bitlink metadata, not a QR image. This consumes one encode from the organization’s monthly Link limit; if the QR code is already coupled, no encode is consumed. Availability depends on your Bitly plan and remaining monthly Link quota.Input Parameters
Output
Verify Webhook
Verify Webhook
BITLY_VERIFY_WEBHOOKTest an existing Bitly webhook’s configuration by sending a ping event to its configured webhook URL. This sends an outbound request to the webhook receiver; it is not a read-only configuration check. Returns the webhook configuration and status. Requires access to the webhook and a Bitly plan supporting webhooks; upgrade your plan if Bitly returns 402.