Bitly

Bitly Campaigns API

Manage marketing campaigns and the channels inside them, grouping Bitlinks for attribution. 8 operation(s), extracted verbatim from the OpenAPI Bitly publishes at https://dev.bitly.com/v4/v4.json.

GitHub OpenAPI
Business capability
Marketing Management BC-400

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /campaigns List campaigns · Retrieve Campaigns #
Ask an LLM
“What marketing campaigns have I set up in Bitly?”
“Can I list only the campaigns that belong to one group?”
Tell an agent
List all my campaigns.
Show the campaigns in group {group_guid}.
POST /campaigns Create a campaign · Create Campaign #
Ask an LLM
“How do I create a campaign to organize links across channels?”
“Can I attach existing channels when I create a new campaign?”
Tell an agent
Create a campaign called {name} in group {group_guid}.
Start a new campaign {name} described as {description} using channels {channel_guids}.
GET /campaigns/{campaign_guid} Get a campaign's details · Retrieve a Campaign #
Ask an LLM
“Which channels are part of a specific campaign?”
“How do I look up one campaign by its GUID?”
Tell an agent
Show campaign {campaign_guid}.
Get the name, description and channels of campaign {campaign_guid}.
PATCH /campaigns/{campaign_guid} Update a campaign · Update Campaign #
Ask an LLM
“Can I rename an existing campaign?”
“How do I change which channels an existing campaign includes?”
Tell an agent
Rename campaign {campaign_guid} to {name}.
Set the channels on campaign {campaign_guid} to {channel_guids}.
GET /channels List channels · Retrieve Channels #
Ask an LLM
“What channels can I assign my links to?”
“Which channels belong to a particular campaign?”
Tell an agent
List my channels.
Show the channels in campaign {campaign_guid}.
POST /channels Create a channel · Create Channel #
Ask an LLM
“How do I add a new channel like email or social to group my links?”
“Can I put specific Bitlinks into a channel when I create it?”
Tell an agent
Create a channel named {name} in group {group_guid}.
Create a new channel {name} containing the links {bitlinks}.
GET /channels/{channel_guid} Get a channel's details · Get a Channel #
Ask an LLM
“Which Bitlinks are in a specific channel?”
“What group does a given channel belong to?”
Tell an agent
Show channel {channel_guid}.
List the links inside channel {channel_guid}.
PATCH /channels/{channel_guid} Update a channel · Update a Channel #
Ask an LLM
“Can I rename a channel I already created?”
“How do I change which links an existing channel contains?”
Tell an agent
Rename channel {channel_guid} to {name}.
Replace the links in channel {channel_guid} with {bitlinks}.

Documentation

📖
Documentation
https://dev.bitly.com/api-reference
📖
APIReference
https://dev.bitly.com/api-reference
📖
GettingStarted
https://dev.bitly.com/docs/getting-started/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/openapi/bitly-campaigns-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/collections/bitly-campaigns-api.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/collections/bitly-campaigns-api.opencollection.json
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/overlays/bitly-campaigns-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bitly:bitly-campaigns-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bitly-campaigns-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 4.0.0
  title: Bitly Campaigns API
  termsOfService: https://bitly.com/pages/terms-of-service
  contact:
    url: https://bitly.is/API-support
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: /v4/header-logo.png
  description: Bitly Campaigns are used to build and organize links and metrics for marketing campaigns.
servers:
- url: https://api-ssl.bitly.com/v4
security:
- bearerAuth: []
tags:
- name: Campaigns
  description: Bitly Campaigns are used to build and organize links and metrics for marketing campaigns.
paths:
  /campaigns:
    get:
      summary: Retrieve Campaigns
      description: Returns the campaigns for the current authenticated user.
      operationId: getCampaigns
      tags:
      - Campaigns
      parameters:
      - $ref: '#/components/parameters/GroupGUIDFilter'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaigns'
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '502':
          description: BAD_GATEWAY
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGateway'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
    post:
      summary: Create Campaign
      description: Creates a new campaign.
      operationId: createCampaign
      tags:
      - Campaigns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignModify'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '422':
          description: UNPROCESSABLE_ENTITY
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntity'
        '429':
          description: MONTHLY_LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyLimitExceeded'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
  /campaigns/{campaign_guid}:
    get:
      summary: Retrieve a Campaign
      description: Returns details for a campaign.
      operationId: getCampaign
      tags:
      - Campaigns
      parameters:
      - $ref: '#/components/parameters/CampaignGUID'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '429':
          description: MONTHLY_LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyLimitExceeded'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
    patch:
      summary: Update Campaign
      description: Updates a campaign's details.
      operationId: updateCampaign
      tags:
      - Campaigns
      parameters:
      - $ref: '#/components/parameters/CampaignGUID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignModify'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '422':
          description: UNPROCESSABLE_ENTITY
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntity'
        '429':
          description: MONTHLY_LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyLimitExceeded'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
  /channels:
    get:
      summary: Retrieve Channels
      description: Returns the channels available to a user.
      operationId: getChannels
      tags:
      - Campaigns
      parameters:
      - $ref: '#/components/parameters/GroupGUIDFilter'
      - $ref: '#/components/parameters/CampaignGUIDFilter'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channels'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
    post:
      summary: Create Channel
      description: Creates a new channel.
      operationId: createChannel
      tags:
      - Campaigns
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelModify'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '422':
          description: UNPROCESSABLE_ENTITY
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntity'
        '429':
          description: MONTHLY_LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyLimitExceeded'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
  /channels/{channel_guid}:
    get:
      summary: Get a Channel
      description: Returns a channel's details.
      operationId: getChannel
      tags:
      - Campaigns
      parameters:
      - $ref: '#/components/parameters/ChannelGUID'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '429':
          description: MONTHLY_LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyLimitExceeded'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
    patch:
      summary: Update a Channel
      description: Updates an existing channel.
      operationId: updateChannel
      tags:
      - Campaigns
      parameters:
      - $ref: '#/components/parameters/ChannelGUID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelModify'
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '422':
          description: UNPROCESSABLE_ENTITY
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntity'
        '429':
          description: MONTHLY_LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyLimitExceeded'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
components:
  schemas:
    CampaignModify:
      type: object
      properties:
        group_guid:
          type: string
        name:
          type: string
        description:
          type: string
        channel_guids:
          type: array
          items:
            type: string
      example:
        group_guid: Ba1bc23dE4F
        name: My Campaign
        description: my new campaign
        channel_guids:
        - Ha1bc2DefGj
        - Ha1bc2DefGk
    UnprocessableEntity:
      description: UNPROCESSABLE_ENTITY
      allOf:
      - $ref: '#/components/schemas/Error'
    BaseChannel:
      type: object
      properties:
        name:
          type: string
        guid:
          type: string
        created:
          type: string
          description: ISO TIMESTAMP
        modified:
          type: string
          description: ISO_TIMESTAMP
        group_guid:
          type: string
    InternalError:
      description: INTERNAL_ERROR
      allOf:
      - $ref: '#/components/schemas/Error'
    Error:
      type: object
      properties:
        message:
          type: string
        description:
          type: string
        resource:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
    Forbidden:
      description: FORBIDDEN
      allOf:
      - $ref: '#/components/schemas/Error'
    SimplifiedError:
      type: object
      properties:
        message:
          type: string
        description:
          type: string
        resource:
          type: string
    BadRequest:
      description: BAD_REQUEST
      allOf:
      - $ref: '#/components/schemas/Error'
    NotFound:
      description: NOT_FOUND
      allOf:
      - $ref: '#/components/schemas/Error'
    UpgradeRequired:
      description: UPGRADE_REQUIRED
      allOf:
      - $ref: '#/components/schemas/Error'
    Channels:
      type: object
      properties:
        channels:
          type: array
          items:
            $ref: '#/components/schemas/Channel'
    FieldError:
      type: object
      properties:
        field:
          type: string
        error_code:
          type: string
        message:
          type: string
    Campaign:
      type: object
      allOf:
      - $ref: '#/components/schemas/HasReferences'
      - properties:
          guid:
            type: string
          group_guid:
            type: string
          created_by:
            type: string
          name:
            type: string
          description:
            type: string
          created:
            type: string
            description: ISO timestamp
          modified:
            type: string
            description: ISO timestamp
    TemporarilyUnavailable:
      description: TEMPORARILY_UNAVAILABLE
      allOf:
      - $ref: '#/components/schemas/Error'
    MonthlyLimitExceeded:
      description: MONTHLY_LIMIT_EXCEEDED
      allOf:
      - $ref: '#/components/schemas/SimplifiedError'
      example:
        message: API_USAGE_LIMIT_EXCEEDED
    Channel:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseChannel'
      - $ref: '#/components/schemas/HasReferences'
    HasReferences:
      type: object
      properties:
        references:
          type: object
          additionalProperties:
            type: string
    BaseChannelBitlink:
      type: object
      properties:
        campaign_guid:
          type: string
        bitlink_id:
          type: string
    Campaigns:
      type: object
      properties:
        campaigns:
          type: array
          items:
            $ref: '#/components/schemas/Campaign'
    ChannelModify:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseChannel'
      - properties:
          bitlinks:
            type: array
            items:
              $ref: '#/components/schemas/BaseChannelBitlink'
      example:
        name: My Channel
        guid: Ha1bc2DefGh
        group_guid: Ba1bc23dE4F
        bitlinks:
        - campaign_guid: Ca1bcd2EFGh
          bitlink_id: bit.ly/1234abcd
    BadGateway:
      description: BAD_GATEWAY
      allOf:
      - $ref: '#/components/schemas/Error'
  parameters:
    ChannelGUID:
      name: channel_guid
      description: A GUID for a Bitly Channel
      in: path
      required: true
      schema:
        type: string
      example: Ha1bc2DefGh
    GroupGUIDFilter:
      name: group_guid
      description: A GUID for a Bitly group
      in: query
      schema:
        type: string
      example: Ba1bc23dE4F
    CampaignGUID:
      name: campaign_guid
      description: A GUID for a Bitly campaign
      in: path
      required: true
      schema:
        type: string
      example: Ca1bcd2EFGh
    CampaignGUIDFilter:
      name: campaign_guid
      description: A GUID for a Bitly campaign
      in: query
      schema:
        type: string
      example: Ca1bcd2EFGh
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer