Create Bitlink with the Bitly API

Shortens a long URL into a new Bitlink and returns it, with the short link in link and its id in id. It counts toward the monthly link limit of the plan, and features the plan lacks, like a custom back-half, answer 402 UPGRADE_REQUIRED.

Identifier
bitly_create_bitlink

The request

POST https://connect.reportei.com/api/tools/bitly_create_bitlink/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "long_url": "<long_url>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
long_urlstringYesURL to shorten, with http:// or https://.
group_guidstringNoGroup that owns the link, from List groups. Bitly asks to always send it; without it the link goes to the default group of the account.
domainstringNoDomain of the short link: bit.ly by default, or one of the custom domains in the bsds of the group, from List groups.
keywordstringNoCustom back-half, so the link becomes the domain and this keyword, like bit.ly/summer-sale. It counts toward the custom back-half limit of the plan.
titlestringNoTitle of the link in the Bitly app.
tagsarrayNoTags of the link.
expiration_atstringNoWhen the link stops redirecting, like 2026-12-31T23:59:00+0000: at least 5 minutes from now and at most 1 year.
force_new_linkbooleanNotrue creates a new link even when this long URL was already shortened in the group.

Supported connections

Your customer connects their Bitly account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/bitly, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/bitly_create_bitlink. It becomes your agent's tool definition with no conversion.

Other Bitly tools

See all 11 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.