> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Bitly

> Bitly is a link management platform for shortening, customizing, sharing, and measuring links and QR codes.

![Bitly logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/bitly.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=1be6b3e194c1609755896838cc8273e0)

* **Category:** url shortener
* **Auth:** API\_KEY, OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 85
* **Triggers:** 0
* **Slug:** `BITLY`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Channel Bitlinks
>
> **Slug:** `BITLY_ADD_CHANNEL_BITLINKS`
>
> Add 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
>
> **bitlinks** `array` *required*
>
> One to 100 Bitlink IDs, including domain and back-half, to add to the channel. Existing channel associations are left untouched.
>
> **channel\_guid** `string` *required*
>
> GUID of the Bitly channel to add Bitlinks to.
>
> **campaign\_guid** `string` *required*
>
> Campaign GUID to associate with every Bitlink in this request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Custom Bitlink
>
> **Slug:** `BITLY_ADD_CUSTOM_BITLINK`
>
> Add 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
>
> **bitlink\_id** `string`
>
> Existing Bitlink identifier as domain/hash, on the same Custom Domain.
>
> **custom\_bitlink** `string`
>
> Desired custom domain/back-half without a protocol. The domain must be available to the account and match the domain of bitlink\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Custom Domain
>
> **Slug:** `BITLY_ADD_CUSTOM_DOMAIN`
>
> Add 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
>
> **group\_guids** `array`
>
> GUIDs of groups to associate with the custom domain.
>
> **prevalidate** `boolean`
>
> Check whether the domain can be used without adding it or creating a custom domain.
>
> **custom\_domain** `string` *required*
>
> Custom domain you already own and can configure DNS for. This does not purchase a domain.
>
> **organization\_guid** `string` *required*
>
> GUID of the organization to add the domain to; the caller must be its admin.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Apply Site Template
>
> **Slug:** `BITLY_APPLY_SITE_TEMPLATE`
>
> Apply 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
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site to apply the template to.
>
> **template\_guid** `string`
>
> GUID of the template whose appearance should be applied to the site.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk Update Bitlinks
>
> **Slug:** `BITLY_BULK_UPDATE_BITLINKS`
>
> Add 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
>
> **links** `array`
>
> Up to 100 Bitlink IDs to update, each as domain/back-half.
>
> **action** `string ("archive" | "edit_tags")` *required*
>
> Bulk operation: archive/unarchive Bitlinks or edit their tags.
>
> **archive** `boolean`
>
> Set true to archive or false to unarchive links for the archive action.
>
> **add\_tags** `array`
>
> Tags to add for the edit\_tags action.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group whose Bitlinks to update.
>
> **remove\_tags** `array`
>
> Tags to remove for the edit\_tags action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk Update QR Codes
>
> **Slug:** `BITLY_BULK_UPDATE_QR_CODES`
>
> Add 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
>
> **action** `string ("archive" | "edit_tags")` *required*
>
> Bulk operation: archive/unarchive QR codes or edit their tags.
>
> **archive** `boolean`
>
> Archive (true) or unarchive (false) QR codes for the archive action.
>
> **add\_tags** `array`
>
> Tags to add for the edit\_tags action.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group whose QR codes to update.
>
> **qr\_code\_ids** `array`
>
> Up to 100 QR code IDs to update. Pages QR codes are not supported.
>
> **remove\_tags** `array`
>
> Tags to remove for the edit\_tags action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clone Site
>
> **Slug:** `BITLY_CLONE_SITE`
>
> Create 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
>
> **uri** `string`
>
> URI for the cloned site in domain/m/keyword form.
>
> **site\_id** `string` *required*
>
> GUID of the existing Bitly Site to clone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Bitlink
>
> **Slug:** `BITLY_CREATE_BITLINK`
>
> Create 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
>
> **tags** `array`
>
> Tags for the Bitlink.
>
> **title** `string`
>
> Human-readable Bitlink title.
>
> **domain** `string`
>
> Short-link domain to use.
>
> **keyword** `string`
>
> Custom back-half; creates an override at domain/keyword.
>
> **long\_url** `string`
>
> URL to shorten for a new Bitlink. Provide this or bitlink\_id, not both.
>
> **deeplinks** `array`
>
> Mobile app deep-link configurations.
>
> **bitlink\_id** `string`
>
> Existing domain/hash to add a keyword override to; excludes long\_url.
>
> **group\_guid** `string`
>
> Owning group GUID. Bitly recommends specifying a group and custom domain.
>
> **expiration\_at** `string`
>
> Expiration timestamp with timezone, e.g. 2027-01-28T14:30:00+0000. Must be at least 5 minutes from now and at most 1 year from now.
>
> **force\_new\_link** `boolean`
>
> Create a new link even if the URL was already shortened.
>
> **dynamic\_routing** `array`
>
> Rules routing visitors to destinations by location or device.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Campaign
>
> **Slug:** `BITLY_CREATE_CAMPAIGN`
>
> Create 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
>
> **name** `string`
>
> Name of the new campaign.
>
> **group\_guid** `string`
>
> GUID of the Bitly group that will own the campaign.
>
> **description** `string`
>
> Description of the new campaign.
>
> **channel\_guids** `array`
>
> GUIDs of the channels to associate with the campaign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Channel
>
> **Slug:** `BITLY_CREATE_CHANNEL`
>
> Create 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
>
> **guid** `string`
>
> GUID of the channel.
>
> **name** `string`
>
> Name of the new channel.
>
> **created** `string`
>
> Channel creation time as an ISO timestamp.
>
> **bitlinks** `array`
>
> Campaign and bitlink associations for the channel.
>
> **modified** `string`
>
> Channel last modification time as an ISO timestamp.
>
> **group\_guid** `string`
>
> GUID of the Bitly group that will own the channel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Group Export
>
> **Slug:** `BITLY_CREATE_GROUP_EXPORT`
>
> Build 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
>
> **filter** `object`
>
> Search constraints; required for links\_list and qr\_codes\_list. For link\_engagements\_batch, provide either filter or bitlinks.
>
> **unix\_to** `integer`
>
> Metrics window end in Unix seconds (UTC); see unix\_from.
>
> **bitlinks** `array`
>
> Fully qualified bitlinks (for example bit.ly/abc) for link\_engagements\_batch; mutually exclusive with filter.
>
> **unix\_from** `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.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group to export.
>
> **export\_type** `string ("link_engagements_batch" | "links_list" | "qr_codes_list")` *required*
>
> CSV shape to produce.
>
> **include\_metrics** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create QR Code
>
> **Slug:** `BITLY_CREATE_QR_CODE`
>
> Create 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
>
> **gs1** `object`
>
> GS1 application identifiers and values to encode.
>
> **tags** `array`
>
> Tags to add to the QR code.
>
> **title** `string`
>
> Title of the new QR code.
>
> **domain** `string`
>
> Short domain for the QR redirect; Bitly defaults to bit.ly.
>
> **archived** `boolean`
>
> Whether to create the QR code archived, hiding it from the UI.
>
> **group\_guid** `string` *required*
>
> GUID of the group that will own the QR code; obtain it from Get Account Context.
>
> **destination** `object` *required*
>
> Target destination: an existing Bitlink, Link-in-Bio site, or a stand-alone long URL.
>
> **expiration\_at** `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.
>
> **dynamic\_routing** `array`
>
> Dynamic routing rules, supported only for long\_url destinations. Replaces all rules; an empty array clears them.
>
> **render\_customizations** `object`
>
> QR appearance customizations; availability depends on the Bitly plan.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Site
>
> **Slug:** `BITLY_CREATE_SITE`
>
> Create 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
>
> **uri** `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.
>
> **domain** `string` *required*
>
> Domain for the site, such as bit.ly or an owned branded domain.
>
> **keyword** `string` *required*
>
> Custom back-half for the new site's URL.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group that will own the new site.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Site Block
>
> **Slug:** `BITLY_CREATE_SITE_BLOCK`
>
> Create 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
>
> **type** `string ("bitlink" | "social" | "youtubeVideo" | "image" | "digital_business_card" | "text_block")` *required*
>
> Block type to create; grid and carousel require the container endpoint.
>
> **parent** `string`
>
> Parent container block ID.
>
> **content** `string` *required*
>
> Content matching the selected block type.
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site receiving the block.
>
> **is\_active** `boolean`
>
> Whether the block is active.
>
> **is\_pinned** `boolean`
>
> Whether the block is pinned.
>
> **appearance** `object`
>
> Text block appearance settings.
>
> **schedule\_end** `string`
>
> Block schedule end timestamp.
>
> **schedule\_start** `string`
>
> Block schedule start timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Site Container
>
> **Slug:** `BITLY_CREATE_SITE_CONTAINER`
>
> Create 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
>
> **type** `string ("carousel" | "grid")`
>
> Container layout: carousel or grid.
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site in which to create a container.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Site Image
>
> **Slug:** `BITLY_CREATE_SITE_IMAGE`
>
> Attach 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
>
> **url** `string` *required*
>
> URL of the uploaded image; required together with image\_guid.
>
> **crop** `string`
>
> JSON-encoded crop coordinates, supplied as a string, not an object.
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site to attach the image to.
>
> **image\_use** `string ("profile" | "background" | "banner" | "profile_life" | "background_live" | "banner_live")`
>
> Intended image use on the site.
>
> **image\_guid** `string` *required*
>
> GUID of the previously uploaded image; required together with url.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Static QR Code
>
> **Slug:** `BITLY_CREATE_STATIC_QR_CODE`
>
> Generate 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
>
> **accept** `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.
>
> **format** `string ("svg" | "png")`
>
> Image format; defaults to svg. Ignored when Accept specifies an image type.
>
> **content** `string` *required*
>
> Raw content to encode, such as a URL.
>
> **group\_guid** `string` *required*
>
> Group (brand) GUID used for access control and analytics.
>
> **render\_customizations** `object`
>
> Basic appearance options. Gradients, frame, text, and logo are unsupported.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Webhook
>
> **Slug:** `BITLY_CREATE_WEBHOOK`
>
> Create 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
>
> **url** `string` *required*
>
> Webhook destination URL. This destination may receive Bitly event data; use only a trusted endpoint.
>
> **name** `string` *required*
>
> Name of the new webhook.
>
> **event** `string` *required*
>
> Bitly event to subscribe to, such as decodes. The provider declares no enum.
>
> **client\_id** `string`
>
> OAuth client ID for authenticating webhook delivery.
>
> **is\_active** `boolean`
>
> Whether the webhook is active. Omit to use Bitly's default.
>
> **oauth\_url** `string`
>
> OAuth URL used by Bitly to authenticate webhook delivery.
>
> **fetch\_tags** `boolean`
>
> Whether Bitly should fetch tags for webhook events.
>
> **group\_guid** `string`
>
> GUID of the group associated with the webhook.
>
> **organization\_guid** `string` *required*
>
> GUID of the organization that will own the webhook.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Bitlink
>
> **Slug:** `BITLY_DELETE_BITLINK`
>
> Permanently delete an eligible unedited hash Bitlink.
>
> #### Input Parameters
>
> **bitlink** `string` *required*
>
> Bitlink as domain/back-half without a protocol; deletion is permanent and Bitly only permits eligible unedited hash links.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete QR Code
>
> **Slug:** `BITLY_DELETE_QR_CODE`
>
> Permanently 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
>
> **qrcode\_id** `string` *required*
>
> ID of the QR code to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Site
>
> **Slug:** `BITLY_DELETE_SITE`
>
> Delete 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
>
> **site\_id** `string` *required*
>
> GUID of the existing Bitly Site to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Site Block
>
> **Slug:** `BITLY_DELETE_SITE_BLOCK`
>
> Delete 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
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site containing the block.
>
> **block\_id** `string` *required*
>
> GUID of the Bitly Site content block to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Site Redirect
>
> **Slug:** `BITLY_DELETE_SITE_REDIRECT`
>
> Delete 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
>
> **domain** `string` *required*
>
> The custom domain the redirect is configured on.
>
> **keyword** `string` *required*
>
> The keyword (back-half) of the redirect to delete.
>
> **site\_id** `string` *required*
>
> A GUID for the Bitly Site whose redirect to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook
>
> **Slug:** `BITLY_DELETE_WEBHOOK`
>
> Delete 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
>
> **webhook\_guid** `string` *required*
>
> GUID of the Bitly webhook to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Discard Site Draft
>
> **Slug:** `BITLY_DISCARD_SITE_DRAFT`
>
> Discard 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
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site whose in-progress draft to discard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Expand Link
>
> **Slug:** `BITLY_EXPAND_LINK`
>
> Resolve a Bitlink to its current destination and destination history, when available.
>
> #### Input Parameters
>
> **bitlink** `string` *required*
>
> Bitlink as domain/back-half without a protocol, for example bit.ly/12a4b6c.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Context
>
> **Slug:** `BITLY_GET_ACCOUNT_CONTEXT`
>
> Return the authenticated Bitly user together with accessible groups and organizations needed by other tools.
>
> #### Input Parameters
>
> **organization\_guid** `string`
>
> Optionally restrict groups to one Bitly organization GUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Aggregate Site Analytics
>
> **Slug:** `BITLY_GET_AGGREGATE_SITE_ANALYTICS`
>
> Retrieve 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
>
> **site** `array`
>
> Filter by Bitly Site GUIDs; each is sent as a repeated site query parameter.
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")`
>
> Time unit for the analytics window.
>
> **units** `integer`
>
> Number of time units to query; -1 returns all units.
>
> **report** `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.
>
> **brand\_guid** `string`
>
> Optional brand GUID, used only for clicks\_top and ignored for other reports.
>
> **report\_guid** `string`
>
> Optional Bitly report GUID.
>
> **unit\_reference** `string`
>
> ISO-8601 end timestamp; defaults to now. Supply the unencoded timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bitlink
>
> **Slug:** `BITLY_GET_BITLINK`
>
> Retrieve Bitlink metadata, including destination, title, tags, archive or deletion state, and associated QR code IDs.
>
> #### Input Parameters
>
> **bitlink** `string` *required*
>
> Bitlink as domain/back-half without a protocol, for example bit.ly/12a4b6c.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bitlink Activity
>
> **Slug:** `BITLY_GET_BITLINK_ACTIVITY`
>
> Return paid-plan click or engagement analytics for a Bitlink as a timeline or summary. Requires Bitlink analytics entitlement.
>
> #### Input Parameters
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")`
>
> Time bucket and lookback unit.
>
> **view** `string ("summary" | "timeline")`
>
> Return one total or time-bucketed values.
>
> **units** `integer`
>
> Number of units to query; -1 requests all available units.
>
> **metric** `string ("clicks" | "engagements")`
>
> Measure link clicks only or all engagement types, including clicks, scans, and Bitly Link-in-bio button clicks.
>
> **bitlink** `string` *required*
>
> Bitlink as domain/back-half without a protocol.
>
> **unit\_reference** `string`
>
> Optional ISO-8601 end timestamp; defaults to now.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bitlink Referrer Analytics
>
> **Slug:** `BITLY_GET_BITLINK_REFERRER_ANALYTICS`
>
> Get 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
>
> **size** `integer`
>
> Quantity of referrer items to return (provider default 50). Not supported for agentic\_traffic; not pagination.
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")` *required*
>
> Time unit for the analytics window.
>
> **units** `integer` *required*
>
> Number of time units to query; -1 requests all available units.
>
> **metric** `string ("agentic_traffic" | "referrer_name" | "referrers_by_domains")` *required*
>
> Choose AI agent traffic, referrer names, or referrers grouped by domain.
>
> **bitlink** `string` *required*
>
> Bitlink domain/back-half without a protocol.
>
> **unit\_reference** `string`
>
> ISO-8601 window end timestamp, unencoded; defaults to the current time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bitlink Traffic Sources
>
> **Slug:** `BITLY_GET_BITLINK_TRAFFIC_SOURCES`
>
> Break down paid-plan Bitlink click analytics by country, city, device, referrer, or referring domain. Requires Bitlink analytics entitlement.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum ranked values to return; this is not pagination.
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")`
>
> Time unit for the lookback window.
>
> **units** `integer`
>
> Number of units to query; -1 requests all available units.
>
> **bitlink** `string` *required*
>
> Bitlink as domain/back-half without a protocol.
>
> **dimension** `string ("country" | "city" | "device" | "referrer" | "referring_domain")` *required*
>
> Dimension by which to rank click traffic.
>
> **unit\_reference** `string`
>
> Optional ISO-8601 end timestamp; defaults to now.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaign
>
> **Slug:** `BITLY_GET_CAMPAIGN`
>
> Retrieve 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
>
> **campaign\_guid** `string` *required*
>
> GUID of the Bitly campaign to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Channel
>
> **Slug:** `BITLY_GET_CHANNEL`
>
> Retrieve 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
>
> **channel\_guid** `string` *required*
>
> GUID of the Bitly channel to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Bitlink
>
> **Slug:** `BITLY_GET_CUSTOM_BITLINK`
>
> Retrieve a Custom Bitlink's details, current destination Bitlink, and redirect history. Supply the custom domain/back-half without a protocol. Requires access to the Custom Bitlink and a Bitly plan with the appropriate custom-link entitlement.
>
> #### Input Parameters
>
> **custom\_bitlink** `string` *required*
>
> Custom Bitlink as domain/back-half, without a protocol.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Bitlink Analytics
>
> **Slug:** `BITLY_GET_CUSTOM_BITLINK_ANALYTICS`
>
> Retrieve 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
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")`
>
> Time unit for the analytics window.
>
> **units** `integer`
>
> Number of time units to query; -1 requests all available units.
>
> **report** `string ("clicks" | "clicks_by_destination")`
>
> Get time-bucketed clicks across the link's history or clicks grouped by historical destination.
>
> **custom\_bitlink** `string` *required*
>
> Custom Bitlink as domain/keyword without a protocol.
>
> **unit\_reference** `string`
>
> ISO-8601 end timestamp; defaults to the current time. Supply the unencoded value; query encoding is automatic.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Domain
>
> **Slug:** `BITLY_GET_CUSTOM_DOMAIN`
>
> Retrieve 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
>
> **custom\_domain** `string` *required*
>
> Custom domain on your Bitly account to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Domain DNS
>
> **Slug:** `BITLY_GET_CUSTOM_DOMAIN_DNS`
>
> Inspect 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
>
> **custom\_domain** `string` *required*
>
> Custom domain on your Bitly account whose DNS records to inspect.
>
> **organization\_guid** `string` *required*
>
> GUID of the Bitly organization that owns the custom domain.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Domain Agreements
>
> **Slug:** `BITLY_GET_DOMAIN_AGREEMENTS`
>
> Retrieve 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
>
> **domain** `string` *required*
>
> Web domain whose registrar purchase agreements to retrieve.
>
> **organization\_guid** `string`
>
> GUID of the Bitly organization for the domain purchase.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Group
>
> **Slug:** `BITLY_GET_GROUP`
>
> Retrieve 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
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Group Analytics
>
> **Slug:** `BITLY_GET_GROUP_ANALYTICS`
>
> Retrieve 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
>
> **name** `array`
>
> Feature limit names for historical\_usage only, sent as repeated query parameters.
>
> **size** `integer`
>
> Quantity of results for group breakdowns, engagements\_top, and link-click breakdowns/top only; not supported for scans.
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")`
>
> Required except for historical\_usage and agentic\_traffic\_rollup. Historical usage allows only day, week, month.
>
> **units** `integer`
>
> Required for time-window metrics; -1 requests all available units. Not used for historical usage or agentic rollup.
>
> **metric** `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.
>
> **end\_date** `string`
>
> Historical usage end date (YYYY-MM-DD); historical\_usage only.
>
> **decoupled** `boolean`
>
> codes\_scans\_top only: rank decoupled QR scans and return separate links, qr\_codes and unified sorted\_engagements.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group.
>
> **start\_date** `string`
>
> Historical usage start date (YYYY-MM-DD); historical\_usage only.
>
> **unit\_reference** `string`
>
> ISO-8601 end timestamp for time-window metrics; omit to use current time. Pass unescaped text.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Group Preferences
>
> **Slug:** `BITLY_GET_GROUP_PREFERENCES`
>
> Retrieve 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
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group whose preferences to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Group Tags
>
> **Slug:** `BITLY_GET_GROUP_TAGS`
>
> Retrieve 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
>
> **type** `string ("bitlink" | "qr_code")`
>
> Tag set to retrieve: bitlink (the default) or qr\_code.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group whose tags to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get OAuth App
>
> **Slug:** `BITLY_GET_OAUTH_APP`
>
> Retrieve 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
>
> **client\_id** `string` *required*
>
> The client ID of the OAuth app to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization
>
> **Slug:** `BITLY_GET_ORGANIZATION`
>
> Retrieve 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
>
> **organization\_guid** `string` *required*
>
> GUID of the Bitly organization to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Shorten Counts
>
> **Slug:** `BITLY_GET_ORGANIZATION_SHORTEN_COUNTS`
>
> Read 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
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")`
>
> Time unit; required when by\_group is false.
>
> **units** `integer`
>
> Number of time units; required when by\_group is false. Use -1 for all available units.
>
> **by\_group** `boolean`
>
> Return current-month counts by group instead of time-window counts. No time parameters are accepted when true.
>
> **unit\_reference** `string`
>
> Optional ISO-8601 end timestamp for time-window counts; defaults to current time. Pass unescaped text.
>
> **organization\_guid** `string` *required*
>
> GUID of the Bitly organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get QR Code
>
> **Slug:** `BITLY_GET_QR_CODE`
>
> Retrieve 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
>
> **qrcode\_id** `string` *required*
>
> ID of the QR code to retrieve, obtained when creating or listing QR codes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get QR Code Analytics
>
> **Slug:** `BITLY_GET_QR_CODE_ANALYTICS`
>
> Get 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
>
> **size** `integer`
>
> Number of breakdown items, default 50. Only countries, cities, device\_os and browsers accept this parameter.
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")`
>
> Time-window unit.
>
> **units** `integer`
>
> Number of time units to query; -1 requests all units.
>
> **report** `string ("timeline" | "summary" | "countries" | "cities" | "device_os" | "browsers")`
>
> Time-bucketed scans, total scans, or a scan-traffic breakdown.
>
> **qrcode\_id** `string` *required*
>
> QR Code ID.
>
> **unit\_reference** `string`
>
> ISO-8601 end timestamp; defaults to now. Pass unencoded text; transport URL-encodes it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get QR Code Image
>
> **Slug:** `BITLY_GET_QR_CODE_IMAGE`
>
> Retrieve 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
>
> **format** `string ("svg" | "png")`
>
> Image format inside the returned data URI. Bitly defaults to svg when omitted.
>
> **qrcode\_id** `string` *required*
>
> ID of the existing QR code whose image to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Site
>
> **Slug:** `BITLY_GET_SITE`
>
> Retrieve 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
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site to retrieve.
>
> **include\_blocks** `boolean`
>
> Include draft content blocks, ordered by container and sort order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Site Analytics
>
> **Slug:** `BITLY_GET_SITE_ANALYTICS`
>
> Retrieve 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
>
> **page** `integer`
>
> Numbered result at which to start, for link\_performance only; Bitly defaults to 1.
>
> **size** `integer`
>
> Quantity of items to return; Bitly defaults to 50.
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")`
>
> Time unit to query; Bitly defaults to day.
>
> **units** `integer` *required*
>
> Required number of time units to query; -1 requests all units of time.
>
> **report** `string ("countries" | "cities" | "devices" | "referrers" | "link_performance" | "views" | "views_summary")` *required*
>
> Report to retrieve; views\_summary returns a single total instead of view metrics.
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site to analyze.
>
> **unit\_reference** `string`
>
> ISO-8601 end timestamp, defaulting to now. Supply unencoded text; URL encoding is automatic.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Top Group Engagements
>
> **Slug:** `BITLY_GET_TOP_GROUP_ENGAGEMENTS`
>
> Retrieve 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
>
> **size** `integer`
>
> Quantity of ranked items to return, at most 100; defaults to 50.
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")`
>
> Time unit for the window; defaults to day.
>
> **units** `integer`
>
> Number of time units to query; -1 (the default) requests all units.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group to rank.
>
> **unit\_reference** `string`
>
> ISO-8601 end timestamp; defaults to current time. Pass unescaped text; URL encoding is automatic.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Usage and Limits
>
> **Slug:** `BITLY_GET_USAGE_AND_LIMITS`
>
> Inspect monthly plan quotas, hourly endpoint budgets, and optional group feature usage before performing quota-consuming work.
>
> #### Input Parameters
>
> **group\_guid** `string`
>
> Optional group GUID whose current feature usage to include.
>
> **endpoint\_path** `string`
>
> Optional API path filter for hourly platform limits.
>
> **feature\_names** `array`
>
> Optional group feature names to include, such as encode or qr\_codes; requires group\_guid.
>
> **organization\_guid** `string` *required*
>
> Organization GUID whose monthly plan limits to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook
>
> **Slug:** `BITLY_GET_WEBHOOK`
>
> Retrieve 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
>
> **webhook\_guid** `string` *required*
>
> GUID of the Bitly webhook to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Bitlinks
>
> **Slug:** `BITLY_LIST_BITLINKS`
>
> List or search Bitlinks owned by a group, one cursor-controlled page at a time.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum number of links to return in this page.
>
> **tags** `array`
>
> Restrict results to links with these tags.
>
> **query** `string`
>
> Search text to match against links.
>
> **archived** `string ("on" | "off" | "both")`
>
> Whether to return archived links: on, off, or both.
>
> **group\_guid** `string`
>
> GUID of the Bitly group whose links to list. Required for the first page; omit when continuing with next\_cursor.
>
> **next\_cursor** `string`
>
> Opaque continuation token returned by the previous call. When provided, omit first-page selectors because it restores the group and filters.
>
> **created\_after** `integer`
>
> Only return links created after this Unix timestamp in seconds.
>
> **created\_before** `integer`
>
> Only return links created before this Unix timestamp in seconds.
>
> **hostname\_path\_query** `string`
>
> Case-insensitive hostname or path search; query parameters and fragments are ignored.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Branded Short Domains
>
> **Slug:** `BITLY_LIST_BRANDED_SHORT_DOMAINS`
>
> List 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaigns
>
> **Slug:** `BITLY_LIST_CAMPAIGNS`
>
> List 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
>
> **group\_guid** `string`
>
> Filter campaigns by the GUID of a Bitly group. Omit to list campaigns for the authenticated user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Channels
>
> **Slug:** `BITLY_LIST_CHANNELS`
>
> List 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
>
> **group\_guid** `string`
>
> Filter channels by the GUID of a Bitly group.
>
> **campaign\_guid** `string`
>
> Filter channels by the GUID of a Bitly campaign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Domains
>
> **Slug:** `BITLY_LIST_CUSTOM_DOMAINS`
>
> List 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
>
> **organization\_guid** `string`
>
> Filter custom domains by a Bitly organization GUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List QR Codes
>
> **Slug:** `BITLY_LIST_QR_CODES`
>
> List 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
>
> **size** `integer`
>
> Quantity of QR codes to return on this page; defaults to 50.
>
> **tags** `array`
>
> Filter by the given tags.
>
> **query** `string`
>
> Value to search for.
>
> **is\_gs1** `string ("on" | "off" | "both")`
>
> Filter by whether QR codes have GS1 values; defaults to both.
>
> **archived** `string ("on" | "off" | "both")`
>
> Filter by archived status; defaults to off.
>
> **qrc\_type** `array`
>
> Filter by QR code type; defaults to bitlink and long\_url.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group whose QR codes to list.
>
> **is\_expired** `string ("on" | "off" | "both")`
>
> Filter by expiration status; defaults to both.
>
> **search\_after** `string`
>
> Continuation token from pagination.search\_after in the previous response. Omit for the first page; use only a token returned by Bitly.
>
> **created\_after** `integer`
>
> Filter to QR codes created after this Unix timestamp in seconds.
>
> **created\_before** `integer`
>
> Filter to QR codes created before this Unix timestamp in seconds.
>
> **creating\_login** `array`
>
> Filter by logins of authenticated users who created the QR codes.
>
> **has\_expiration** `string ("on" | "off" | "both")`
>
> Filter by presence of an expiration timestamp; defaults to both.
>
> **has\_dynamic\_routing** `string ("on" | "off" | "both")`
>
> Filter by presence of dynamic routing rules; defaults to both.
>
> **hostname\_path\_query** `string`
>
> Case-insensitive hostname and/or path to search, including subdomains; query parameters and fragments are ignored.
>
> **has\_render\_customizations** `string ("on" | "off" | "both")`
>
> Filter by appearance customizations such as colors or shapes; defaults to both.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sites
>
> **Slug:** `BITLY_LIST_SITES`
>
> List 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
>
> **size** `integer`
>
> Number of items to return. Bitly defaults to 50 when omitted.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group whose active sites to list.
>
> **search\_after** `string`
>
> Continuation token from pagination.search\_after in the previous response; use only a token returned by Bitly.
>
> **sites\_url\_param** `string`
>
> Site URL query parameter used to filter the group's sites.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Site Templates
>
> **Slug:** `BITLY_LIST_SITE_TEMPLATES`
>
> List 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
>
> **category** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sorted Bitlinks
>
> **Slug:** `BITLY_LIST_SORTED_BITLINKS`
>
> Retrieve 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
>
> **size** `integer`
>
> Number of ranked Bitlinks to return, at most 100.
>
> **sort** `string` *required*
>
> Sorting metric; Bitly currently supports only clicks.
>
> **unit** `string ("minute" | "hour" | "day" | "week" | "month")`
>
> Time unit for the click-ranking window.
>
> **units** `integer`
>
> Number of time units to query; -1 requests all units of time.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group whose Bitlinks to rank.
>
> **unit\_reference** `string`
>
> ISO-8601 timestamp for the most recent time to include; defaults to the current time. Supply the raw timestamp, not a URL-encoded value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhooks
>
> **Slug:** `BITLY_LIST_WEBHOOKS`
>
> List 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
>
> **organization\_guid** `string` *required*
>
> GUID of the Bitly organization whose webhooks to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Prevalidate Site YouTube Video
>
> **Slug:** `BITLY_PREVALIDATE_SITE_YOUTUBE_VIDEO`
>
> Validate 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
>
> **video\_id** `string`
>
> YouTube video ID to prevalidate for a video button.
>
> **launchpad\_id** `string` *required*
>
> GUID of the Bitly Site (Link Launchpad).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publish Site
>
> **Slug:** `BITLY_PUBLISH_SITE`
>
> Publish 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
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site whose draft should replace the production site.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Redirect QR Code
>
> **Slug:** `BITLY_REDIRECT_QR_CODE`
>
> Change 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
>
> **long\_url** `string` *required*
>
> New destination URL for the stand-alone QR code.
>
> **qrcode\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Register Domain
>
> **Slug:** `BITLY_REGISTER_DOMAIN`
>
> Register (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
>
> **domain** `string`
>
> Domain to register, selected from GET /domains. Blocked or trademarked names and domains over 32 characters are not allowed.
>
> **agreement\_keys** `array`
>
> Agreement keys from GET /domains/\{domain}/agreements. Submit only after the user has accepted the corresponding domain registration agreements.
>
> **organization\_guid** `string`
>
> GUID of the organization whose included domain allowance to use; the caller must be its admin.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Domains
>
> **Slug:** `BITLY_SEARCH_DOMAINS`
>
> Search 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
>
> **limit** `integer`
>
> Maximum number of results to return, at most 25. Bitly defaults to 25.
>
> **query** `string` *required*
>
> Domain name to search for, up to 32 characters.
>
> **organization\_guid** `string`
>
> GUID of the Bitly organization to search domains for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Shorten Link
>
> **Slug:** `BITLY_SHORTEN_LINK`
>
> Create an ordinary Bitly short link for a long URL in a specific group.
>
> #### Input Parameters
>
> **domain** `string`
>
> Short-link domain. Use bit.ly unless the account context shows an owned branded domain.
>
> **long\_url** `string` *required*
>
> Absolute HTTP or HTTPS URL to shorten.
>
> **group\_guid** `string` *required*
>
> Bitly group GUID that will own the link; obtain it from Get Account Context.
>
> **force\_new\_link** `boolean`
>
> Create a new hash even if this group already shortened the URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Bitlink
>
> **Slug:** `BITLY_UPDATE_BITLINK`
>
> Update safe metadata or archive state for a Bitlink; this tool does not redirect destinations or configure advanced routing.
>
> #### Input Parameters
>
> **tags** `array`
>
> Complete replacement tag list; send an empty list to clear tags.
>
> **title** `string`
>
> New human-readable title.
>
> **bitlink** `string` *required*
>
> Bitlink as domain/back-half without a protocol.
>
> **archived** `boolean`
>
> Set true to archive or false to restore the link.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Campaign
>
> **Slug:** `BITLY_UPDATE_CAMPAIGN`
>
> Update 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
>
> **name** `string`
>
> New campaign name.
>
> **group\_guid** `string`
>
> GUID of the group to associate with the campaign.
>
> **description** `string`
>
> New campaign description.
>
> **campaign\_guid** `string` *required*
>
> GUID of the Bitly campaign to update.
>
> **channel\_guids** `array`
>
> GUIDs of the channels to associate with the campaign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Channel
>
> **Slug:** `BITLY_UPDATE_CHANNEL`
>
> Update 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
>
> **guid** `string`
>
> Channel GUID in the update body.
>
> **name** `string`
>
> New channel name.
>
> **created** `string`
>
> Channel creation time as an ISO timestamp.
>
> **bitlinks** `array`
>
> Bitlinks and their campaign associations for the channel.
>
> **modified** `string`
>
> Channel modification time as an ISO timestamp.
>
> **group\_guid** `string`
>
> GUID of the group associated with the channel.
>
> **channel\_guid** `string` *required*
>
> GUID of the Bitly channel to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Bitlink
>
> **Slug:** `BITLY_UPDATE_CUSTOM_BITLINK`
>
> Move 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
>
> **bitlink\_id** `string`
>
> Destination Bitlink identifier as domain/hash. Supply this to move the custom back-half; its domain must match custom\_bitlink.
>
> **custom\_bitlink** `string` *required*
>
> Existing Custom Bitlink as domain/keyword, without a protocol.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Domain
>
> **Slug:** `BITLY_UPDATE_CUSTOM_DOMAIN`
>
> Change 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
>
> **hsts\_enabled** `boolean`
>
> Whether HTTP Strict Transport Security is enabled.
>
> **custom\_domain** `string` *required*
>
> Custom domain on your account to update.
>
> **https\_enabled** `boolean`
>
> Whether HTTPS is enabled for the domain.
>
> **root\_redirect** `string`
>
> Root redirect destination; an empty string clears it.
>
> **wildcard\_redirect** `string`
>
> Wildcard redirect destination; an empty string clears it.
>
> **upgrade\_insecure\_requests** `boolean`
>
> Whether insecure requests should be upgraded.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Group
>
> **Slug:** `BITLY_UPDATE_GROUP`
>
> Update 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
>
> **bsds** `array`
>
> Branded short domains to associate with the group.
>
> **name** `string`
>
> New name for the group.
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group to update.
>
> **organization\_guid** `string`
>
> GUID of the organization to associate with the group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Group Preferences
>
> **Slug:** `BITLY_UPDATE_GROUP_PREFERENCES`
>
> Update 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
>
> **group\_guid** `string` *required*
>
> GUID of the Bitly group whose preferences to update.
>
> **domain\_preference** `string`
>
> Preferred short domain for the group, such as bit.ly or a branded domain.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update QR Code
>
> **Slug:** `BITLY_UPDATE_QR_CODE`
>
> Update 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
>
> **tags** `array`
>
> Tags to add to the QR code.
>
> **title** `string`
>
> Updated QR code title.
>
> **archived** `boolean`
>
> Whether the QR code is archived (hidden from the UI).
>
> **qrcode\_id** `string` *required*
>
> ID of the QR code to update.
>
> **expiration\_at** `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.
>
> **dynamic\_routing** `array`
>
> Dynamic routing rules for this QR code. Replaces all existing rules; send an empty array to clear them.
>
> **render\_customizations** `object`
>
> QR appearance customizations; availability depends on the Bitly plan.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Site
>
> **Slug:** `BITLY_UPDATE_SITE`
>
> Update 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
>
> **uri** `string`
>
> New domain/m/keyword URI. Changing it creates a redirect from the previous URI.
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site to update.
>
> **qr\_code\_id** `string`
>
> QR code ID to attach. Only allowed if the site has no QR code attached yet.
>
> **description** `string`
>
> Description displayed on the site. An empty string clears the current description.
>
> **display\_name** `string`
>
> Name displayed on the site. An empty string clears the current name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Site Appearance
>
> **Slug:** `BITLY_UPDATE_SITE_APPEARANCE`
>
> Update 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
>
> **font** `string`
>
> Site font.
>
> **layout** `string`
>
> Site layout.
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site whose appearance to update.
>
> **theme\_id** `integer`
>
> Site theme identifier.
>
> **layout\_v2** `integer`
>
> Site layout version identifier.
>
> **text\_color** `string`
>
> Site text color.
>
> **hide\_bitly\_logo** `boolean`
>
> Whether to hide the Bitly logo.
>
> **avatar\_image\_url** `string`
>
> Avatar image URL.
>
> **background\_color** `string`
>
> Site background color.
>
> **style\_preference** `string ("custom" | "theme" | "image")`
>
> Site style source.
>
> **avatar\_image\_guid** `string`
>
> Avatar image GUID.
>
> **description\_color** `string`
>
> Site description color.
>
> **header\_appearance** `object`
>
> Header banner, profile image, and text appearance settings.
>
> **background\_image\_url** `string`
>
> Background image URL.
>
> **default\_button\_shape** `string`
>
> Default button shape.
>
> **background\_image\_guid** `string`
>
> Background image GUID.
>
> **background\_preference** `string`
>
> Site background preference.
>
> **default\_button\_shadow** `string`
>
> Default button shadow.
>
> **bottom\_background\_color** `string`
>
> Bottom background color.
>
> **default\_button\_text\_color** `string`
>
> Default button text color.
>
> **default\_social\_icon\_color** `string`
>
> Default social icon color.
>
> **background\_image\_alignment** `string ("stretch" | "fit" | "repeat")`
>
> Background image alignment.
>
> **default\_social\_icon\_layout** `string`
>
> Default social icon layout.
>
> **default\_social\_icon\_position** `string`
>
> Default social icon position.
>
> **default\_button\_background\_color** `string`
>
> Default button background color.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Site Block
>
> **Slug:** `BITLY_UPDATE_SITE_BLOCK`
>
> Update 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
>
> **parent** `string`
>
> Parent container block identifier.
>
> **content** `object`
>
> Content fields for the stored block's type: Bitlink, YouTube, social, image, digital business card, or text. The block type cannot be changed.
>
> **site\_id** `string` *required*
>
> GUID of the Bitly Site containing the block.
>
> **block\_id** `string` *required*
>
> GUID of the existing content block to update.
>
> **is\_active** `boolean`
>
> Whether the block is active.
>
> **is\_pinned** `boolean`
>
> Whether the block is pinned.
>
> **appearance** `object`
>
> Text block colors, alignment, font size, and styling.
>
> **schedule\_end** `string`
>
> Block schedule end time.
>
> **schedule\_start** `string`
>
> Block schedule start time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update User
>
> **Slug:** `BITLY_UPDATE_USER`
>
> Update 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
>
> **name** `string`
>
> New display name for the authenticated Bitly user.
>
> **default\_group\_guid** `string`
>
> GUID of the group to use as the authenticated user's default group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook
>
> **Slug:** `BITLY_UPDATE_WEBHOOK`
>
> Update 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
>
> **url** `string`
>
> Destination URL for webhook events.
>
> **guid** `string` *required*
>
> Webhook GUID required in the update body.
>
> **name** `string`
>
> New name for the webhook.
>
> **event** `string`
>
> Event that triggers the webhook.
>
> **client\_id** `string`
>
> Client ID for the webhook destination's OAuth authentication.
>
> **is\_active** `boolean`
>
> Whether the webhook is active.
>
> **oauth\_url** `string`
>
> OAuth URL used to authenticate webhook deliveries.
>
> **fetch\_tags** `boolean`
>
> Whether the webhook fetches tags.
>
> **group\_guid** `string`
>
> GUID of the group associated with the webhook.
>
> **webhook\_guid** `string` *required*
>
> GUID of the Bitly webhook to update.
>
> **organization\_guid** `string`
>
> GUID of the organization associated with the webhook.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upgrade QR Code to Bitlink
>
> **Slug:** `BITLY_UPGRADE_QR_CODE_TO_BITLINK`
>
> Upgrade 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
>
> **qrcode\_id** `string` *required*
>
> ID of the standalone QR code to associate with its underlying Bitlink.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verify Webhook
>
> **Slug:** `BITLY_VERIFY_WEBHOOK`
>
> Test 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
>
> **webhook\_guid** `string` *required*
>
> GUID of the Bitly webhook to verify.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
