How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitly Custom Bitlinks API

Create and update custom back-halves on existing Bitlinks and read clicks by destination for A/B rotations. 5 operation(s), extracted verbatim from the OpenAPI Bitly publishes at https://dev.bitly.com/v4/v4.json.

Bitly Custom Bitlinks API is one of 11 APIs that Bitly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Bitlinks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 5 operations across 4 paths, and defines 31 schemas. It is described by OpenAPI 3.0.0, at version 4.0.0.

Requests are made against a single base URL, https://api-ssl.bitly.com/v4.

5 operations 4 paths 31 schemas 3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.0
Base URL
https://api-ssl.bitly.com/v4
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Bitly Custom Bitlinks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Bitlinks 5

These endpoints are for updating custom Bitlinks only. Custom Bitlinks have both a BSD and a customized back-half (e.g., yourcompany.com/yourcampaign). If a link begins with the b…

POST
/custom_bitlinks
Add Custom Bitlink
addCustomBitlink body → 200400402403404409422429
PATCH
/custom_bitlinks/{custom_bitlink}
Update Custom Bitlink
updateCustomBitlink 1 param body → 200400402403404422429500
GET
/custom_bitlinks/{custom_bitlink}
Retrieve Custom Bitlink
getCustomBitlink 1 param → 200402403404410429500503
GET
/custom_bitlinks/{custom_bitlink}/clicks_by_destination
Get Metrics for a Custom Bitlink by Destination
getCustomBitlinkMetricsByDestination 4 params → 200402403404410429500503
GET
/custom_bitlinks/{custom_bitlink}/clicks
Get Clicks for a Custom Bitlink's Entire History
getClicksForCustomBitlink 4 params → 200400402403404410429500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are BitlinkUpdate (17 properties), CustomBitlinkHistory (10 properties), DeeplinkRule (10 properties), DynamicRoutingRule (9 properties). Each schema is shown below with its type and property counts.

AddCustomBitlink
object
2 properties
BadRequest
BADREQUEST
BaseMetrics
object
4 properties
BitlinkBody
object
BitlinkUpdate
object
17 properties
ClickMetric
object
2 properties
ClickMetrics
object
Clicks
object
4 properties
CustomBitlink
object
3 properties
CustomBitlinkHistory
object
10 properties
DeeplinkRule
object
10 properties
DynamicRoutingDeviceEnum
string
Device type values for use in dynamic routing rules (devicematch / deviceexclude)
DynamicRoutingPlatformEnum
string
Platform (OS) values for use in dynamic routing rules (osmatch / osexclude)
DynamicRoutingRule
object
A dynamic routing rule that redirects traffic to a different destination based on user attributes.
9 properties
Error
object
4 properties
FieldError
object
3 properties
Forbidden
FORBIDDEN
Gone
GONE
HasReferences
object
1 property
InstallPreference
string
InternalError
INTERNALERROR
LinkClicks
object
2 properties
MobileOS
string
MonthlyLimitExceeded
MONTHLYLIMITEXCEEDED
NotFound
NOTFOUND
SimplifiedError
object
3 properties
TemporarilyUnavailable
TEMPORARILYUNAVAILABLE
TimeUnit
string
the unit of time queried for (minute, hour, day, week, month)
UnprocessableEntity
UNPROCESSABLEENTITY
UpdateCustomBitlink
object
1 property
UpgradeRequired
UPGRADEREQUIRED

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitly-custom-bitlinks-api-openapi.yml Raw ↑

Other APIs Bitly publishes across the network.

Bitly BSDs API
Bitly Bitlinks API
Bitly Campaigns API
Bitly Groups API
Bitly OAuth Apps API
Bitly Organizations API
Bitly QR Codes API
Bitly User API
Bitly Webhooks API
Bitly MCP Server
Where this information came from

This is an independent, third-party profile of Bitly Custom Bitlinks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.