Skip to main content
Bitly logo
  • Category: url shortener
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 85
  • Triggers: 0
  • Slug: BITLY
  • Version: 20261101_00

Tools

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

array
GUIDs of groups to associate with the custom domain.
boolean
Check whether the domain can be used without adding it or creating a custom domain.
string
required
Custom domain you already own and can configure DNS for. This does not purchase a domain.
string
required
GUID of the organization to add the domain to; the caller must be its admin.

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: BITLY_APPLY_SITE_TEMPLATEApply a template’s appearance and, where applicable, sample content to an existing Bitly Site. Returns the updated site’s settings. Availability depends on the connected account’s Bitly plan.

Input Parameters

string
required
GUID of the Bitly Site to apply the template to.
string
GUID of the template whose appearance should be applied to the site.

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

string ("archive" | "edit_tags")
required
Bulk operation: archive/unarchive QR codes or edit their tags.
boolean
Archive (true) or unarchive (false) QR codes for the archive action.
array
Tags to add for the edit_tags action.
string
required
GUID of the Bitly group whose QR codes to update.
array
Up to 100 QR code IDs to update. Pages QR codes are not supported.
array
Tags to remove for the edit_tags action.

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: BITLY_CLONE_SITECreate a new Bitly Site by cloning the content and appearance of an existing site. Optionally specify the new site’s URI. Availability and site limits depend on the connected account’s Bitly plan.

Input Parameters

string
URI for the cloned site in domain/m/keyword form.
string
required
GUID of the existing Bitly Site to clone.

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: BITLY_CREATE_CAMPAIGNCreate a Bitly campaign in a group, optionally associating channel GUIDs. Campaign availability depends on the connected account’s Bitly plan; accounts without campaign entitlement must upgrade.

Input Parameters

string
Name of the new campaign.
string
GUID of the Bitly group that will own the campaign.
string
Description of the new campaign.
array
GUIDs of the channels to associate with the 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: BITLY_CREATE_CHANNELCreate a Bitly channel in a group, optionally associating campaign bitlinks. Channel availability depends on the connected account’s Bitly plan; accounts without the required entitlement must upgrade.

Input Parameters

string
GUID of the channel.
string
Name of the new channel.
string
Channel creation time as an ISO timestamp.
Campaign and bitlink associations for the channel.
string
Channel last modification time as an ISO timestamp.
string
GUID of the Bitly group that will own the channel.

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

object
Search constraints; required for links_list and qr_codes_list. For link_engagements_batch, provide either filter or bitlinks.
integer
Metrics window end in Unix seconds (UTC); see unix_from.
Fully qualified bitlinks (for example bit.ly/abc) for link_engagements_batch; mutually exclusive with filter.
integer
Metrics window start in Unix seconds (UTC), clamped to the plan’s data window. For link_engagements_batch, supply with unix_to unless the tier max-history default applies. Used on list exports when include_metrics is true.
string
required
GUID of the Bitly group to export.
string ("link_engagements_batch" | "links_list" | "qr_codes_list")
required
CSV shape to produce.
boolean
On list exports, append clicks, scans, and button_clicks and apply the 200-row cap. Requires unix_from and unix_to unless tier-default window behavior applies.

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

object
GS1 application identifiers and values to encode.
array
Tags to add to the QR code.
string
Title of the new QR code.
string
Short domain for the QR redirect; Bitly defaults to bit.ly.
boolean
Whether to create the QR code archived, hiding it from the UI.
string
required
GUID of the group that will own the QR code; obtain it from Get Account Context.
object
required
Target destination: an existing Bitlink, Link-in-Bio site, or a stand-alone long URL.
string
Expiration timestamp for the QR code’s Bitlink, such as 2025-01-28T14:30:00+0000; must be 5 minutes to 1 year from now.
array
Dynamic routing rules, supported only for long_url destinations. Replaces all rules; an empty array clears them.
object
QR appearance customizations; availability depends on the Bitly plan.

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

string
Site URI in domain/m/keyword form. Optional in Bitly’s documentation, but supply it to avoid INVALID_URI on accounts that require it.
string
required
Domain for the site, such as bit.ly or an owned branded domain.
string
required
Custom back-half for the new site’s URL.
string
required
GUID of the Bitly group that will own the new site.

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

string ("bitlink" | "social" | "youtubeVideo" | "image" | "digital_business_card" | "text_block")
required
Block type to create; grid and carousel require the container endpoint.
string
Parent container block ID.
string
required
Content matching the selected block type.
string
required
GUID of the Bitly Site receiving the block.
boolean
Whether the block is active.
boolean
Whether the block is pinned.
object
Text block appearance settings.
string
Block schedule end timestamp.
string
Block schedule start timestamp.

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: BITLY_CREATE_SITE_CONTAINERCreate a carousel or grid container for a set of content on a Bitly Site. Returns the created site block. Availability depends on the connected account’s Bitly plan and site entitlements.

Input Parameters

string ("carousel" | "grid")
Container layout: carousel or grid.
string
required
GUID of the Bitly Site in which to create a container.

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

string
required
URL of the uploaded image; required together with image_guid.
string
JSON-encoded crop coordinates, supplied as a string, not an object.
string
required
GUID of the Bitly Site to attach the image to.
string ("profile" | "background" | "banner" | "profile_life" | "background_live" | "banner_live")
Intended image use on the site.
string
required
GUID of the previously uploaded image; required together with url.

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

string ("application/json" | "image/svg+xml" | "image/png")
Provider response format. Raw SVG/PNG responses are returned by this tool as base64 in image, just like JSON responses.
string ("svg" | "png")
Image format; defaults to svg. Ignored when Accept specifies an image type.
string
required
Raw content to encode, such as a URL.
string
required
Group (brand) GUID used for access control and analytics.
object
Basic appearance options. Gradients, frame, text, and logo are unsupported.

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

string
required
Webhook destination URL. This destination may receive Bitly event data; use only a trusted endpoint.
string
required
Name of the new webhook.
string
required
Bitly event to subscribe to, such as decodes. The provider declares no enum.
string
OAuth client ID for authenticating webhook delivery.
boolean
Whether the webhook is active. Omit to use Bitly’s default.
string
OAuth URL used by Bitly to authenticate webhook delivery.
boolean
Whether Bitly should fetch tags for webhook events.
string
GUID of the group associated with the webhook.
string
required
GUID of the organization that will own the webhook.

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

string
required
ID of the QR code to permanently delete.

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: BITLY_DELETE_SITEDelete an existing Bitly Site by its GUID. Returns no content on success. Access depends on the connected account’s permissions and Bitly plan entitlement.

Input Parameters

string
required
GUID of the existing Bitly Site to delete.

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

string
required
GUID of the Bitly Site containing the block.
string
required
GUID of the Bitly Site content block to delete.

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: BITLY_DELETE_SITE_REDIRECTDelete a redirect for a Bitly Site by its site ID, custom domain, and keyword (back-half). Returns no content on success. Access depends on the connected account’s permissions and Bitly plan entitlement.

Input Parameters

string
required
The custom domain the redirect is configured on.
string
required
The keyword (back-half) of the redirect to delete.
string
required
A GUID for the Bitly Site whose redirect to delete.

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: BITLY_DELETE_WEBHOOKDelete a Bitly webhook by GUID to stop its event deliveries, returning an empty object on success. Requires access to the webhook and a Bitly plan supporting webhooks; upgrade your plan if Bitly returns 402.

Input Parameters

string
required
GUID of the Bitly webhook to delete.

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: BITLY_DISCARD_SITE_DRAFTDiscard a Bitly Site’s in-progress draft by its site GUID. Returns no content on success. Access depends on the connected account’s permissions and Bitly plan entitlement.

Input Parameters

string
required
GUID of the Bitly Site whose in-progress draft to discard.

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: BITLY_GET_ACCOUNT_CONTEXTReturn the authenticated Bitly user together with accessible groups and organizations needed by other tools.

Input Parameters

string
Optionally restrict groups to one Bitly organization GUID.

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

array
Filter by Bitly Site GUIDs; each is sent as a repeated site query parameter.
string ("minute" | "hour" | "day" | "week" | "month")
Time unit for the analytics window.
integer
Number of time units to query; -1 returns all units.
string ("overview" | "views_over_time" | "views_cities" | "views_countries" | "views_devices" | "views_referrers" | "clicks_over_time" | "clicks_cities" | "clicks_countries" | "clicks_devices" | "clicks_top" | "digital_business_card_downloads_over_time")
required
Site analytics report to retrieve: overview, timeline, traffic breakdown, or top buttons.
string
Optional brand GUID, used only for clicks_top and ignored for other reports.
string
Optional Bitly report GUID.
string
ISO-8601 end timestamp; defaults to now. Supply the unencoded timestamp.

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

string
required
GUID of the Bitly 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: 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

string
required
GUID of the Bitly channel 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: 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

string
required
Custom domain on your Bitly account 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: 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

string
required
Custom domain on your Bitly account whose DNS records to inspect.
string
required
GUID of the Bitly organization that owns the custom domain.

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

string
required
Web domain whose registrar purchase agreements to retrieve.
string
GUID of the Bitly organization for the domain purchase.

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: BITLY_GET_GROUPRetrieve a Bitly group by GUID, including its organization, your role, branded short domains, timestamps, and resource references. The group must be accessible to the authenticated user; account entitlements apply.

Input Parameters

string
required
GUID of the Bitly group 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: 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

array
Feature limit names for historical_usage only, sent as repeated query parameters.
integer
Quantity of results for group breakdowns, engagements_top, and link-click breakdowns/top only; not supported for scans.
string ("minute" | "hour" | "day" | "week" | "month")
Required except for historical_usage and agentic_traffic_rollup. Historical usage allows only day, week, month.
integer
Required for time-window metrics; -1 requests all available units. Not used for historical usage or agentic rollup.
string ("shorten_counts" | "countries" | "cities" | "devices" | "referring_networks" | "referrers" | "engagements_top" | "engagements_over_time" | "clicks" | "historical_usage" | "agentic_traffic_rollup" | "links_clicks_over_time" | "links_clicks_devices" | "links_clicks_referrers" | "links_clicks_countries" | "links_clicks_cities" | "links_clicks_top" | "codes_scans_over_time" | "codes_scans_countries" | "codes_scans_cities" | "codes_scans_top")
required
Analytics endpoint to query; underscore-separated names correspond to path segments.
string
Historical usage end date (YYYY-MM-DD); historical_usage only.
boolean
codes_scans_top only: rank decoupled QR scans and return separate links, qr_codes and unified sorted_engagements.
string
required
GUID of the Bitly group.
string
Historical usage start date (YYYY-MM-DD); historical_usage only.
string
ISO-8601 end timestamp for time-window metrics; omit to use current time. Pass unescaped text.

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: BITLY_GET_GROUP_PREFERENCESRetrieve a Bitly group’s preferences, including its preferred domain for shortened links. Requires access to the specified group; availability is subject to your Bitly account permissions and plan entitlements.

Input Parameters

string
required
GUID of the Bitly group whose preferences 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: BITLY_GET_GROUP_TAGSRetrieve tags currently used in a Bitly group for Bitlinks or QR codes. Returns at most 1000 tags; this endpoint has no documented pagination controls or continuation token. Requires access to the group and is subject to account entitlements; upgrade the connected plan if Bitly returns 402.

Input Parameters

string ("bitlink" | "qr_code")
Tag set to retrieve: bitlink (the default) or qr_code.
string
required
GUID of the Bitly group whose tags 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: 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

string
required
The client ID of the OAuth app 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: 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

string
required
GUID of the Bitly organization 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: 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

string ("minute" | "hour" | "day" | "week" | "month")
Time unit; required when by_group is false.
integer
Number of time units; required when by_group is false. Use -1 for all available units.
boolean
Return current-month counts by group instead of time-window counts. No time parameters are accepted when true.
string
Optional ISO-8601 end timestamp for time-window counts; defaults to current time. Pass unescaped text.
string
required
GUID of the Bitly organization.

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

string
required
ID of the QR code to retrieve, obtained when creating or listing QR codes.

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

integer
Number of breakdown items, default 50. Only countries, cities, device_os and browsers accept this parameter.
string ("minute" | "hour" | "day" | "week" | "month")
Time-window unit.
integer
Number of time units to query; -1 requests all units.
string ("timeline" | "summary" | "countries" | "cities" | "device_os" | "browsers")
Time-bucketed scans, total scans, or a scan-traffic breakdown.
string
required
QR Code ID.
string
ISO-8601 end timestamp; defaults to now. Pass unencoded text; transport URL-encodes it.

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

string ("svg" | "png")
Image format inside the returned data URI. Bitly defaults to svg when omitted.
string
required
ID of the existing QR code whose image 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: BITLY_GET_SITERetrieve a Bitly Site by its GUID, including content, appearance, and publication settings. Set include_blocks to retrieve its draft content blocks as well. Availability depends on the connected account’s Bitly plan.

Input Parameters

string
required
GUID of the Bitly Site to retrieve.
boolean
Include draft content blocks, ordered by container and sort order.

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

integer
Numbered result at which to start, for link_performance only; Bitly defaults to 1.
integer
Quantity of items to return; Bitly defaults to 50.
string ("minute" | "hour" | "day" | "week" | "month")
Time unit to query; Bitly defaults to day.
integer
required
Required number of time units to query; -1 requests all units of time.
string ("countries" | "cities" | "devices" | "referrers" | "link_performance" | "views" | "views_summary")
required
Report to retrieve; views_summary returns a single total instead of view metrics.
string
required
GUID of the Bitly Site to analyze.
string
ISO-8601 end timestamp, defaulting to now. Supply unencoded text; URL encoding is automatic.

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

integer
Quantity of ranked items to return, at most 100; defaults to 50.
string ("minute" | "hour" | "day" | "week" | "month")
Time unit for the window; defaults to day.
integer
Number of time units to query; -1 (the default) requests all units.
string
required
GUID of the Bitly group to rank.
string
ISO-8601 end timestamp; defaults to current time. Pass unescaped text; URL encoding is automatic.

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: BITLY_GET_USAGE_AND_LIMITSInspect monthly plan quotas, hourly endpoint budgets, and optional group feature usage before performing quota-consuming work.

Input Parameters

string
Optional group GUID whose current feature usage to include.
string
Optional API path filter for hourly platform limits.
array
Optional group feature names to include, such as encode or qr_codes; requires group_guid.
string
required
Organization GUID whose monthly plan limits to return.

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

string
required
GUID of the Bitly webhook 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: 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

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

string
Filter campaigns by the GUID of a Bitly group. Omit to list campaigns for the authenticated user.

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

string
Filter channels by the GUID of a Bitly group.
string
Filter channels by the GUID of a Bitly 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: 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

string
Filter custom domains by a Bitly organization GUID.

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

integer
Quantity of QR codes to return on this page; defaults to 50.
array
Filter by the given tags.
string
Value to search for.
string ("on" | "off" | "both")
Filter by whether QR codes have GS1 values; defaults to both.
string ("on" | "off" | "both")
Filter by archived status; defaults to off.
array
Filter by QR code type; defaults to bitlink and long_url.
string
required
GUID of the Bitly group whose QR codes to list.
string ("on" | "off" | "both")
Filter by expiration status; defaults to both.
string
Continuation token from pagination.search_after in the previous response. Omit for the first page; use only a token returned by Bitly.
integer
Filter to QR codes created after this Unix timestamp in seconds.
integer
Filter to QR codes created before this Unix timestamp in seconds.
array
Filter by logins of authenticated users who created the QR codes.
string ("on" | "off" | "both")
Filter by presence of an expiration timestamp; defaults to both.
string ("on" | "off" | "both")
Filter by presence of dynamic routing rules; defaults to both.
string
Case-insensitive hostname and/or path to search, including subdomains; query parameters and fragments are ignored.
string ("on" | "off" | "both")
Filter by appearance customizations such as colors or shapes; defaults to both.

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

integer
Number of items to return. Bitly defaults to 50 when omitted.
string
required
GUID of the Bitly group whose active sites to list.
string
Continuation token from pagination.search_after in the previous response; use only a token returned by Bitly.
string
Site URL query parameter used to filter the group’s sites.

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

string ("Link-in-bio" | "Products and services" | "Promotions" | "Digital business card" | "Image gallery" | "Recommended")
Template category used to filter or sort the available site templates.

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: BITLY_LIST_WEBHOOKSList all webhooks available for a Bitly organization by organization GUID. This endpoint has no documented query filters or pagination controls. Requires a Bitly plan with webhook access; upgrade the connected account if Bitly returns 402.

Input Parameters

string
required
GUID of the Bitly organization whose webhooks 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: BITLY_PREVALIDATE_SITE_YOUTUBE_VIDEOValidate a YouTube video ID and construct the content needed for a Bitly Site YouTube video button without creating the button. Requires access to the site and the applicable Bitly Sites plan entitlement.

Input Parameters

string
YouTube video ID to prevalidate for a video button.
string
required
GUID of the Bitly Site (Link Launchpad).

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: BITLY_PUBLISH_SITEPublish a Bitly Site’s draft, replacing the production site when changes have been made. Returns the site’s publication and content settings. Availability depends on the connected account’s Bitly plan.

Input Parameters

string
required
GUID of the Bitly Site whose draft should replace the production site.

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

string
required
New destination URL for the stand-alone QR code.
string
required
ID of the stand-alone QR code whose destination to change. QR codes associated with Bitlinks must be updated via the Bitlinks API.

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

string
Domain to register, selected from GET /domains. Blocked or trademarked names and domains over 32 characters are not allowed.
array
Agreement keys from GET /domains/{domain}/agreements. Submit only after the user has accepted the corresponding domain registration agreements.
string
GUID of the organization whose included domain allowance to use; the caller must be its admin.

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

integer
Maximum number of results to return, at most 25. Bitly defaults to 25.
string
required
Domain name to search for, up to 32 characters.
string
GUID of the Bitly organization to search domains 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: 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

string
New campaign name.
string
GUID of the group to associate with the campaign.
string
New campaign description.
string
required
GUID of the Bitly campaign to update.
array
GUIDs of the channels to associate with the 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: 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

string
Channel GUID in the update body.
string
New channel name.
string
Channel creation time as an ISO timestamp.
Bitlinks and their campaign associations for the channel.
string
Channel modification time as an ISO timestamp.
string
GUID of the group associated with the channel.
string
required
GUID of the Bitly channel to update.

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

boolean
Whether HTTP Strict Transport Security is enabled.
string
required
Custom domain on your account to update.
boolean
Whether HTTPS is enabled for the domain.
string
Root redirect destination; an empty string clears it.
string
Wildcard redirect destination; an empty string clears it.
boolean
Whether insecure requests should be upgraded.

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

array
Branded short domains to associate with the group.
string
New name for the group.
string
required
GUID of the Bitly group to update.
string
GUID of the organization to associate with the group.

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: BITLY_UPDATE_GROUP_PREFERENCESUpdate a Bitly group’s preferred short domain. Requires access to the group; branded domain availability depends on the account’s plan and configured domains.

Input Parameters

string
required
GUID of the Bitly group whose preferences to update.
string
Preferred short domain for the group, such as bit.ly or a branded domain.

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

array
Tags to add to the QR code.
string
Updated QR code title.
boolean
Whether the QR code is archived (hidden from the UI).
string
required
ID of the QR code to update.
string
Expiration timestamp for the QR code’s Bitlink, such as 2025-01-28T14:30:00+0000; must be 5 minutes to 1 year from now.
array
Dynamic routing rules for this QR code. Replaces all existing rules; send an empty array to clear them.
object
QR appearance customizations; availability depends on the Bitly plan.

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

string
New domain/m/keyword URI. Changing it creates a redirect from the previous URI.
string
required
GUID of the Bitly Site to update.
string
QR code ID to attach. Only allowed if the site has no QR code attached yet.
string
Description displayed on the site. An empty string clears the current description.
string
Name displayed on the site. An empty string clears the current name.

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: BITLY_UPDATE_SITE_APPEARANCEUpdate a Bitly Site’s theme, layout, fonts, colors, images, header, buttons, and social icon appearance. Availability of appearance options depends on the connected account’s Bitly plan. Bitly returns no site data on success.

Input Parameters

string
Site font.
string
Site layout.
string
required
GUID of the Bitly Site whose appearance to update.
integer
Site theme identifier.
integer
Site layout version identifier.
string
Site text color.
Whether to hide the Bitly logo.
string
Avatar image URL.
string
Site background color.
string ("custom" | "theme" | "image")
Site style source.
string
Avatar image GUID.
string
Site description color.
object
Header banner, profile image, and text appearance settings.
string
Background image URL.
string
Default button shape.
string
Background image GUID.
string
Site background preference.
string
Default button shadow.
string
Bottom background color.
string
Default button text color.
string
Default social icon color.
string ("stretch" | "fit" | "repeat")
Background image alignment.
string
Default social icon layout.
string
Default social icon position.
string
Default button background color.

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

string
Parent container block identifier.
object
Content fields for the stored block’s type: Bitlink, YouTube, social, image, digital business card, or text. The block type cannot be changed.
string
required
GUID of the Bitly Site containing the block.
string
required
GUID of the existing content block to update.
boolean
Whether the block is active.
boolean
Whether the block is pinned.
object
Text block colors, alignment, font size, and styling.
string
Block schedule end time.
string
Block schedule start time.

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: BITLY_UPDATE_USERUpdate the authenticated Bitly user’s display name or default group. Supply the fields to change; omitted fields are not sent. Returns the updated user profile and email details. Availability depends on the connected account’s permissions and Bitly plan.

Input Parameters

string
New display name for the authenticated Bitly user.
string
GUID of the group to use as the authenticated user’s default group.

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

string
Destination URL for webhook events.
string
required
Webhook GUID required in the update body.
string
New name for the webhook.
string
Event that triggers the webhook.
string
Client ID for the webhook destination’s OAuth authentication.
boolean
Whether the webhook is active.
string
OAuth URL used to authenticate webhook deliveries.
boolean
Whether the webhook fetches tags.
string
GUID of the group associated with the webhook.
string
required
GUID of the Bitly webhook to update.
string
GUID of the organization associated with the webhook.

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: 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.

Input Parameters

string
required
GUID of the Bitly webhook to verify.

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