POST /bitlinks
Converts a long url to a Bitlink and sets additional parameters. You may see errors returned from this endpoint - "BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED" occurs if you have shortened more links than your account is configured for for the month, and "DNS_CONFIGURATION_ERROR" occurs if you are attempting to shorten links against a custom domain which doesn't have DNS properly configured.
Servers
- https://api-ssl.bitly.com/v4
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
long_url |
String | No |
URL to be shortened. Required when creating new bitlinks. Cannot be used with bitlink_id. |
group_guid |
String | No |
Always include a specific group and custom domain in your shorten calls. |
expiration_at |
String | No |
Optional expiration timestamp for the bitlink (e.g., 2025-01-28T14:30:00+0000). Minimum expiration time is 5 minutes from now and maximum is 1 year. |
tags[] |
Array | No | |
title |
String | No | |
domain |
String | No |
Default value: "bit.ly" |
deeplinks[] |
Array | No | |
deeplinks[].install_type |
String | No |
Valid values:
|
deeplinks[].install_url |
String | No | |
deeplinks[].app_id |
String | No | |
deeplinks[].app_uri_path |
String | No | |
keyword |
String | No |
Custom keyword for creating keyword overrides. If provided, creates an override at domain/keyword |
force_new_link |
Boolean | No | |
bitlink_id |
String | No |
Existing bitlink ID to add a keyword override to. Format: domain/hash. Cannot be used with long_url |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.