Update Bitlink with the Bitly API

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

Identifier
bitly_update_bitlink

The request

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

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

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
bitlinkstringYesThe id of the link, from List Bitlinks or Create Bitlink: the domain and the back-half without https://, like bit.ly/3AbCdEf.
titlestringNoNew title of the link.
tagsarrayNoTags of the link. The list replaces the current tags.
archivedbooleanNotrue archives the link, which hides it from the active links; false brings it back.
long_urlstringNoNew destination of the link, with http:// or https://.
expiration_atstringNoWhen the link stops redirecting, like 2026-12-31T23:59:00+0000: at least 5 minutes from now and at most 1 year.

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