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
| Parameter | Type | Required | Description |
|---|---|---|---|
| long_url | string | Yes | URL to shorten, with http:// or https://. |
| group_guid | string | No | Group 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. |
| domain | string | No | Domain of the short link: bit.ly by default, or one of the custom domains in the bsds of the group, from List groups. |
| keyword | string | No | Custom 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. |
| title | string | No | Title of the link in the Bitly app. |
| tags | array | No | Tags of the link. |
| expiration_at | string | No | When the link stops redirecting, like 2026-12-31T23:59:00+0000: at least 5 minutes from now and at most 1 year. |
| force_new_link | boolean | No | true 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
- List groupsGETLists the groups the account belongs to. Each group has the guid that the other tools ask for as group_guid and, in bsds, the custom domains the group can shorten links with.
- List BitlinksGETLists the Bitlinks of a group, with their id, link, long_url, title and tags. The response has links and pagination: pass pagination.search_after as search_after, with the same filters, to read the next page.
- Get BitlinkGETReturns a Bitlink: the short link, long_url, title, tags, archived, created_at and the custom back-halves it had.
- Update BitlinkPATCHUpdates a Bitlink and returns it. Fields left out keep their value. Changing long_url redirects the link and always counts toward the monthly link limit of the plan; plans without redirects answer 402 UPGRADE_REQUIRED.
- Get Bitlink clicksGETReturns the clicks of a Bitlink per unit of time, in link_clicks with date and clicks. unit and units set the window: unit day with units 30 is the 30 days up to unit_reference.
- Get Bitlink clicks summaryGETReturns the total clicks of a Bitlink in a window, in total_clicks. unit and units set the window: unit day with units 30 is the 30 days up to unit_reference.
- Get Bitlink clicks by countryGETReturns the clicks of a Bitlink per country in a window, in metrics with value (the country code) and clicks. unit and units set the window: unit day with units 30 is the 30 days up to unit_reference.
- Get Bitlink clicks by referrerGETReturns the clicks of a Bitlink per referrer in a window, in metrics with value (the referrer) and clicks. unit and units set the window: unit day with units 30 is the 30 days up to unit_reference.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
