Create a new link - Tapper Documentation

POST

links

curl --request POST \
  --url https://itlinks.to/v1/links/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "name": "<string>",
    "domain": "itlinks.to",
    "slug": "ExampleSlug",
    "tags": [
      "<string>"
    ],
    "rules": [
      {
        "name": "<string>",
        "active_from": "2023-11-07T05:31:56Z",
        "active_to": "2023-11-07T05:31:56Z",
        "locations": [
          {
            "type": "country",
            "id": "ISO 3166-1 alpha-3 country code, or one of: ['\''Africa'\'', '\''Antarctica'\'', '\''Asia'\'', '\''Australia'\'', '\''Europe'\'', '\''North America'\'', '\''Oceania'\'', '\''South America'\'']"
          }
        ],
        "device_types": [
          "Desktop"
        ],
        "oses": [
          "Mac OS"
        ],
        "week_days": [
          "MONDAY"
        ],
        "day_time_ranges": [
          {
            "time_from": "22:00",
            "time_to": "23:00"
          }
        ],
        "url_ratios": [
          {
            "name": "<string>",
            "meta_title": "<string>",
            "meta_description": "<string>",
            "meta_media_url": "<string>",
            "url": "<string>",
            "mobile_app_os_id": 2,
            "scripts": [
              2
            ],
            "ratio": 123
          }
        ]
      }
    ]
  }
}'

{
  "data": {
    "id": 2
  }
}

Authorizations

Authorization

string

header

required

Body

application/json

data

object

required

data.name

string

required

The name of the link to be created.

Maximum length: 320

data.domain

string

required

The domain associated with the new link.

Example:

"itlinks.to"

data.slug

string

required

A URL-friendly identifier for the link.

Maximum length: 320

Example:

"ExampleSlug"

data.rules

object[]

required

data.rules.url_ratios

object[] | null

required

A list of URL ratios defining how different URLs should be distributed.

data.rules.name

string | null

The name of the rule.

Maximum length: 320

data.rules.active_from

string | null

The starting date from which the rule is active.

data.rules.active_to

string | null

The ending date until which the rule is active.

data.rules.locations

object[] | null

A list of locations where the rule applies.

data.rules.device_types

enum<string>[] | null

The types of devices targeted by the rule.

Available options:

Desktop,

Mobile,

Tablet,

iPod,

SmartTV,

Console,

Wearable,

Embedded,

Curl,

Bot

data.rules.oses

enum<string>[] | null

The operating systems targeted by the rule.

Available options:

Mac OS,

iOS,

Android,

Windows,

Windows Mobile OS

data.rules.week_days

enum<string>[] | null

The days of the week when the rule is active.

Available options:

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY,

SUNDAY

data.rules.day_time_ranges

object[] | null

The time ranges during the day when the rule is active.

data.tags

string[]

A list of tags for categorizing the link.

Response

200

application/json

Link created successfully

data

object

Retrieve multiple links Get a single link

curl --request POST \
  --url https://itlinks.to/v1/links/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "name": "<string>",
    "domain": "itlinks.to",
    "slug": "ExampleSlug",
    "tags": [
      "<string>"
    ],
    "rules": [
      {
        "name": "<string>",
        "active_from": "2023-11-07T05:31:56Z",
        "active_to": "2023-11-07T05:31:56Z",
        "locations": [
          {
            "type": "country",
            "id": "ISO 3166-1 alpha-3 country code, or one of: ['\''Africa'\'', '\''Antarctica'\'', '\''Asia'\'', '\''Australia'\'', '\''Europe'\'', '\''North America'\'', '\''Oceania'\'', '\''South America'\'']"
          }
        ],
        "device_types": [
          "Desktop"
        ],
        "oses": [
          "Mac OS"
        ],
        "week_days": [
          "MONDAY"
        ],
        "day_time_ranges": [
          {
            "time_from": "22:00",
            "time_to": "23:00"
          }
        ],
        "url_ratios": [
          {
            "name": "<string>",
            "meta_title": "<string>",
            "meta_description": "<string>",
            "meta_media_url": "<string>",
            "url": "<string>",
            "mobile_app_os_id": 2,
            "scripts": [
              2
            ],
            "ratio": 123
          }
        ]
      }
    ]
  }
}'

{
  "data": {
    "id": 2
  }
}