Skip to main content
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"
      }
    }
  }'

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

​
Request

​
code
string
required
The unique code of the link to update
​
X-API-KEY
string
required
Your API key: b2co_your_api_key
​
name
string
Optional display name for the link to help with organization and identification.
​
payload
object
required
Updated link configuration object containing destination URL and platform-specific settings.
​
payload.link
string
required
The destination URL where users will be redirected when they click the dynamic link.
​
payload.iosAppId
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.
​
payload.androidAppId
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.
​
payload.android
object
Android-specific configuration for deep linking and app store fallbacks.
​
payload.android.package
string
Android app package name (e.g., com.yourapp.android).
​
payload.android.store_fallback
string
Play Store URL to redirect Android users without the app.
​
payload.android.min_version
string
Minimum app version required to handle the deep link.
​
payload.android.saveApp
boolean
Whether to save this Android configuration as a new reusable mobile app.
​
payload.android.appName
string
Name for the saved mobile app (required if saveApp is true).
​
payload.ios
object
iOS-specific configuration for deep linking and App Store fallbacks.
​
payload.ios.bundleId
string
iOS app bundle identifier (e.g., com.yourapp.ios).
​
payload.ios.app_store_fallback
string
App Store URL to redirect iOS users without the app.
​
payload.ios.app_store_id
string
App Store ID for the iOS app.
​
payload.ios.min_version
string
Minimum app version required to handle the deep link.
​
payload.ios.saveApp
boolean
Whether to save this iOS configuration as a new reusable mobile app.
​
payload.ios.appName
string
Name for the saved mobile app (required if saveApp is true).
​
payload.social
object
Social media preview configuration for rich link sharing.
​
payload.social.title
string
Title displayed in social media previews.
​
payload.social.description
string
Description displayed in social media previews.
​
payload.social.image
string
Image URL displayed in social media previews.
​
payload.campaign
object
UTM campaign parameters for analytics tracking.
​
payload.campaign.utm_source
string
Campaign source parameter.
​
payload.campaign.utm_medium
string
Campaign medium parameter.
​
payload.campaign.utm_campaign
string
Campaign name parameter.
​
payload.campaign.utm_term
string
Campaign term parameter (for paid search keywords).
​
payload.campaign.utm_content
string
Campaign content parameter (for A/B testing and content-targeted ads).
​
payload.desktop_fallback
string
Fallback URL for desktop users.
​
expiresAt
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

​
success
boolean
Indicates if the request was successful
​
data
object
The updated link confirmation
​
data.message
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"
      }
    }
  }'

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

​
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"
  }
}

​
Updating Social Preview

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"
    }
  }
}