Skip to main content

​
Overview

Check if a custom short code is available for use in your project. This endpoint helps you verify code availability before creating a new dynamic link, preventing conflicts and ensuring your preferred codes are available.

​
Endpoint

GET https://api.bit2connect.com/1.0/links/check/{code}

​
Path Parameters

For detailed information about path parameters, see the Check Code Availability API Reference.

​
Example Request

curl -X GET "https://api.bit2connect.com/1.0/links/check/summer-sale-2024" \
  -H "X-API-KEY: b2co_your_api_key_here"

​
Response

​
Available Code Response

{
  "success": true,
  "data": {
    "code": "summer-sale-2024",
    "available": true
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

​
Unavailable Code Response

{
  "success": true,
  "data": {
    "code": "summer-sale",
    "available": false,
    "message": "Code is already in use in this project"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

​
Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_CODE_FORMAT",
    "message": "Code must be 3-50 characters and contain only alphanumeric characters, hyphens, and underscores"
  }
}
For detailed response fields, error codes, code requirements, and workflow integration examples, see the Check Code Availability API Reference.

​
Next Steps

Create Link

Create a new dynamic link with your verified code

List Links

View all your existing dynamic links

Get Link Details

Check details of existing links

Update Link Status

Manage your link statuses