POST
/
link
/
create

Authorizations

Authorization
string
headerrequired

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

Body

application/json
long_url
string
required

The long URL that the shortened link will redirect to.

domain
string

The UUID of the domain where the link will be created.

favicon
string

URL of the favicon for the link.

title
string

Title of the link, up to 150 characters.

Maximum length: 150
custom_link
string

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

Required string length: 3 - 50
tags
string[]

Array of tags associated with the link.

has_utm
boolean

Indicates if UTM parameters are used.

utm_source
string

UTM source for tracking.

Maximum length: 200
utm_medium
string

UTM medium for tracking.

Maximum length: 200
utm_campaign
string

UTM campaign for tracking.

Maximum length: 200
utm_term
string

UTM term for paid search.

Maximum length: 200
utm_content
string

UTM content for differentiating ads.

Maximum length: 200
has_opengraph
boolean

Indicates if OpenGraph metadata is included.

meta_title
string

Meta title for the link, up to 150 characters.

Maximum length: 150
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.

has_android_targeting
boolean

Indicates if there is a target URL for Android.

android_target_url
string

Target URL for Android devices.

has_ios_targeting
boolean

Indicates if there is a target URL for iOS.

ios_target_url
string

Target URL for iOS devices.

has_windows_targeting
boolean

Indicates if there is a target URL for Windows.

windows_target_url
string

Target URL for Windows devices.

has_linux_targeting
boolean

Indicates if there is a target URL for Linux.

linux_target_url
string

Target URL for Linux devices.

has_geo_targeting
boolean

Indicates if geo-targeting is used.

geo_targets
object[]

Array of geo-targeting rules.

has_cloaking
boolean

Indicates if cloaking is enabled.

has_password
boolean

Indicates if a password is required to access the link.

password
string

Password required to access the link.

password_logo
string

URL of the logo to display on the password prompt.

has_expiration
boolean

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

expiration
string

Expiration date for the link in ISO 8601 format.

expiration_clicks
string

Maximum number of clicks before the link expires.

Response

201 - application/json
status
enum<string>
required

Indicates the status of the request.

Available options:
success
data
object
required

Was this page helpful?

ErrorsRetreive a Bitsy Link