Create a link

curl --request POST \
  --url https://biq.li/api/v1/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "long_url": "https://example.com/product"
}
'

{
  "link": {
    "id": "<string>",
    "external_id": "<string>",
    "short_url": "<string>",
    "long_url": "<string>",
    "name": "<string>",
    "domain_id": "<string>",
    "alias": "<string>",
    "active": true,
    "has_password": true,
    "activates_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "exp_clicks_rule": {
      "key": 2,
      "value": "<string>"
    },
    "utm": "<string>",
    "geo_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "device_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "platform_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "folder_ids": [
      "<string>"
    ],
    "pixel_ids": [
      "<string>"
    ],
    "tag_ids": [
      "<string>"
    ],
    "conversion_tracking_enabled": true,
    "allow_search_engine_indexing": true,
    "proxy": true,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "qr_code": {
      "url": "<string>",
      "format": "svg",
      "logo": "app"
    },
    "clicks_count": 1,
    "leads_count": 1,
    "sales_count": 1,
    "revenue": 1,
    "revenue_currency": "USD",
    "clicked_at": "2023-11-07T05:31:56Z",
    "safety_status": "clear",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "success"
}

{
  "link": {
    "id": "<string>",
    "external_id": "<string>",
    "short_url": "<string>",
    "long_url": "<string>",
    "name": "<string>",
    "domain_id": "<string>",
    "alias": "<string>",
    "active": true,
    "has_password": true,
    "activates_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "exp_clicks_rule": {
      "key": 2,
      "value": "<string>"
    },
    "utm": "<string>",
    "geo_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "device_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "platform_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "folder_ids": [
      "<string>"
    ],
    "pixel_ids": [
      "<string>"
    ],
    "tag_ids": [
      "<string>"
    ],
    "conversion_tracking_enabled": true,
    "allow_search_engine_indexing": true,
    "proxy": true,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "qr_code": {
      "url": "<string>",
      "format": "svg",
      "logo": "app"
    },
    "clicks_count": 1,
    "leads_count": 1,
    "sales_count": 1,
    "revenue": 1,
    "revenue_currency": "USD",
    "clicked_at": "2023-11-07T05:31:56Z",
    "safety_status": "clear",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "pending",
  "message": "The link was created and is pending a safety check."
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

POST

link

curl --request POST \
  --url https://biq.li/api/v1/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "long_url": "https://example.com/product"
}
'

{
  "link": {
    "id": "<string>",
    "external_id": "<string>",
    "short_url": "<string>",
    "long_url": "<string>",
    "name": "<string>",
    "domain_id": "<string>",
    "alias": "<string>",
    "active": true,
    "has_password": true,
    "activates_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "exp_clicks_rule": {
      "key": 2,
      "value": "<string>"
    },
    "utm": "<string>",
    "geo_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "device_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "platform_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "folder_ids": [
      "<string>"
    ],
    "pixel_ids": [
      "<string>"
    ],
    "tag_ids": [
      "<string>"
    ],
    "conversion_tracking_enabled": true,
    "allow_search_engine_indexing": true,
    "proxy": true,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "qr_code": {
      "url": "<string>",
      "format": "svg",
      "logo": "app"
    },
    "clicks_count": 1,
    "leads_count": 1,
    "sales_count": 1,
    "revenue": 1,
    "revenue_currency": "USD",
    "clicked_at": "2023-11-07T05:31:56Z",
    "safety_status": "clear",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "success"
}

{
  "link": {
    "id": "<string>",
    "external_id": "<string>",
    "short_url": "<string>",
    "long_url": "<string>",
    "name": "<string>",
    "domain_id": "<string>",
    "alias": "<string>",
    "active": true,
    "has_password": true,
    "activates_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "exp_clicks_rule": {
      "key": 2,
      "value": "<string>"
    },
    "utm": "<string>",
    "geo_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "device_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "platform_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "folder_ids": [
      "<string>"
    ],
    "pixel_ids": [
      "<string>"
    ],
    "tag_ids": [
      "<string>"
    ],
    "conversion_tracking_enabled": true,
    "allow_search_engine_indexing": true,
    "proxy": true,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "qr_code": {
      "url": "<string>",
      "format": "svg",
      "logo": "app"
    },
    "clicks_count": 1,
    "leads_count": 1,
    "sales_count": 1,
    "revenue": 1,
    "revenue_currency": "USD",
    "clicked_at": "2023-11-07T05:31:56Z",
    "safety_status": "clear",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "pending",
  "message": "The link was created and is pending a safety check."
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Create one short link in the workspace bound to your API key. Only long_url is required.

You do not send a workspace ID. A biqli_ API key belongs to exactly one workspace, and every resource created or attached by this request is scoped to that workspace.

Authentication and permissions

Send your workspace API key as a Bearer token:

Authorization: Bearer biqli_your_workspace_api_key
Content-Type: application/json
Accept: application/json

The key always needs Links: Write (links.create). If you attach existing workspace resources, it also needs the matching read permission.

Request field	Additional API key permission
`domain_id`	Custom domains: Read (`custom_domains.view`)
`folder_ids`	Folders: Read (`link_groups.view`)
`pixel_ids`	Tracking pixels: Read (`tracking_pixels.view`)
`tag_ids`	Tags: Read (`tags.view`)

Creating a QR code attached to the new link only needs Links: Write. It does not need a standalone QR code permission and does not consume standalone QR code quota. The user who created the key must still have access to the workspace and be allowed to create links there. Revoking the key or removing that workspace access immediately prevents new requests.

Minimal request

curl --request POST \
  --url https://biq.li/api/v1/link \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "long_url": "https://example.com/product"
  }'

Biqli normalizes a destination without a scheme to HTTPS. For example, example.com/product becomes https://example.com/product.

Link identity and destination

Field	Type	Behavior
`long_url`	string, required	Primary destination. Maximum 1,000 characters by default.
`name`	string or null	Internal link name. Maximum 150 characters.
`external_id`	string or null	Your identifier for this link. Maximum 255 characters and unique within the workspace.
`domain_id`	string or null	Public custom domain ID such as `biq_dom_...`. Omit it to use the default Biqli domain.
`alias`	string or null	Custom short-link alias. Workspace alias character, minimum, maximum, reserved-word, and blacklist rules apply.
`active`	boolean	Whether the link can redirect. Defaults to `true`. A pending or quarantined safety state still blocks redirects.

Custom aliases are unique per domain across short links, folders, and bio pages. A duplicate alias returns 409 alias_taken and does not create a link. An external_id is unique within the API key’s workspace. A duplicate returns 409 external_id_taken.

{
  "long_url": "https://example.com/product",
  "name": "Summer campaign",
  "external_id": "campaign-link-1842",
  "domain_id": "biq_dom_01M14C6KQ6SG2GKMCV7HQ9A1QT",
  "alias": "summer-product",
  "active": true
}

Access and expiration

Field	Type	Behavior
`password`	string or null	Password visitors must enter before redirecting. Maximum 250 characters. The response never returns the password.
`activates_at`	ISO 8601 date-time or null	Date and time when the link becomes active.
`expires_at`	ISO 8601 date-time or null	Future expiration date and time. It must be later than `activates_at`.
`exp_clicks_rule.key`	integer	Number of clicks after which the link expires. Minimum `1`.
`exp_clicks_rule.value`	string or null	Optional destination used after the click threshold is reached.

{
  "long_url": "https://example.com/launch",
  "password": "launch-2026",
  "activates_at": "2026-09-01T08:00:00Z",
  "expires_at": "2026-10-01T08:00:00Z",
  "exp_clicks_rule": {
    "key": 1000,
    "value": "https://example.com/campaign-ended"
  }
}

UTM parameters

Use utm for an ampersand-separated query string without a leading ?. Biqli prefixes keys with utm_ when the prefix is missing, then appends the parameters to the destination without replacing its existing query string.

{
  "long_url": "https://example.com/product?variant=blue",
  "utm": "source=newsletter&medium=email&utm_campaign=summer"
}

The redirect destination becomes:

https://example.com/product?variant=blue&utm_source=newsletter&utm_medium=email&utm_campaign=summer

Dynamic routing

Use targeting rules to override the destination for matching visitors. Each rule has a key and destination value. Biqli uses the first matching rule.

Field	Match value
`geo_rules`	Lowercase ISO 3166-1 alpha-2 country code, such as `us` or `ma`.
`device_rules`	`desktop`, `mobile`, or `tablet`.
`platform_rules`	Normalized platform such as `ios`, `androidos`, `windows`, `os x`, `chromeos`, or `linux`.

Each list accepts up to 100 rules. Rule keys are limited to 250 characters and destinations to 1,000 characters.

{
  "long_url": "https://example.com/product",
  "geo_rules": [
    {
      "key": "us",
      "value": "https://example.com/us/product"
    },
    {
      "key": "ma",
      "value": "https://example.com/ma/product"
    }
  ],
  "device_rules": [
    {
      "key": "mobile",
      "value": "https://m.example.com/product"
    }
  ],
  "platform_rules": [
    {
      "key": "ios",
      "value": "https://apps.apple.com/app/example"
    }
  ]
}

All rule destinations, including the click-expiration destination, pass through the same URL validation and safety flow as long_url.

Attach workspace resources

Pass public IDs to attach resources that already exist in the key’s workspace. Internal numeric database IDs are not accepted.

{
  "long_url": "https://example.com/product",
  "folder_ids": [
    "biq_fld_01M14C93RJD7W46PFJX9B1TVYH"
  ],
  "pixel_ids": [
    "biq_pxl_01M14CBJNRXPW4Y22ZTA7F9W3J"
  ],
  "tag_ids": [
    "biq_tag_01M14CC1TW7AQ6DWZG9TMRH0PQ"
  ]
}

Resource	Public ID prefix
Link	`biq_lnk_`
Workspace	`biq_ws_`
Custom domain	`biq_dom_`
Folder	`biq_fld_`
Bio page	`biq_bio_`
Tracking pixel	`biq_pxl_`
Tag	`biq_tag_`
Standalone QR code	`biq_qr_`

If any supplied ID is malformed or uses the wrong resource prefix, validation returns 422. If it is valid but missing or belongs to another workspace, the API returns 404 resource_not_found. This prevents cross-workspace resource disclosure.

Conversion tracking and indexing

Set conversion_tracking_enabled to append a Biqli click ID to the destination for conversion attribution. It defaults to false. Set allow_search_engine_indexing to true only when you want search engines to index the short-link page. It defaults to false, which sends no-index instructions.

{
  "long_url": "https://example.com/checkout",
  "conversion_tracking_enabled": true,
  "allow_search_engine_indexing": false
}

Set proxy to true to use your own social preview metadata. You can provide any combination of title, description, and image.

{
  "long_url": "https://example.com/product",
  "proxy": true,
  "title": "Summer sale",
  "description": "Explore the summer collection.",
  "image": "https://cdn.example.com/previews/summer.jpg"
}

Field	Limit
`title`	255 characters
`description`	1,000 characters
`image`	Public HTTPS URL, maximum 2,048 characters

image rejects local hostnames, private or reserved IP literals, and non-HTTPS URLs. Providing preview metadata without proxy: true returns a validation error. Set proxy to false or omit it to use destination metadata instead.

Create an attached QR code

Set create_qr_code to true to generate a 1,024-pixel SVG QR code that points to the new short URL.

{
  "long_url": "https://example.com/product",
  "create_qr_code": true,
  "qr_logo": "app"
}

qr_logo accepts:

app: Include the Biqli logo. This is the default.
none: Generate the QR code without a center logo. This option requires the workspace plan permission for unbranded QR codes.

You can only send qr_logo when create_qr_code is true. The response includes the stored SVG URL, format, and selected logo mode.

Complete request

curl --request POST \
  --url https://biq.li/api/v1/link \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "long_url": "https://example.com/product",
    "name": "Summer campaign",
    "external_id": "campaign-link-1842",
    "domain_id": "biq_dom_01M14C6KQ6SG2GKMCV7HQ9A1QT",
    "alias": "summer-product",
    "active": true,
    "password": "launch-2026",
    "activates_at": "2026-09-01T08:00:00Z",
    "expires_at": "2026-10-01T08:00:00Z",
    "exp_clicks_rule": {
      "key": 1000,
      "value": "https://example.com/campaign-ended"
    },
    "utm": "source=newsletter&medium=email&campaign=summer",
    "geo_rules": [
      {
        "key": "us",
        "value": "https://example.com/us/product"
      }
    ],
    "device_rules": [
      {
        "key": "mobile",
        "value": "https://m.example.com/product"
      }
    ],
    "platform_rules": [
      {
        "key": "ios",
        "value": "https://apps.apple.com/app/example"
      }
    ],
    "folder_ids": [
      "biq_fld_01M14C93RJD7W46PFJX9B1TVYH"
    ],
    "pixel_ids": [
      "biq_pxl_01M14CBJNRXPW4Y22ZTA7F9W3J"
    ],
    "tag_ids": [
      "biq_tag_01M14CC1TW7AQ6DWZG9TMRH0PQ"
    ],
    "conversion_tracking_enabled": true,
    "allow_search_engine_indexing": false,
    "proxy": true,
    "title": "Summer sale",
    "description": "Explore the summer collection.",
    "image": "https://cdn.example.com/previews/summer.jpg",
    "create_qr_code": true,
    "qr_logo": "app"
  }'

Successful response

A link that clears synchronous safety checks returns 201 Created.

{
  "link": {
    "id": "biq_lnk_01M14D2M8VFKYQCE7Z3A6HRXWP",
    "short_url": "https://go.example.com/summer-product",
    "long_url": "https://example.com/product",
    "name": "Summer campaign",
    "external_id": "campaign-link-1842",
    "domain_id": "biq_dom_01M14C6KQ6SG2GKMCV7HQ9A1QT",
    "alias": "summer-product",
    "active": true,
    "has_password": true,
    "activates_at": "2026-09-01T08:00:00+00:00",
    "expires_at": "2026-10-01T08:00:00+00:00",
    "exp_clicks_rule": {
      "key": 1000,
      "value": "https://example.com/campaign-ended"
    },
    "utm": "source=newsletter&medium=email&campaign=summer",
    "geo_rules": [
      {
        "key": "us",
        "value": "https://example.com/us/product"
      }
    ],
    "device_rules": [
      {
        "key": "mobile",
        "value": "https://m.example.com/product"
      }
    ],
    "platform_rules": [
      {
        "key": "ios",
        "value": "https://apps.apple.com/app/example"
      }
    ],
    "folder_ids": [
      "biq_fld_01M14C93RJD7W46PFJX9B1TVYH"
    ],
    "pixel_ids": [
      "biq_pxl_01M14CBJNRXPW4Y22ZTA7F9W3J"
    ],
    "tag_ids": [
      "biq_tag_01M14CC1TW7AQ6DWZG9TMRH0PQ"
    ],
    "conversion_tracking_enabled": true,
    "allow_search_engine_indexing": false,
    "proxy": true,
    "title": "Summer sale",
    "description": "Explore the summer collection.",
    "image": "https://cdn.example.com/previews/summer.jpg",
    "qr_code": {
      "url": "https://biq.li/storage/workspaces/biq_ws_01M14ABP8W2BBMZ06SZKBJ283C/qr-codes/qr-biq_lnk_01M14D2M8VFKYQCE7Z3A6HRXWP.svg",
      "format": "svg",
      "logo": "app"
    },
    "clicks_count": 0,
    "leads_count": 0,
    "sales_count": 0,
    "revenue": 0,
    "revenue_currency": "USD",
    "clicked_at": null,
    "safety_status": "clear",
    "created_at": "2026-08-28T16:42:19+00:00",
    "updated_at": "2026-08-28T16:42:19+00:00"
  },
  "status": "success"
}

The API never returns the internal numeric link or workspace ID. It also never returns the password hash or plaintext password.

Pending safety response

If a destination redirects or needs deeper inspection, Biqli atomically creates the link and returns 202 Accepted with safety_status: "pending". The following abridged response highlights the pending state:

{
  "link": {
    "id": "biq_lnk_01M14D2M8VFKYQCE7Z3A6HRXWP",
    "short_url": "https://biq.li/summer-product",
    "long_url": "https://redirect.example.com/product",
    "safety_status": "pending"
  },
  "status": "pending",
  "message": "The link was created and is pending a safety check."
}

The short URL shows a pending-safety response and does not redirect until the background check marks every destination clear. A failed background check quarantines the link. A destination blocked by the synchronous checks returns 422 url_blocked and no link is created.

Plans, quotas, and atomicity

Workspace plan permissions and quotas apply before Biqli writes the link. Plan-gated options include custom aliases, passwords, activation and expiration, click expiration, UTM parameters, dynamic routing, and unbranded QR codes.

A missing plan entitlement returns 403 upgrade_required.
Exhausted monthly link quota returns 403 quota_exceeded.
The API rate limit uses the plan attached to the key’s workspace, not another workspace owned by the same user.
Link fields, rules, tags, folders, pixels, and the attached QR code are created as one operation. A failure rolls back the database changes and removes a QR file created by that failed operation.

The endpoint rejects unknown top-level fields. It also rejects workspaceId, workspace_id, accessToken, type, and type_id; those are internal or legacy fields and are never part of the workspace API contract.

Errors

Every error uses the same envelope:

{
  "error": {
    "code": "insufficient_scope",
    "message": "The API key requires the tags.view permission to use this resource.",
    "details": {
      "required_permission": "tags.view"
    }
  },
  "request_id": "ae437f49-30a3-4d55-bca6-dc523f2efcb3"
}

The same request ID is returned in the X-Biq-Request-Id response header. You can send your own X-Biq-Request-Id value up to 100 characters for distributed tracing. Include it when contacting support.

HTTP status	Error code	Meaning
`401`	`invalid_token`	The workspace API key is missing, malformed, invalid, or revoked.
`403`	`insufficient_scope`	The key lacks a required API permission, or its user cannot perform the action in the workspace.
`403`	`upgrade_required`	The workspace plan does not include a requested feature.
`403`	`quota_exceeded`	The workspace has exhausted its link creation quota.
`404`	`resource_not_found`	An attached public ID is unavailable in this workspace.
`409`	`alias_taken`	The requested alias already exists on the selected domain.
`409`	`external_id_taken`	The external ID already exists in the workspace.
`422`	`url_blocked`	A destination failed synchronous URL safety checks.
`422`	`validation_error`	A field is invalid, unsupported, or inconsistent with another field.
`429`	`rate_limit_exceeded`	The workspace exceeded its plan’s API request limit.
`500`	`internal_server_error`	An unexpected server error occurred.

Validation errors include an error.details.errors object keyed by field. Upgrade errors can include current_plan, required_plan, and feature. Quota errors include current workspace usage details.

This endpoint does not currently accept an idempotency key. Retrying a request after an ambiguous network failure can create another random-alias link. A caller-controlled alias or unique external_id provides conflict protection for workflows that require retry-safe creation.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization

string

header

required

A workspace API key beginning with biqli_.

Body

application/json

long_url

string

required

Destination URL. Biqli normalizes a missing scheme to HTTPS.

Required string length: 3 - 1000

Example:

"https://example.com/product"

name

string | null

Internal label for the link.

Maximum string length: 150

external_id

string | null

Caller-controlled identifier, unique within the API key's workspace.

Maximum string length: 255

domain_id

string | null

Public ID of a custom domain available to this workspace. Omit it to use the Biqli default domain.

Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$

alias

string | null

Requested short-link alias. The configured alias character and length rules apply.

Maximum string length: 50

active

boolean

default:true

Whether the link can redirect after it passes safety checks.

password

string | null

Password visitors must enter before redirecting.

Maximum string length: 250

activates_at

string<date-time> | null

ISO 8601 date and time when the link becomes active.

expires_at

string<date-time> | null

Future ISO 8601 expiration date and time. It must be later than activates_at.

exp_clicks_rule

object | null

Show child attributes

utm

string | null

Ampersand-separated UTM parameters without a leading question mark. Biqli prefixes keys with utm_ when needed.

Maximum string length: 2000

Example:

"source=newsletter&medium=email&campaign=summer"

geo_rules

object[] | null

Destination overrides evaluated for matching visitors.

Maximum array length: 100

Show child attributes

device_rules

object[] | null

Destination overrides evaluated for matching visitors.

Maximum array length: 100

Show child attributes

platform_rules

object[] | null

Destination overrides evaluated for matching visitors.

Maximum array length: 100

Show child attributes

folder_ids

string[] | null

Unique public IDs of folders in this workspace.

Maximum array length: 100

Pattern: ^biq_fld_[0-9A-HJKMNP-TV-Z]{26}$

pixel_ids

string[] | null

Unique public IDs of tracking pixels in this workspace.

Maximum array length: 100

Pattern: ^biq_pxl_[0-9A-HJKMNP-TV-Z]{26}$

tag_ids

string[] | null

Unique public IDs of tags in this workspace.

Maximum array length: 100

Pattern: ^biq_tag_[0-9A-HJKMNP-TV-Z]{26}$

conversion_tracking_enabled

boolean

default:false

Append a Biqli click ID for conversion attribution.

allow_search_engine_indexing

boolean

default:false

Allow search engines to index the short-link page.

proxy

boolean

default:false

Enable the custom social preview supplied by title, description, and image.

title

string | null

Custom social preview title. Requires proxy=true.

Maximum string length: 255

description

string | null

Custom social preview description. Requires proxy=true.

Maximum string length: 1000

image

string<uri> | null

Public HTTPS URL for the custom social preview image. Requires proxy=true. Private and local hosts are rejected.

Maximum string length: 2048

create_qr_code

boolean

default:false

Generate and attach an SVG QR code for this short link.

qr_logo

enum<string> | null

default:app

Use the Biqli app logo or no center logo. Requires create_qr_code=true. The none option is plan-gated.

Available options:

app,

none,

null

Response

The link was created and is ready to redirect.

link

object

required

Show child attributes

status

string

required

Allowed value: "success"

GETTING STARTED

BIQLI LINKS API

Create a link

Authentication and permissions

Minimal request

Link identity and destination

Access and expiration

UTM parameters

Dynamic routing

Attach workspace resources

Conversion tracking and indexing

Create an attached QR code

Complete request

Successful response

Pending safety response

Plans, quotas, and atomicity

Errors

Shared API behavior

Authorizations

Body

Response

​Authentication and permissions

​Minimal request

​Link identity and destination

​Access and expiration

​UTM parameters

​Dynamic routing

​Attach workspace resources

​Conversion tracking and indexing

​Custom social preview

​Create an attached QR code

​Complete request

​Successful response

​Pending safety response

​Plans, quotas, and atomicity

​Errors

​Shared API behavior

Authorizations

Body

Response

Authentication and permissions

Minimal request

Link identity and destination

Access and expiration

UTM parameters

Dynamic routing

Attach workspace resources

Conversion tracking and indexing

Custom social preview

Create an attached QR code

Complete request

Successful response

Pending safety response

Plans, quotas, and atomicity

Errors

Shared API behavior