POST
/
links
Create a new link
curl --request POST \
  --url https://api.codeqr.io/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://google.com",
  "domain": "<string>",
  "key": "<string>",
  "externalId": "123456",
  "prefix": "<string>",
  "trackConversion": false,
  "archived": false,
  "expiresAt": "2023-11-07T05:31:56Z",
  "expiredUrl": "<string>",
  "password": null,
  "proxy": false,
  "title": null,
  "description": null,
  "image": null,
  "video": null,
  "rewrite": false,
  "ios": null,
  "android": null,
  "geo": null,
  "doIndex": false,
  "webhookIds": [
    "<string>"
  ],
  "publicStats": false,
  "tagId": "<string>",
  "tagIds": [
    "clux0rgak00011..."
  ],
  "tagNames": "<string>",
  "comments": "<string>",
  "flexible": false,
  "preRedirection": false,
  "pageId": "<string>",
  "pageUrl": "<string>",
  "isFormMandatory": false
}'
{
  "id": "<string>",
  "domain": "<string>",
  "key": "<string>",
  "url": "<string>",
  "archived": false,
  "expiresAt": "<string>",
  "expiredUrl": "<string>",
  "trackConversion": false,
  "flexible": false,
  "doIndex": false,
  "password": "<string>",
  "externalId": "<string>",
  "proxy": false,
  "title": "<string>",
  "description": "<string>",
  "image": "<string>",
  "video": "<string>",
  "rewrite": false,
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "publicStats": false,
  "tagId": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "red"
    }
  ],
  "comments": "<string>",
  "notificationToken": "<string>",
  "shortLink": "<string>",
  "qrCode": "<string>",
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "userId": "<string>",
  "projectId": "<string>",
  "clicks": 0,
  "leads": 0,
  "sales": 0,
  "saleAmount": 0,
  "lastClicked": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "preRedirection": false,
  "pageId": "<string>",
  "pageUrl": "<string>",
  "isFormMandatory": false
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Body

application/json

Response

200
application/json

The created link

The response is of type object.