PUT
/
link
/
update

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
id
string
required

The unique identifier for the Bitsy Link to be updated.

android_target_url
string

Target URL for Android devices.

Custom slug for the link, between 3 and 50 characters.

Required string length: 3 - 50
expiration
string

Expiration date for the link in ISO 8601 format.

expiration_clicks
string

Maximum number of clicks before the link expires.

favicon
string

URL of the favicon for the link.

geo_targets
object[]

Array of geo-targeting rules.

has_android_targeting
boolean

Indicates if there is a target URL for Android.

has_cloaking
boolean

Indicates if cloaking is enabled.

has_expiration
boolean

Indicates if the link has an expiration date or expiration clicks.

has_geo_targeting
boolean

Indicates if geo-targeting is used.

has_ios_targeting
boolean

Indicates if there is a target URL for iOS.

has_linux_targeting
boolean

Indicates if there is a target URL for Linux.

has_opengraph
boolean

Indicates if OpenGraph metadata is included.

has_password
boolean

Indicates if a password is required to access the link.

has_utm
boolean

Indicates if UTM parameters are used.

has_windows_targeting
boolean

Indicates if there is a target URL for Windows.

ios_target_url
string

Target URL for iOS devices.

linux_target_url
string

Target URL for Linux devices.

meta_description
string

Meta description for the link, up to 250 characters.

Maximum length: 250
meta_image
string

URL of the image to use for the link's metadata.

meta_title
string

Meta title for the link, up to 150 characters.

Maximum length: 150
password
string

Password required to access the link.

URL of the logo to display on the password prompt.

tags
string[]

Array of tags associated with the link.

title
string

Title of the link, up to 150 characters.

Maximum length: 150
utm_campaign
string

UTM campaign for tracking.

Maximum length: 200
utm_content
string

UTM content for differentiating ads.

Maximum length: 200
utm_medium
string

UTM medium for tracking.

Maximum length: 200
utm_source
string

UTM source for tracking.

Maximum length: 200
utm_term
string

UTM term for paid search.

Maximum length: 200
windows_target_url
string

Target URL for Windows devices.

Response

200 - application/json
message
string
required

A message providing additional details about the request.

status
enum<string>
required

Indicates the status of the request.

Available options:
success