{ "info": { "_postman_id": "7258aeaa-5921-4871-95d0-6e3807243ec3", "name": "🔗 ChottuLink Rest APIs", "description": "# ChottuLink REST API Overview\n\nUse the **ChottuLink REST API** to manage and automate dynamic links for your organization. This API enables you to list, create, update, enable/disable, and analyze dynamic links programmatically — perfect for dashboard integrations, automation workflows, and link management systems.\n\nWith ChottuLink’s REST API, you can:\n\n- Retrieve all active and disabled links in a paginated format\n \n- Create and customize new dynamic links\n \n- Enable or disable existing links\n \n- Update link metadata or destination URLs\n \n- Get analytics and performance metrics for your links\n \n\n### 🚀 Get Started\n\nFollow the steps below to authenticate and begin using the ChottuLink REST API in Postman. Your REST API integration key (found under `Dashboard > Keys`)\n\n1. **Set up your collection** _**'Variables'**_\n \n\n| Variable | Description | Example |\n| --- | --- | --- |\n| `baseUrl` | The API base endpoint | `https://api2.chottulink.com` |\n| `API-KEY` | Your REST API integration key (found under `Dashboard > Keys`) | `c_api_xxxxxxxxxxxxxxxxxxxxxx` |\n\n2\\. Authentication\n\nAll requests must include the following header:\n\n`API-KEY: {{API-KEY}}`\n\n3\\. Test Your Connection\n\nIn Postman:\n\n1. Set `baseUrl` and `API-KEY` in your **collection variables**.\n \n2. Choose any endpoint (like [/chotuCore/pa/v1/links/page](https://api2.chottulink.com/chotuCore/pa/v1/links/page)) and click **Send**.\n \n3. If authentication is successful, you’ll receive a JSON response with your organization’s links.\n \n\n### 🧰 Available Endpoints\n\n| **Title** | **Method** | **Endpoint** | **Category** |\n| --- | --- | --- | --- |\n| List links | GET | {baseUrl}/chotuCore/pa/v1/links/page | Links |\n| Get link Information | POST | {baseUrl}/chotuCore/pa/v1/links/info | Links |\n| Create link | POST | {baseUrl}/chotuCore/pa/v1/create-link | Links |\n| Update link | PATCH | {baseUrl}/chotuCore/pa/v1/update-link/{linkId} | Links |\n| Enable/Disable a link | PATCH | {baseUrl}/chotuCore/pa/v1/links/change-status/{linkId} | Links |\n| Get analytics | GET | {baseUrl}/chotuCore/pa/v1/analytics | Analytics |", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "9797777", "_collection_link": "" }, "item": [ { "name": "Analytics", "item": [ { "name": "Get Analytics", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "API-KEY", "value": "{{API-KEY}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shortUrl\": \"\", // optional\n \"linkId\": \"\" // optional\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/chotuCore/pa/v1/analytics", "host": [ "{{baseurl}}" ], "path": [ "chotuCore", "pa", "v1", "analytics" ] }, "description": "Use **ChottuLink’s REST API** to retrieve detailed analytics for a specific dynamic link using its _**shortUrl**_ or _**linkId**_. \nThis endpoint returns click statistics including **total clicks**, **7-day clicks**, and **30-day clicks**, allowing you to monitor engagement and performance for that particular link in your account.\n\n### \\# EndPoint :\n\n`POST` [https://api2.chottulink.com/chotuCore/pa/v1/analytics](https://api2.chottulink.com/chotuCore/pa/v1/analytics)\n\n---\n\n### \\# Authentication :\n\nInclude your API key in the request header:\n\n`API-KEY: {{API-KEY}}`\n\n---\n\n### \\# Request parameters :\n\n**Parameter Guidelines:**\n\n- You must provide **either** `shortUrl` **or** `linkId`\n \n- Both parameters cannot be empty\n \n- Use `shortUrl` for easier identification\n \n- Use `linkId` for programmatic access\n \n\nAnalytics Parameter:\n\n| Parameter | Type | Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| shortUrl | string | Yes | The short URL of the link to get analytics for | `https://yourapp.chottu.link/abc123` |\n| linkId | string | Yes | The unique ID of the link to get analytics for | `39629a6d-e0cf-432e-938a-a10c5ea88aaa` |\n\nEither `shortUrl` or `linkId` must be provided.\n\n---\n\n### \\# Example Request (Curl):\n\n``` json\ncurl --location 'https://api2.chottulink.com/chotuCore/pa/v1/analytics' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"shortUrl\": \"https://yourapp.chottu.link/abc123\"\n}'\n\n ```\n\n``` json\ncurl --location 'https://api2.chottulink.com/chotuCore/pa/v1/analytics' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"linkId\": \"39629a6d-e0cf-432e-938a-a10c5ea88aaa\"\n}'\n\n ```\n\n---\n\n### \\# Responses :\n\n**Success**:\n\n``` json\n{\n \"clicks_last_30_days\": 150,\n \"clicks_last_7_days\": 45,\n \"total_clicks\": 1250\n}\n\n ```\n\nResponse Fields :\n\n| Field | Type | Description | Example |\n| --- | --- | --- | --- |\n| clicks_last_30_days | integer | Number of clicks in the last 30 days | `150` |\n| clicks_last_7_days | integer | Number of clicks in the last 7 days | `45` |\n| total_clicks | integer | Total number of clicks since link creation | `1250` |\n\n**Error Responses :**\n\nMissing Parameters :\n\n``` json\n{\n \"code\": 101,\n \"errorMessage\": \"There was one or more validation error(s)\",\n \"errors\": [\n {\n \"errorMessage\": \"REQUIRED_FIELD_MISSING\",\n \"fieldName\": \"Both 'shortUrl' and 'linkId' cannot be empty. At least one must be provided.\"\n }\n ]\n}\n\n ```\n\nInvalid Link :\n\n``` json\n{\n \"code\": 103,\n \"errorMessage\": \"The requested entity could not be found\",\n \"error\": {\n \"errorMessage\": \"Invalid link details. We were unable to retrieve analytics for the provided link. Please verify the information and try again.\",\n \"fieldName\": \"INVALID_VALUE\"\n }\n}\n\n ```\n\nUnauthorized Access :\n\n``` json\n{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid Api Key\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}\n\n ```" }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shortUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api2.chottulink.com/chotuCore/pa/v1/analytics", "protocol": "https", "host": [ "api2", "chottulink", "com" ], "path": [ "chotuCore", "pa", "v1", "analytics" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 11:43:54 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"clicks_last_30_days\":\"\",\n \"clicks_last_7_days\": \"\",\n \"total_clicks\": \"\"\n}" }, { "name": "Missing Parameters (400)", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{api-key}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shortUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/analytics", "host": [ "{{baseurl}}" ], "path": [ "analytics" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 11:43:54 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"errorMessage\": \"\",\n \"errors\": [\n {\n \"errorMessage\": \"\",\n \"fieldName\": \"\"\n }\n ]\n}" }, { "name": "Invalid Link (400)", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{api-key}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shortUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/analytics", "host": [ "{{baseurl}}" ], "path": [ "analytics" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 11:43:54 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"errorMessage\": \"\",\n \"error\": {\n \"errorMessage\": \"\",\n \"fieldName\": \"\"\n }\n}" }, { "name": "Unauthorized Access (401)", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{api-key}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shortUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/analytics", "host": [ "{{baseurl}}" ], "path": [ "analytics" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 11:43:54 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid Api Key\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}" } ] } ], "description": "# 📊 API\\`s to get Link Analytics by ShortUrl or LinkId\n\nUse ChottuLink's REST API to retrieve analytics data for your dynamic \nlinks. This endpoint provides detailed click statistics including **total clicks**, **7-day clicks**, and **30-day clicks** for any specific link in your account." }, { "name": "Links", "item": [ { "name": "List Links", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "API-KEY", "value": "{{API-KEY}}" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/chotuCore/pa/v1/links/page?page=&size=&createdBy=", "host": [ "{{baseurl}}" ], "path": [ "chotuCore", "pa", "v1", "links", "page" ], "query": [ { "key": "page", "value": "", "description": "The page number to retrieve. Minimum is 1, default is 1." }, { "key": "size", "value": "", "description": "The number of items to be returned in a single page. Minimum is 1, maximum is 100, and default is 20." }, { "key": "createdBy", "value": "", "description": "Filter by creator type" } ] }, "description": "Use ChottuLink's REST API to retrieve all dynamic links associated with your organization. This endpoint provides \npaginated access to both active and disabled links, making it ideal for dashboard integrations, link management systems, \nor bulk operations.\n\n### **\\# EndPoint :**\n\n`GET` [https://api2.chottulink.com/chotuCore/pa/v1/links/page](https://api2.chottulink.com/chotuCore/pa/v1/links/page)\n\n---\n\n### \\# Authentication :\n\nInclude your API key in the request header:\n\n`API-KEY: {{API-KEY}}`\n\n---\n\n### \\# Query Parameters:\n\n**Parameter Guidelines :**\n\n- All parameters are _**optional**_\n \n- Default values provide sensible defaults for most use cases\n \n- Pagination starts from page 1 (not 0)\n \n- Maximum page size is typically 100 items per page\n \n- When no `createdBy` filter is specified, all the links created on the platform are returned by default.\n \n\n**Pagination Parameters :**\n\n---\n\n| Parameter | Type | Required | Default | Description | Example |\n| --- | --- | --- | --- | --- | --- |\n| page | integer | No | 1 | The page number to retrieve (starts from 1) | `1` |\n| size | integer | No | 20 | Number of items per page (max 100) | `20` |\n\n**Filter Parameters:**\n\n| Parameter | Type | Required | Default | Description | Example Values |\n| --- | --- | --- | --- | --- | --- |\n| createdBy | string | No | api_user | Filter links by the type of key used to create them | `api_user`, `api_rest`, `sdk` |\n\n**CreatedBy Filter Values:**\n\n- **`api_user`** - Links created using API user keys\n \n- **`api_rest`** - Links created using REST API keys\n \n- **`sdk`** - Links created using SDK keys\n \n\n---\n\n### \\# Example Requests :\n\n- Basic Request(Default Pagination):\n \n\n``` json\ncurl --location 'https://api2.chottulink.com/chotuCore/pa/v1/links/page' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n\n ```\n\n- Request with Custom Pagination:\n \n\n``` json\ncurl --location 'https://api2.chottulink.com/chotuCore/pa/v1/links/page?page=1&size=20' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n\n ```\n\n- Request with Large Page Size:\n \n\n``` json\ncurl --location 'https://api2.chottulink.com/chotuCore/pa/v1/links/page?page=1&size=50' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n\n ```\n\n- Request with CreatedBy Filter\n \n\n``` json\ncurl --location 'https://api2.chottulink.com/chotuCore/pa/v1/links/page?createdBy=api_rest' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n\n ```\n\n- Request with All Parameters:\n \n\n``` json\ncurl --location 'https://api2.chottulink.com/chotuCore/pa/v1/links/page?page=1&size=50&createdBy=sdk' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n\n ```\n\n---\n\n### \\# Example Responses :\n\nSuccess Response :\n\n``` json\n{\n \"links\": [\n {\n \"createdTime\": \"2025-07-02T10:22:01\",\n \"destination_url\": \"https://yourapp.com/content\",\n \"id\": \"4eb66e2e-6acd-4b40-8767-3966ebf7c5a6\",\n \"is_enabled\": true,\n \"link_name\": \"Summer Sale\",\n \"modifiedTime\": \"2025-07-02T10:22:01\",\n \"org_id\": \"6867c0be01ed16b7bf180376\",\n \"short_url\": \"https://yourapp.chottu.link/promo-summer\"\n },\n {\n \"createdTime\": \"2025-05-02T12:46:19\",\n \"destination_url\": \"https://yourapp.com/\",\n \"id\": \"3e15d5e5-fe81-4714-a846-30245d3d3445\",\n \"is_enabled\": true,\n \"link_name\": \"Share App\",\n \"modifiedTime\": \"2025-05-04T08:33:42\",\n \"org_id\": \"6867c0be01ed16b7bf180376\",\n \"short_url\": \"https://yourapp.chottu.link/share\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"page_size\": 20,\n \"total_items\": 2,\n \"total_pages\": 1\n }\n}\n\n ```\n\nResponse Fields :\n\nLink Object Fields :\n\n| Field | Type | Description | Example |\n| --- | --- | --- | --- |\n| createdTime | string | The date and time when the link was created (ISO 8601 format) | `\"2025-07-02T10:22:01\"` |\n| destination_url | string | The destination URL that the link redirects to | `\"https://yourapp.com/content\"` |\n| id | string | The unique identifier for the link (UUID format) | `\"4eb66e2e-6acd-4b40-8767-3966ebf7c5a6\"` |\n| is_enabled | boolean | Indicates whether the link is currently enabled or disabled | `true` |\n| link_name | string | The name assigned to the link for identification | `\"Summer Sale\"` |\n| modifiedTime | string | The date and time when the link was last modified (ISO 8601 format) | `\"2025-07-02T10:22:01\"` |\n| org_id | string | The organization ID to which the link belongs | `\"6867c0be01ed16b7bf180376\"` |\n| short_url | string | The shortened URL representing the actual dynamic link | `\"https://yourapp.chottu.link/promo-summer\"` |\n\nPagination Object Fields :\n\n| Field | Type | Description | Example |\n| --- | --- | --- | --- |\n| current_page | integer | The current page number in the paginated result set | `1` |\n| page_size | integer | The number of items displayed per page | `20` |\n| total_items | integer | The total number of items available across all pages | `2` |\n| total_pages | integer | The total number of pages in the result set | `1` |\n\nError Responses :\n\nUnauthorized Access :\n\n``` json\n{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid Api Key\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}\n\n ```\n\nInvalid Pagination Parameters :\n\n``` json\n{\n \"code\": 400,\n \"errorMessage\": \"Invalid pagination parameters\",\n \"error\": {\n \"errorMessage\": \"Page size must be between 1 and 100\",\n \"fieldName\": \"size\"\n }\n}\n\n ```\n\nNo Links Found :\n\n``` json\n{\n \"links\": [],\n \"pagination\": {\n \"current_page\": 1,\n \"page_size\": 20,\n \"total_items\": 0,\n \"total_pages\": 0\n }\n}\n\n ```" }, "response": [ { "name": "Success Response (200)", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } ], "url": { "raw": "https://api2.chottulink.com/chotuCore/pa/v1/links/page?page=1&size=20&createBy=api_rest", "protocol": "https", "host": [ "api2", "chottulink", "com" ], "path": [ "chotuCore", "pa", "v1", "links", "page" ], "query": [ { "key": "page", "value": "1", "description": "Page number" }, { "key": "size", "value": "20", "description": "Page Size" }, { "key": "createBy", "value": "api_rest", "description": "Filter by creator type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 30 Oct 2025 13:33:38 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"links\": [\n {\n \"id\": \"\",\n \"link_name\": \"\",\n \"short_url\": \"\",\n \"destination_url\": \"\",\n \"is_enabled\": \"\",\n \"org_id\": \"\",\n \"createdTime\": \"\",\n \"modifiedTime\": \"\"\n }\n ],\n \"pagination\": {\n \"current_page\": \"\",\n \"page_size\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\",\n \"nextPageUrl\": \"\"\n }\n}\n" }, { "name": "Unauthorized Access (401)", "originalRequest": { "method": "GET", "header": [ { "key": "API-KEY", "value": "c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } ], "url": { "raw": "https://api2.chottulink.com/chotuCore/pa/v1/links/page?page=1&size=20&createBy=api_rest", "protocol": "https", "host": [ "api2", "chottulink", "com" ], "path": [ "chotuCore", "pa", "v1", "links", "page" ], "query": [ { "key": "page", "value": "1", "description": "Page number" }, { "key": "size", "value": "20", "description": "Page Size" }, { "key": "createBy", "value": "api_rest", "description": "Filter by creator type" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 30 Oct 2025 13:33:38 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid Api Key\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}" } ] }, { "name": "Get Link Information", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "API-KEY", "value": "{{API-KEY}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shortUrl\":\"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/chotuCore/pa/v1/links/info", "host": [ "{{baseurl}}" ], "path": [ "chotuCore", "pa", "v1", "links", "info" ] }, "description": "Use ChottuLink's REST API to retrieve detailed information about a specific dynamic link using its short URL. This public API endpoint allows you to fetch link metadata including destination URL, creation time, link name, and enabled status - perfect for integrating link data into external systems or dashboards.\n\n### \\# EndPoint :\n\n`POST` [https://api2.chottulink.com/chotuCore/pa/v1/links/info](https://api2.chottulink.com/chotuCore/pa/v1/links/info)\n\n---\n\n### \\# Authentication :\n\nInclude your API key in the request header:\n\n`API-KEY: {{API-KEY}}`\n\n---\n\n### \\# Requested Parameters :\n\n**Parameter Guidelines:**\n\n- The `shortUrl` parameter is **mandatory**\n \n- The short URL must be associated with your organization\n \n- The short URL must include the full URL format (including protocol)\n \n- Empty or invalid short URLs will result in a 400 error\n \n\nRequired Parameters :\n\n| Parameter | Type | Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| shortUrl | string | Yes | The complete short URL of the link you want to retrieve info for | `https://yourapp.chottu.link/promo-summer` |\n\n---\n\n### \\# Example Request :\n\nBasic Request :\n\n``` json\ncurl --location 'https://api2.chottulink.com/chotuCore/pa/v1/links/info' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"shortUrl\":\"https://yourapp.chottu.link/promo-summer\"\n}'\n\n ```\n\n---\n\n### \\# Response :\n\n**Success Response :**\n\n``` json\n{\n \"createdTime\": \"2025-07-02T10:22:01\",\n \"destination_url\": \"https://yourapp.com/content\",\n \"id\": \"4eb66e2e-6acd-4b40-8767-3966ebf7c5a6\",\n \"is_enabled\": true,\n \"link_name\": \"Summer Sale\",\n \"modifiedTime\": \"2025-07-02T10:22:01\",\n \"org_id\": \"6867c0be01ed16b7bf180376\",\n \"short_url\": \"https://yourapp.chottu.link/promo-summer\"\n}\n\n ```\n\n**Response Fields :**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| createdTime | string | Created date time of the link |\n| destination_url | string | Destination URL of the provided short URL |\n| id | string | ID of the link |\n| is_enabled | boolean | Is link enabled or not, represent boolean value |\n| link_name | string | Name of the link |\n| modifiedTime | string | Modified date time of the link |\n| org_id | string | Organization ID |\n| short_url | string | Short URL of the link |\n\nError Responses :\n\n- Empty Short URL :\n \n\n``` json\n{\n \"code\": 101,\n \"errorMessage\": \"There was one or more validation error(s)\",\n \"error\": {\n \"errorMessage\": \"shortUrl can not be null and empty!\",\n \"fieldName\": \"INVALID_VALUE\"\n }\n}\n\n ```\n\n> 📌 NOTE:- \nThis error occurs when the request is sent with an empty or missing shortUrl field. \n \n\n- Short URL Not Found :\n \n\n``` json\n{\n \"code\": 139,\n \"errorMessage\": \"Client Error\",\n \"error\": {\n \"errorMessage\": \"CLIENT_ERROR\",\n \"fieldName\": \"{\\\"detail\\\":\\\"Link with short_url 'api3.maeight.com/cron' not found for organization '687f8d35064fe1799bfe5ab8'.\\\"}\"\n }\n}\n\n ```\n\n> 📌 NOTE:- \nThis error occurs when the provided short URL doesn't exist in the system or isn't associated with your organization. \n \n\n- Unauthorized API Key :\n \n\n``` json\n{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"'API-KEY' missing\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}\n\n ```\n\n> 📌 NOTE:- \nThis error occurs when the provided API key is missing, invalid, expired, or not included in the request headers." }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shortUrl\":\"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api2.chottulink.com/chotuCore/pa/v1/links/info", "protocol": "https", "host": [ "api2", "chottulink", "com" ], "path": [ "chotuCore", "pa", "v1", "links", "info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 12:34:32 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"createdTime\": \"\",\n \"destination_url\": \"\",\n \"id\": \"\",\n \"is_enabled\": \"\",\n \"link_name\": \"\",\n \"modifiedTime\": \"\",\n \"org_id\": \"\",\n \"short_url\": \"\"\n}" }, { "name": "Short Url Not Found (400)", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{api-key}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shortUrl\":\"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/links/info", "host": [ "{{baseurl}}" ], "path": [ "links", "info" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 12:34:32 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"errorMessage\": \"\",\n \"error\": {\n \"errorMessage\": \"\",\n \"fieldName\": \"\"\n }\n}" }, { "name": "Unauthorized API Key (401)", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{api-key}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shortUrl\":\"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/links/info", "host": [ "{{baseurl}}" ], "path": [ "links", "info" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 12:34:32 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid Api Key\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}" } ] }, { "name": "Create Link", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "API-KEY", "value": "{{API-KEY}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"domain\": \"\", // mandatory\n \"selected_path\": \"\",\n \"destination_url\": \"\", // mandatory \n \"link_name\": \"\", // mandatory\n \"ios_behavior\": 1, // mandatory -- where to land APP / BROWSER | 1: browser | 2: app\n \"android_behavior\": 1, // mandatory -- where to land APP / BROWSER | 1: browser | 2: app\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"social_title\": \"\",\n \"social_description\": \"\",\n \"social_image_url\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/chotuCore/pa/v1/create-link", "host": [ "{{baseurl}}" ], "path": [ "chotuCore", "pa", "v1", "create-link" ] }, "description": "Use ChottuLink's REST API to programmatically create dynamic links from your backend or server-side scripts. This is \nideal for scenarios where links need to be generated outside the app, such as in marketing campaigns, transactional \nmessages, or automated workflows. Simply make a POST request with the required parameters, and receive a fully-qualified \nshort or long link in response.\n\n### \\# EndPoint :\n\n`POST` [https://api2.chottulink.com/chotuCore/pa/v1/create-link](https://api2.chottulink.com/chotuCore/pa/v1/create-link)\n\n---\n\n### \\# Authentication :\n\nInclude your API key in the request header:\n\n`API-KEY: {{API-KEY}}`\n\n---\n\n### \\# Request Parameters :\n\n⚙️ **Parameter Guidelines :**\n\n- All required parameters must be included in the request\n \n- Optional parameters can be omitted\n \n- UTM parameters are recommended for better analytics tracking\n \n- Social sharing parameters enhance the link's appearance when shared\n \n\n---\n\n### \\# Required Parameters :\n\nDomain Configuration :\n\n| Parameter | Type | Description | Example |\n| --- | --- | --- | --- |\n| domain | string | Your custom domain for the dynamic link. Must be configured in your ChottuLink dashboard. | `yourapp.chottu.link` |\n| destination_url | string | The final URL where users will be redirected. This can be your website or app store link. | `https://yourapp.com/content` |\n| link_name | string | A descriptive name for your dynamic link. Used for identification in the dashboard. | `Summer Sale` |\n\nLink Behaviour :\n\n| Parameter | Type | Description | Values |\n| --- | --- | --- | --- |\n| ios_behavior | integer | Controls how the link behaves on iOS devices | `1`: Open in Browser
`2`: Open in App |\n| android_behavior | integer | Controls how the link behaves on Android devices | `1`: Open in Browser
`2`: Open in App |\n\n---\n\n### \\# Optional Parameters :\n\nDomain Configuration :\n\n| Parameter | Type | Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| selected_path | string | No | The
custom path component for your dynamic link. This will be appended to
your domain to create the final short URL. If omitted, the system
automatically generates a 6-character alphabetic path (e.g., `AbCxYz`). | `promo-summer` |\n\nUTM Parametrs :\n\n| Parameter | Type | Description | Example |\n| --- | --- | --- | --- |\n| utm_source | string | Identifies the source of your traffic | `email` |\n| utm_medium | string | Identifies the medium of your traffic | `newsletter` |\n| utm_campaign | string | Identifies the campaign name | `summer2025` |\n| utm_term | string | Identifies paid keywords | `best summer sale` |\n| utm_content | string | Used to differentiate similar content | `banner_email` |\n\nSocial Sharing Parameters :\n\n| Parameter | Type | Description | Example |\n| --- | --- | --- | --- |\n| social_title | string | Title that appears when the link is shared on social media | `Summer Sale` |\n| social_description | string | Description that appears when the link is shared on social media | `Check out our amazing deals!` |\n| social_image_url | string | Image URL that appears when the link is shared on social media | `https://yourapp.com/images/sale.jpg` |\n\n---\n\n### \\# Example Request :\n\n``` json\ncurl --location 'https://api2.chottulink.com/chotuCore/pa/v1/create-link' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"domain\": \"yourapp.chottu.link\",\n \"selected_path\": \"promo-summer\",\n \"destination_url\": \"https://yourapp.com/content\",\n \"link_name\": \"Summer Sale\",\n \"ios_behavior\": 2,\n \"android_behavior\": 2,\n \"utm_source\": \"email\",\n \"utm_medium\": \"newsletter\",\n \"utm_campaign\": \"summer2025\",\n \"utm_term\": \"best summer sale\",\n \"utm_content\": \"banner_email\",\n \"social_title\": \"Summer Sale\",\n \"social_description\": \"Check out our amazing deals!\",\n \"social_image_url\": \"https://yourapp.com/images/sale.jpg\"\n}'\n\n ```\n\n---\n\n### \\# Example Response :\n\n**Success Response :**\n\n``` json\n{\n \"status\": \"success\",\n \"message\": \"Link created successfully\",\n \"short_url\": \"https://yourapp.chottu.link/promo-summer\"\n}\n\n ```\n\nSuccess Response Fields:\n\n| Field | Type | Description | Example |\n| --- | --- | --- | --- |\n| status | string | Response status indicating success | `\"success\"` |\n| message | string | Human-readable success message | `\"Link created successfully\"` |\n| short_url | string | The generated short URL for the dynamic link | `\"https://yourapp.chottu.link/promo-summer\"` |\n\n---\n\nError Responses:\n\nUnauthorized Access :\n\n``` json\n{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid API-KEY\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n\n ```" }, "response": [ { "name": "Success (201)", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"domain\": \"\",\n \"selected_path\": \"\",\n \"destination_url\": \"\",\n \"link_name\": \"\",\n \"ios_behavior\":,\n \"android_behavior\": ,\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"social_title\": \"\",\n \"social_description\": \"\",\n \"social_image_url\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api2.chottulink.com/chotuCore/pa/v1/create-link", "protocol": "https", "host": [ "api2", "chottulink", "com" ], "path": [ "chotuCore", "pa", "v1", "create-link" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 08:16:08 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"message\": \"\",\n \"short_url\": \"\"\n}" }, { "name": "Bad Request (400)", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{API-KEY}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"domain\": \"\", // mandatory\n \"selected_path\": \"\",\n \"destination_url\": \"\", // mandatory \n \"link_name\": \"\", // mandatory\n \"ios_behavior\": 1, // mandatory -- where to land APP / BROWSER | 1: browser | 2: app\n \"android_behavior\": 1, // mandatory -- where to land APP / BROWSER | 1: browser | 2: app\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"social_title\": \"\",\n \"social_description\": \"\",\n \"social_image_url\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/chotuCore/pa/v1/create-link", "host": [ "{{baseurl}}" ], "path": [ "chotuCore", "pa", "v1", "create-link" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [ { "expires": "Invalid Date", "domain": "", "path": "" } ], "body": "{\n \"code\": \"\",\n \"errorMessage\": \"\",\n \"errors\": [\n {\n \"errorMessage\": \"\",\n \"fieldName\": \"\"\n }\n ]\n}" }, { "name": "Unauthorized (401)", "originalRequest": { "method": "POST", "header": [ { "key": "API-KEY", "value": "{{api-key}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"domain\": \"\",\n \"selected_path\": \"\",\n \"destination_url\": \"\",\n \"link_name\": \"\",\n \"ios_behavior\":,\n \"android_behavior\": ,\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"social_title\": \"\",\n \"social_description\": \"\",\n \"social_image_url\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/create-link", "host": [ "{{baseurl}}" ], "path": [ "create-link" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 08:18:14 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid API-KEY\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}" } ] }, { "name": "Update Link", "request": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{API-KEY}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"destination_url\": \"\",\n \"link_name\": \"\",\n \"ios_behavior\": ,\n \"android_behavior\": ,\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"social_title\": \"\",\n \"social_description\": \"\",\n \"social_image_url\": \"\"\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/chotuCore/pa/v1/update-link/:{link-id}", "host": [ "{{baseurl}}" ], "path": [ "chotuCore", "pa", "v1", "update-link", ":{link-id}" ], "variable": [ { "key": "{link-id}", "value": "", "description": "(Required) The unique identifier of the dynamic link whose status you want to update" } ] }, "description": "Use ChottuLink's REST API to update existing dynamic links in your account. This endpoint allows you to modify any field of an existing link, making it perfect for link management, campaign updates, or content modifications. Only the fields you include in the request will be updated.\n\n### \\# EndPoint :\n\n`PATCH` [https://api2.chottulink.com/chotuCore/pa/v1/update-link/{linkId}](https://api2.chottulink.com/chotuCore/pa/v1/update-link/%7BlinkId%7D)\n\n---\n\n### \\# Authentication :\n\nInclude your API key in the request header:\n\n`API-KEY: {{API-KEY}}`\n\n---\n\n### \\# Path Parameters :\n\n| Parameter | Type | Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| linkId | string | Yes | The unique identifier of the link to update | `aae848d6-f481-41db-8e5f-b511b5a75669` |\n\n---\n\n### \\# Request Parameters :\n\n**Update Guidelines:**\n\n- All parameters in the request body are _**optional**_\n \n- Only fields included in the request will be updated\n \n- Fields not included will remain unchanged\n \n- Make sure not to send unwanted fields\n \n- The link must belong to your organization\n \n\nLink Configuration:\n\n| Parameter | Type | Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| destination_url | string | No | The destination URL that the link redirects to | `https://yourapp.com/updated-content` |\n| link_name | string | No | The name assigned to the link for identification | `Updated Summer Sale` |\n\nLink Behaviour:\n\n| Parameter | Type | Required | Description | Values |\n| --- | --- | --- | --- | --- |\n| ios_behavior | integer | No | Controls how the link behaves on iOS devices | `1`: Open in Browser
`2`: Open in App |\n| android_behavior | integer | No | Controls how the link behaves on Android devices | `1`: Open in Browser
`2`: Open in App |\n\nUTM Parameters:\n\n| Parameter | Type | Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| utm_source | string | No | Identifies the source of your traffic | `email` |\n| utm_medium | string | No | Identifies the medium of your traffic | `newsletter` |\n| utm_campaign | string | No | Identifies the campaign name | `summer2025` |\n| utm_term | string | No | Identifies paid keywords | `best summer sale` |\n| utm_content | string | No | Used to differentiate similar content | `banner_email` |\n\nSocial Sharing Parameters:\n\n| Parameter | Type | Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| social_title | string | No | Title that appears when the link is shared on social media | `Updated Summer Sale` |\n| social_description | string | No | Description that appears when the link is shared on social media | `Check out our updated amazing deals!` |\n| social_image_url | string | No | Image URL that appears when the link is shared on social media | `https://yourapp.com/images/updated-sale.jpg` |\n\n---\n\n### \\# Example Request :\n\n- Basic Update (Single Field)\n \n\n``` json\ncurl --location --request PATCH 'https://api2.chottulink.com/chotuCore/pa/v1/update-link/aae848d6-f481-41db-8e5f-b511b5a75669' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"link_name\": \"Updated Link Name\"\n}'\n\n ```\n\n- Complete Update (All Fields)\n \n\n``` json\ncurl --location --request PATCH 'https://api2.chottulink.com/chotuCore/pa/v1/update-link/aae848d6-f481-41db-8e5f-b511b5a75669' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"destination_url\": \"https://yourapp.com/updated-content\",\n \"link_name\": \"Updated Summer Sale\",\n \"ios_behavior\": 1,\n \"android_behavior\": 2,\n \"utm_source\": \"api_update\",\n \"utm_medium\": \"internal\",\n \"utm_campaign\": \"updated_campaign\",\n \"utm_term\": \"updated_term\",\n \"utm_content\": \"updated_content\",\n \"social_title\": \"Updated Link via API\",\n \"social_description\": \"Testing the link update endpoint.\",\n \"social_image_url\": \"https://yourapp.com/images/updated-image.jpg\"\n}'\n\n ```\n\n- Partial Update (Selected Fields)\n \n\n``` json\ncurl --location --request PATCH 'https://api2.chottulink.com/chotuCore/pa/v1/update-link/aae848d6-f481-41db-8e5f-b511b5a75669' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"destination_url\": \"https://yourapp.com/new-destination\",\n \"social_title\": \"New Social Title\",\n \"utm_campaign\": \"updated_campaign_2025\"\n}'\n\n ```\n\n---\n\n### \\# Responses :\n\nSuccess Response :\n\n``` json\n{\n \"message\": \"Link updated successfully\",\n \"status\": \"success\"\n}\n\n ```\n\nResponse Fields :\n\n| Field | Type | Description | Example |\n| --- | --- | --- | --- |\n| status | string | Response status indicating success | `\"success\"` |\n| message | string | Human-readable success message | `\"Link updated successfully\"` |\n\nError Responses:\n\nInvalid Link ID :\n\n``` json\n{\n \"code\": 101,\n \"errorMessage\": \"There was one or more validation error(s)\",\n \"error\": {\n \"errorMessage\": \"Invalid linkId! LinkId is not valid for the organization!\",\n \"fieldName\": \"INVALID_VALUE\"\n }\n}\n\n ```\n\nUnauthorized Access :\n\n``` java\n{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid Api Key\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}\n\n ```" }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"destination_url\": \"\",\n \"link_name\": \"\",\n \"ios_behavior\": \"\",\n \"android_behavior\": \"\",\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"social_title\": \"\",\n \"social_description\": \"\",\n \"social_image_url\": \"\"\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api2.chottulink.com/chotuCore/pa/v1/update-link/aae848d6-f481-41db-8e5f-b511b5a75669", "protocol": "https", "host": [ "api2", "chottulink", "com" ], "path": [ "chotuCore", "pa", "v1", "update-link", "aae848d6-f481-41db-8e5f-b511b5a75669" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 09:08:41 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"message\": \"\",\n \"status\": \"\"\n}" }, { "name": "Invalid Link Id (400)", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{api-key}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"destination_url\": \"\",\n \"link_name\": \"\",\n \"ios_behavior\":\"\",\n \"android_behavior\":\"\",\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"social_title\": \"\",\n \"social_description\": \"\",\n \"social_image_url\": \"\"\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/update-link/aae848d6-f481-41db-8e5f-b511b5a75669", "host": [ "{{baseurl}}" ], "path": [ "update-link", "aae848d6-f481-41db-8e5f-b511b5a75669" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 09:08:41 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"errorMessage\": \"\",\n \"error\": {\n \"errorMessage\": \"\",\n \"fieldName\": \"\"\n }\n}" }, { "name": "Unauthorized (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{api-key}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"destination_url\": \"\",\n \"link_name\": \"\",\n \"ios_behavior\": \"\",\n \"android_behavior\": \"\",\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"social_title\": \"\",\n \"social_description\": \"\",\n \"social_image_url\": \"\"\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/update-link/aae848d6-f481-41db-8e5f-b511b5a75669", "host": [ "{{baseurl}}" ], "path": [ "update-link", "aae848d6-f481-41db-8e5f-b511b5a75669" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 09:08:41 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid Api Key\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}" } ] }, { "name": "Enable/Disable Link", "request": { "auth": { "type": "noauth" }, "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{API-KEY}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"is_enabled\":\"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/chotuCore/pa/v1/links/change-status/:{link-Id}", "host": [ "{{baseurl}}" ], "path": [ "chotuCore", "pa", "v1", "links", "change-status", ":{link-Id}" ], "variable": [ { "key": "{link-Id}", "value": "", "description": "(Required) The unique identifier of the dynamic link whose status you want to update" } ] }, "description": "Use ChottuLink's REST API to enable or disable existing dynamic links in your account. This endpoint allows you to quickly activate or deactivate links without deleting them, making it perfect for campaign management, temporary link suspension, or maintenance operations.\n\n### \\# EndPoint :\n\n`PATCH` [https://api2.chottulink.com/chotuCore/pa/v1/links/change-status/{linkId}](https://api2.chottulink.com/chotuCore/pa/v1/links/change-status/%7BlinkId%7D)\n\n---\n\n### \\# Authentication :\n\nInclude your API key in the request header:\n\n`API-KEY: {{API-KEY}}`\n\n---\n\n### \\# Path Parameters :\n\n| Parameter | Type | Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| linkId | string | Yes | The unique identifier of the link to enable/disable | `aae848d6-f481-41db-8e5f-b511b5a75669` |\n\n---\n\n### \\# Request Parameters :\n\n**Enable/Disable Guidelines:**\n\n- The `is_enabled` parameter is _**required**_\n \n- Set to `true` to enable the link\n \n- Set to `false` to disable the link\n \n- Disabled links will not redirect users and will show an error page\n \n- The link must belong to your organization\n \n\nStatus Parameters:\n\n| Parameter | Type | Required | Description | Values |\n| --- | --- | --- | --- | --- |\n| is_enabled | boolean | Yes | Indicates whether the link should be enabled or disabled | `true`: Enable link
`false`: Disable link |\n\n---\n\n### \\# Example Request :\n\nEnable Link :\n\n``` json\ncurl --location --request PATCH 'https://api2.chottulink.com/chotuCore/pa/v1/links/change-status/aae848d6-f481-41db-8e5f-b511b5a75669' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"is_enabled\": true\n}'\n\n ```\n\nDisable Link :\n\n``` json\ncurl --location --request PATCH 'https://api2.chottulink.com/chotuCore/pa/v1/links/change-status/aae848d6-f481-41db-8e5f-b511b5a75669' \\\n--header 'API-KEY: c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"is_enabled\": false\n}'\n\n ```\n\n---\n\n### \\# Responses :\n\nSuccess Response :\n\n``` json\n{\n \"message\": \"Link enabled/disabled successfully\",\n \"status\": \"success\"\n}\n\n ```\n\nResponse Fields :\n\n| Field | Type | Description | Example |\n| --- | --- | --- | --- |\n| status | string | Response status indicating success | `\"success\"` |\n| message | string | Human-readable success message | `\"Link enabled/disabled successfully\"` |\n\n---\n\nError Responses :\n\nInvalid Link ID:\n\n``` json\n{\n \"code\": 101,\n \"errorMessage\": \"There was one or more validation error(s)\",\n \"error\": {\n \"errorMessage\": \"Invalid linkId! LinkId is not valid for the organization!\",\n \"fieldName\": \"INVALID_VALUE\"\n }\n}\n\n ```\n\nUnauthorized Access :\n\n``` json\n{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid Api Key\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}\n\n ```\n\nMissing Required Field :\n\n``` json\n{\n \"code\": 101,\n \"errorMessage\": \"There was one or more validation error(s)\",\n \"error\": {\n \"errorMessage\": \"is_enabled field is required\",\n \"fieldName\": \"REQUIRED_FIELD_MISSING\"\n }\n}\n\n ```" }, "response": [ { "name": "Success (200)", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "c_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"is_enabled\":\"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api2.chottulink.com/chotuCore/pa/v1/links/change-status/{linkId}", "protocol": "https", "host": [ "api2", "chottulink", "com" ], "path": [ "chotuCore", "pa", "v1", "links", "change-status", "{linkId}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 11:08:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"message\": \"\",\n \"status\": \"\"\n}" }, { "name": "Invalid Link ID (400)", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{api-key}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"is_enabled\":\"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/links/change-status/{linkId}", "host": [ "{{baseurl}}" ], "path": [ "links", "change-status", "{linkId}" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 11:08:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"errorMessage\": \"\",\n \"error\": {\n \"errorMessage\": \"\",\n \"fieldName\": \"\"\n }\n}" }, { "name": "Unauthorized (401)", "originalRequest": { "method": "PATCH", "header": [ { "key": "API-KEY", "value": "{{api-key}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"is_enabled\":\"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseurl}}/links/change-status/{linkId}", "host": [ "{{baseurl}}" ], "path": [ "links", "change-status", "{linkId}" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 31 Oct 2025 11:08:55 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Server", "value": "nginx" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains" } ], "cookie": [], "body": "{\n \"code\": 130,\n \"errorMessage\": \"Authorization Failed!\",\n \"error\": {\n \"errorMessage\": \"Invalid Api Key\",\n \"fieldName\": \"UNAUTHORIZED_ACCESS\"\n }\n}" } ] } ], "description": "### 🔗 Manage Dynamic Links via REST API\n\nUse ChottuLink’s REST API to **create, manage, and retrieve dynamic links** within your organization. These endpoints allow you to list all existing links, generate new ones, toggle link status (enable or disable), and fetch detailed information for any specific link using its Short URL. Ideal for integrating link management features directly into your dashboards or automation workflows." } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } } ], "variable": [ { "key": "baseurl", "value": "https://api2.chottulink.com", "description": "The API base endpoint" }, { "key": "API-KEY", "value": "", "description": "Your REST API integration key (found under Dashboard > Keys)" } ] }