Create Link

POST

1.0

links

curl -X POST "https://api.bit2connect.com/1.0/links" \
  -H "X-API-KEY: b2co_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "summer-sale",
    "name": "Summer Sale Campaign",
    "payload": {
      "link": "https://yourapp.com/products/summer-sale",
      "android": {
        "package": "com.yourapp.android",
        "store_fallback": "https://play.google.com/store/apps/details?id=com.yourapp.android"
      },
      "ios": {
        "bundleId": "com.yourapp.ios",
        "app_store_fallback": "https://apps.apple.com/app/yourapp/id123456789"
      },
      "social": {
        "title": "Summer Sale - Up to 50% Off!",
        "description": "Don'\''t miss our biggest sale of the year. Shop now!",
        "image": "https://yourapp.com/images/summer-sale.jpg"
      },
      "campaign": {
        "utm_source": "api",
        "utm_medium": "dynamic_link",
        "utm_campaign": "summer_sale_2024"
      }
    },
    "expiresAt": "2024-12-31T23:59:59Z"
  }'

const response = await fetch("https://api.bit2connect.com/1.0/links", {
  method: "POST",
  headers: {
    "X-API-KEY": "b2co_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    code: "summer-sale",
    name: "Summer Sale Campaign",
    payload: {
      link: "https://yourapp.com/products/summer-sale",
      android: {
        package: "com.yourapp.android",
        store_fallback:
          "https://play.google.com/store/apps/details?id=com.yourapp.android",
      },
      ios: {
        bundleId: "com.yourapp.ios",
        app_store_fallback: "https://apps.apple.com/app/yourapp/id123456789",
      },
      social: {
        title: "Summer Sale - Up to 50% Off!",
        description: "Don't miss our biggest sale of the year. Shop now!",
        image: "https://yourapp.com/images/summer-sale.jpg",
      },
      campaign: {
        utm_source: "api",
        utm_medium: "dynamic_link",
        utm_campaign: "summer_sale_2024",
      },
    },
    expiresAt: "2024-12-31T23:59:59Z",
  }),
});

const data = await response.json();

import requests

url = "https://api.bit2connect.com/1.0/links"
headers = {
    "X-API-KEY": "b2co_your_api_key",
    "Content-Type": "application/json"
}

payload = {
    "code": "summer-sale",
    "name": "Summer Sale Campaign",
    "payload": {
        "link": "https://yourapp.com/products/summer-sale",
        "android": {
            "package": "com.yourapp.android",
            "store_fallback": "https://play.google.com/store/apps/details?id=com.yourapp.android"
        },
        "ios": {
            "bundleId": "com.yourapp.ios",
            "app_store_fallback": "https://apps.apple.com/app/yourapp/id123456789"
        },
        "social": {
            "title": "Summer Sale - Up to 50% Off!",
            "description": "Don't miss our biggest sale of the year. Shop now!",
            "image": "https://yourapp.com/images/summer-sale.jpg"
        },
        "campaign": {
            "utm_source": "api",
            "utm_medium": "dynamic_link",
            "utm_campaign": "summer_sale_2024"
        }
    },
    "expiresAt": "2024-12-31T23:59:59Z"
}

response = requests.post(url, json=payload, headers=headers)
data = response.json()

{
  "success": true,
  "data": {
    "id": "clp123abc456",
    "code": "summer-sale",
    "shortUrl": "https://b2co.link/summer-sale",
    "originalUrl": "https://yourapp.com/products/summer-sale",
    "name": "Summer Sale Campaign",
    "status": "ACTIVE",
    "qrCode": "https://b2co.link/summer-sale/qr",
    "createdAt": "2024-01-15T10:30:00Z",
    "expiresAt": "2024-12-31T23:59:59Z",
    "clickCount": 0
  }
}

{
  "success": false,
  "error": {
    "code": "CODE_ALREADY_EXISTS",
    "message": "The specified code is already in use"
  }
}

Request

string

required

Your API key: b2co_your_api_key

string

Custom short code for the link. If not provided, a random code will be generated. Must be unique within your project and contain only alphanumeric characters, hyphens, and underscores (3-50 characters).

Link Codes are Unique: Each link code must be unique within your project. Use the Check Code Availability endpoint to verify if a code is available before creating a link.

string

Optional display name for the link to help with organization and identification.

object

required

Link configuration object containing destination URL and platform-specific settings.

string

required

The destination URL where users will be redirected when they click the dynamic link.

string

ID of a saved iOS mobile app to use for this link. When provided, the link will use the saved app’s configuration instead of manual iOS settings.

string

ID of a saved Android mobile app to use for this link. When provided, the link will use the saved app’s configuration instead of manual Android settings.

object

Android-specific configuration for deep linking and app store fallbacks.

string

Android app package name (e.g., com.yourapp.android).

string

Play Store URL to redirect Android users without the app.

string

Minimum app version required to handle the deep link.

boolean

Whether to save this Android configuration as a reusable mobile app.

string

Name for the saved mobile app (required if saveApp is true).

object

iOS-specific configuration for deep linking and App Store fallbacks.

string

iOS app bundle identifier (e.g., com.yourapp.ios).

string

App Store URL to redirect iOS users without the app.

string

App Store ID for the iOS app.

string

Minimum app version required to handle the deep link.

boolean

Whether to save this iOS configuration as a reusable mobile app.

string

Name for the saved mobile app (required if saveApp is true).

Social media preview configuration for rich link sharing.

Title displayed in social media previews.

Description displayed in social media previews.

Image URL displayed in social media previews.

object

UTM campaign parameters for analytics tracking.

string

Campaign source parameter.

string

Campaign medium parameter.

string

Campaign name parameter.

string

Campaign term parameter (for paid search keywords).

string

Campaign content parameter (for A/B testing and content-targeted ads).

string

Fallback URL for desktop users.

string

Optional expiration date in ISO 8601 format. Link will become inactive after this date.

Response

boolean

Indicates if the request was successful

object

The created link object

string

Unique identifier for the link

string

The unique short code for the link

string

The complete short URL that can be shared

string

The original destination URL

string

Display name of the link

string

Current status of the link (ACTIVE, PAUSED, etc.)

string

QR code URL for the link

string

ISO 8601 timestamp when the link was created

string

ISO 8601 timestamp when the link expires (if set)

number

Number of times the link has been clicked

curl -X POST "https://api.bit2connect.com/1.0/links" \
  -H "X-API-KEY: b2co_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "summer-sale",
    "name": "Summer Sale Campaign",
    "payload": {
      "link": "https://yourapp.com/products/summer-sale",
      "android": {
        "package": "com.yourapp.android",
        "store_fallback": "https://play.google.com/store/apps/details?id=com.yourapp.android"
      },
      "ios": {
        "bundleId": "com.yourapp.ios",
        "app_store_fallback": "https://apps.apple.com/app/yourapp/id123456789"
      },
      "social": {
        "title": "Summer Sale - Up to 50% Off!",
        "description": "Don'\''t miss our biggest sale of the year. Shop now!",
        "image": "https://yourapp.com/images/summer-sale.jpg"
      },
      "campaign": {
        "utm_source": "api",
        "utm_medium": "dynamic_link",
        "utm_campaign": "summer_sale_2024"
      }
    },
    "expiresAt": "2024-12-31T23:59:59Z"
  }'

const response = await fetch("https://api.bit2connect.com/1.0/links", {
  method: "POST",
  headers: {
    "X-API-KEY": "b2co_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    code: "summer-sale",
    name: "Summer Sale Campaign",
    payload: {
      link: "https://yourapp.com/products/summer-sale",
      android: {
        package: "com.yourapp.android",
        store_fallback:
          "https://play.google.com/store/apps/details?id=com.yourapp.android",
      },
      ios: {
        bundleId: "com.yourapp.ios",
        app_store_fallback: "https://apps.apple.com/app/yourapp/id123456789",
      },
      social: {
        title: "Summer Sale - Up to 50% Off!",
        description: "Don't miss our biggest sale of the year. Shop now!",
        image: "https://yourapp.com/images/summer-sale.jpg",
      },
      campaign: {
        utm_source: "api",
        utm_medium: "dynamic_link",
        utm_campaign: "summer_sale_2024",
      },
    },
    expiresAt: "2024-12-31T23:59:59Z",
  }),
});

const data = await response.json();

import requests

url = "https://api.bit2connect.com/1.0/links"
headers = {
    "X-API-KEY": "b2co_your_api_key",
    "Content-Type": "application/json"
}

payload = {
    "code": "summer-sale",
    "name": "Summer Sale Campaign",
    "payload": {
        "link": "https://yourapp.com/products/summer-sale",
        "android": {
            "package": "com.yourapp.android",
            "store_fallback": "https://play.google.com/store/apps/details?id=com.yourapp.android"
        },
        "ios": {
            "bundleId": "com.yourapp.ios",
            "app_store_fallback": "https://apps.apple.com/app/yourapp/id123456789"
        },
        "social": {
            "title": "Summer Sale - Up to 50% Off!",
            "description": "Don't miss our biggest sale of the year. Shop now!",
            "image": "https://yourapp.com/images/summer-sale.jpg"
        },
        "campaign": {
            "utm_source": "api",
            "utm_medium": "dynamic_link",
            "utm_campaign": "summer_sale_2024"
        }
    },
    "expiresAt": "2024-12-31T23:59:59Z"
}

response = requests.post(url, json=payload, headers=headers)
data = response.json()

{
  "success": true,
  "data": {
    "id": "clp123abc456",
    "code": "summer-sale",
    "shortUrl": "https://b2co.link/summer-sale",
    "originalUrl": "https://yourapp.com/products/summer-sale",
    "name": "Summer Sale Campaign",
    "status": "ACTIVE",
    "qrCode": "https://b2co.link/summer-sale/qr",
    "createdAt": "2024-01-15T10:30:00Z",
    "expiresAt": "2024-12-31T23:59:59Z",
    "clickCount": 0
  }
}

{
  "success": false,
  "error": {
    "code": "CODE_ALREADY_EXISTS",
    "message": "The specified code is already in use"
  }
}

Error Codes

string

Invalid request payload or parameters

string

The specified code is already in use

string

API key is missing or invalid

string

Too many requests, please try again later

string

Active subscription required to create links

Check Code AvailabilityCheck if a custom code is available for use before creating a link

curl -X POST "https://api.bit2connect.com/1.0/links" \
  -H "X-API-KEY: b2co_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "summer-sale",
    "name": "Summer Sale Campaign",
    "payload": {
      "link": "https://yourapp.com/products/summer-sale",
      "android": {
        "package": "com.yourapp.android",
        "store_fallback": "https://play.google.com/store/apps/details?id=com.yourapp.android"
      },
      "ios": {
        "bundleId": "com.yourapp.ios",
        "app_store_fallback": "https://apps.apple.com/app/yourapp/id123456789"
      },
      "social": {
        "title": "Summer Sale - Up to 50% Off!",
        "description": "Don'\''t miss our biggest sale of the year. Shop now!",
        "image": "https://yourapp.com/images/summer-sale.jpg"
      },
      "campaign": {
        "utm_source": "api",
        "utm_medium": "dynamic_link",
        "utm_campaign": "summer_sale_2024"
      }
    },
    "expiresAt": "2024-12-31T23:59:59Z"
  }'

const response = await fetch("https://api.bit2connect.com/1.0/links", {
  method: "POST",
  headers: {
    "X-API-KEY": "b2co_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    code: "summer-sale",
    name: "Summer Sale Campaign",
    payload: {
      link: "https://yourapp.com/products/summer-sale",
      android: {
        package: "com.yourapp.android",
        store_fallback:
          "https://play.google.com/store/apps/details?id=com.yourapp.android",
      },
      ios: {
        bundleId: "com.yourapp.ios",
        app_store_fallback: "https://apps.apple.com/app/yourapp/id123456789",
      },
      social: {
        title: "Summer Sale - Up to 50% Off!",
        description: "Don't miss our biggest sale of the year. Shop now!",
        image: "https://yourapp.com/images/summer-sale.jpg",
      },
      campaign: {
        utm_source: "api",
        utm_medium: "dynamic_link",
        utm_campaign: "summer_sale_2024",
      },
    },
    expiresAt: "2024-12-31T23:59:59Z",
  }),
});

const data = await response.json();

import requests

url = "https://api.bit2connect.com/1.0/links"
headers = {
    "X-API-KEY": "b2co_your_api_key",
    "Content-Type": "application/json"
}

payload = {
    "code": "summer-sale",
    "name": "Summer Sale Campaign",
    "payload": {
        "link": "https://yourapp.com/products/summer-sale",
        "android": {
            "package": "com.yourapp.android",
            "store_fallback": "https://play.google.com/store/apps/details?id=com.yourapp.android"
        },
        "ios": {
            "bundleId": "com.yourapp.ios",
            "app_store_fallback": "https://apps.apple.com/app/yourapp/id123456789"
        },
        "social": {
            "title": "Summer Sale - Up to 50% Off!",
            "description": "Don't miss our biggest sale of the year. Shop now!",
            "image": "https://yourapp.com/images/summer-sale.jpg"
        },
        "campaign": {
            "utm_source": "api",
            "utm_medium": "dynamic_link",
            "utm_campaign": "summer_sale_2024"
        }
    },
    "expiresAt": "2024-12-31T23:59:59Z"
}

response = requests.post(url, json=payload, headers=headers)
data = response.json()

{
  "success": true,
  "data": {
    "id": "clp123abc456",
    "code": "summer-sale",
    "shortUrl": "https://b2co.link/summer-sale",
    "originalUrl": "https://yourapp.com/products/summer-sale",
    "name": "Summer Sale Campaign",
    "status": "ACTIVE",
    "qrCode": "https://b2co.link/summer-sale/qr",
    "createdAt": "2024-01-15T10:30:00Z",
    "expiresAt": "2024-12-31T23:59:59Z",
    "clickCount": 0
  }
}

{
  "success": false,
  "error": {
    "code": "CODE_ALREADY_EXISTS",
    "message": "The specified code is already in use"
  }
}

Links

Mobile Apps

Request

Response

Error Codes

​Request

​Response

​Error Codes

Request

Response

Error Codes