Update Link - Bit2Connect API

PUT

1.0

links

:code

curl -X PUT "https://api.bit2connect.com/1.0/links/summer-sale" \
  -H "X-API-KEY: b2co_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Summer Sale Campaign",
    "payload": {
      "link": "https://yourapp.com/products/summer-sale-updated",
      "iosAppId": "550e8400-e29b-41d4-a716-446655440000",
      "androidAppId": "550e8400-e29b-41d4-a716-446655440001",
      "social": {
        "title": "Summer Sale - Now 60% Off!",
        "description": "Extended sale! Don'\''t miss out!",
        "image": "https://yourapp.com/images/summer-sale-v2.jpg"
      },
      "campaign": {
        "utm_source": "api",
        "utm_medium": "dynamic_link",
        "utm_campaign": "summer_sale_extended_2024"
      }
    }
  }'

const response = await fetch("https://api.bit2connect.com/1.0/links/summer-sale", {
  method: "PUT",
  headers: {
    "X-API-KEY": "b2co_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Updated Summer Sale Campaign",
    payload: {
      link: "https://yourapp.com/products/summer-sale-updated",
      iosAppId: "550e8400-e29b-41d4-a716-446655440000",
      androidAppId: "550e8400-e29b-41d4-a716-446655440001",
      social: {
        title: "Summer Sale - Now 60% Off!",
        description: "Extended sale! Don't miss out!",
        image: "https://yourapp.com/images/summer-sale-v2.jpg",
      },
      campaign: {
        utm_source: "api",
        utm_medium: "dynamic_link",
        utm_campaign: "summer_sale_extended_2024",
      },
    },
  }),
});

const data = await response.json();

import requests

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

payload = {
    "name": "Updated Summer Sale Campaign",
    "payload": {
        "link": "https://yourapp.com/products/summer-sale-updated",
        "iosAppId": "550e8400-e29b-41d4-a716-446655440000",
        "androidAppId": "550e8400-e29b-41d4-a716-446655440001",
        "social": {
            "title": "Summer Sale - Now 60% Off!",
            "description": "Extended sale! Don't miss out!",
            "image": "https://yourapp.com/images/summer-sale-v2.jpg"
        },
        "campaign": {
            "utm_source": "api",
            "utm_medium": "dynamic_link",
            "utm_campaign": "summer_sale_extended_2024"
        }
    }
}

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

{
  "success": true,
  "data": {
    "message": "Link updated successfully"
  }
}

{
  "success": false,
  "error": "Link not found"
}

{
  "success": false,
  "error": "Cannot edit an expired link"
}

Request

string

required

The unique code of the link to update

string

required

Your API key: b2co_your_api_key

string

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

object

required

Updated 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 new 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 new 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.

Cannot Update Code: The link code cannot be changed after creation. This is a permanent identifier for the link.

Expired Links: You cannot update a link that has already expired. Consider creating a new link instead.

Response

boolean

Indicates if the request was successful

object

The updated link confirmation

string

Success message confirming the update

curl -X PUT "https://api.bit2connect.com/1.0/links/summer-sale" \
  -H "X-API-KEY: b2co_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Summer Sale Campaign",
    "payload": {
      "link": "https://yourapp.com/products/summer-sale-updated",
      "iosAppId": "550e8400-e29b-41d4-a716-446655440000",
      "androidAppId": "550e8400-e29b-41d4-a716-446655440001",
      "social": {
        "title": "Summer Sale - Now 60% Off!",
        "description": "Extended sale! Don'\''t miss out!",
        "image": "https://yourapp.com/images/summer-sale-v2.jpg"
      },
      "campaign": {
        "utm_source": "api",
        "utm_medium": "dynamic_link",
        "utm_campaign": "summer_sale_extended_2024"
      }
    }
  }'

const response = await fetch("https://api.bit2connect.com/1.0/links/summer-sale", {
  method: "PUT",
  headers: {
    "X-API-KEY": "b2co_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Updated Summer Sale Campaign",
    payload: {
      link: "https://yourapp.com/products/summer-sale-updated",
      iosAppId: "550e8400-e29b-41d4-a716-446655440000",
      androidAppId: "550e8400-e29b-41d4-a716-446655440001",
      social: {
        title: "Summer Sale - Now 60% Off!",
        description: "Extended sale! Don't miss out!",
        image: "https://yourapp.com/images/summer-sale-v2.jpg",
      },
      campaign: {
        utm_source: "api",
        utm_medium: "dynamic_link",
        utm_campaign: "summer_sale_extended_2024",
      },
    },
  }),
});

const data = await response.json();

import requests

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

payload = {
    "name": "Updated Summer Sale Campaign",
    "payload": {
        "link": "https://yourapp.com/products/summer-sale-updated",
        "iosAppId": "550e8400-e29b-41d4-a716-446655440000",
        "androidAppId": "550e8400-e29b-41d4-a716-446655440001",
        "social": {
            "title": "Summer Sale - Now 60% Off!",
            "description": "Extended sale! Don't miss out!",
            "image": "https://yourapp.com/images/summer-sale-v2.jpg"
        },
        "campaign": {
            "utm_source": "api",
            "utm_medium": "dynamic_link",
            "utm_campaign": "summer_sale_extended_2024"
        }
    }
}

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

{
  "success": true,
  "data": {
    "message": "Link updated successfully"
  }
}

{
  "success": false,
  "error": "Link not found"
}

{
  "success": false,
  "error": "Cannot edit an expired link"
}

Common Use Cases

Updating Destination URL

Change where users are redirected:

{
  "payload": {
    "link": "https://yourapp.com/new-destination"
  }
}

Switching to Saved Mobile Apps

Replace manual configuration with saved apps:

{
  "payload": {
    "link": "https://yourapp.com/content",
    "iosAppId": "550e8400-e29b-41d4-a716-446655440000",
    "androidAppId": "550e8400-e29b-41d4-a716-446655440001"
  }
}

Update how the link appears when shared:

{
  "payload": {
    "link": "https://yourapp.com/content",
    "social": {
      "title": "New Promotional Title",
      "description": "Updated marketing message",
      "image": "https://yourapp.com/images/new-promo.jpg"
    }
  }
}

Updating Campaign Parameters

Change analytics tracking parameters:

{
  "payload": {
    "link": "https://yourapp.com/content",
    "campaign": {
      "utm_source": "newsletter",
      "utm_medium": "email",
      "utm_campaign": "winter_2024"
    }
  }
}

Update Link Status - Change link status (ACTIVE/PAUSED)
Get Link - Retrieve link details
Delete Link - Permanently remove a link

curl -X PUT "https://api.bit2connect.com/1.0/links/summer-sale" \
  -H "X-API-KEY: b2co_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Summer Sale Campaign",
    "payload": {
      "link": "https://yourapp.com/products/summer-sale-updated",
      "iosAppId": "550e8400-e29b-41d4-a716-446655440000",
      "androidAppId": "550e8400-e29b-41d4-a716-446655440001",
      "social": {
        "title": "Summer Sale - Now 60% Off!",
        "description": "Extended sale! Don'\''t miss out!",
        "image": "https://yourapp.com/images/summer-sale-v2.jpg"
      },
      "campaign": {
        "utm_source": "api",
        "utm_medium": "dynamic_link",
        "utm_campaign": "summer_sale_extended_2024"
      }
    }
  }'

const response = await fetch("https://api.bit2connect.com/1.0/links/summer-sale", {
  method: "PUT",
  headers: {
    "X-API-KEY": "b2co_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Updated Summer Sale Campaign",
    payload: {
      link: "https://yourapp.com/products/summer-sale-updated",
      iosAppId: "550e8400-e29b-41d4-a716-446655440000",
      androidAppId: "550e8400-e29b-41d4-a716-446655440001",
      social: {
        title: "Summer Sale - Now 60% Off!",
        description: "Extended sale! Don't miss out!",
        image: "https://yourapp.com/images/summer-sale-v2.jpg",
      },
      campaign: {
        utm_source: "api",
        utm_medium: "dynamic_link",
        utm_campaign: "summer_sale_extended_2024",
      },
    },
  }),
});

const data = await response.json();

import requests

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

payload = {
    "name": "Updated Summer Sale Campaign",
    "payload": {
        "link": "https://yourapp.com/products/summer-sale-updated",
        "iosAppId": "550e8400-e29b-41d4-a716-446655440000",
        "androidAppId": "550e8400-e29b-41d4-a716-446655440001",
        "social": {
            "title": "Summer Sale - Now 60% Off!",
            "description": "Extended sale! Don't miss out!",
            "image": "https://yourapp.com/images/summer-sale-v2.jpg"
        },
        "campaign": {
            "utm_source": "api",
            "utm_medium": "dynamic_link",
            "utm_campaign": "summer_sale_extended_2024"
        }
    }
}

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

{
  "success": true,
  "data": {
    "message": "Link updated successfully"
  }
}

{
  "success": false,
  "error": "Link not found"
}

{
  "success": false,
  "error": "Cannot edit an expired link"
}

​Request

​Response

​Common Use Cases

​Updating Destination URL

​Switching to Saved Mobile Apps

​Updating Social Preview

​Updating Campaign Parameters

​Related Endpoints

Request

Response

Common Use Cases

Updating Destination URL

Switching to Saved Mobile Apps

Updating Social Preview

Updating Campaign Parameters

Related Endpoints