Skip to main content


Actually, we don't expose our GraphQL endpoint for creating link. We are working hard to allow it. In the meantime, you can use this endpoint to do it.

Domain and are only availables trought API for officials integrations.

If you want to make an official integration, feel free to reach us on our live chat. You can find our chat on the website or within the app! ๐Ÿ˜Š


Minimal curl example

curl '' \  
-H 'Content-Type: application/json' \
-H 'Api-Authorization: YOUR_TOKEN_HERE'
-d \
"link": {
"title": "",
"description": "",
"url": "",
"pixels": [],
"showGDPR": false,
"extraOptionsLinkRotator": [],
"extraOptionsGeolocations": [],
"tags": []

More complex curl example

curl '' \  
-H 'Content-Type: application/json' \
-H 'Api-Authorization: YOUR_TOKEN_HERE'
-d \
"link": {
"title": "My title",
"description": "My description",
"url": "",
"image": "",
"pixels": [
"createdAt": "2021-01-30T08:03:34.568+00:00",
"id": "pixel id",
"platform": "twitter",
"title": "pixel title",
"value": "tixel value",
"workspaceId": 5972
"showGDPR": true,
"extraOptionsGeolocations": [
"url": "",
"value": "AO"
"tags": [
"domain": "",
"id": "my-slug",
"folderId": 10313,
"favicon": "",
"linkExpiration": {
"enable": true,
"timezone": 4,
"url": "",
"end": "2021-12-29T10:03:51.421Z"
"deepLinkingEnable": true,
"note": "My Notes",
"passwordProtect": {
"enable": true,
"password": "123"

JSON Parameters

ParameterDescriptionTypeDefault value
linkLink to create for the redirectionLinkno default value
autofillServer will add automatically open graph metadatabooleantrue
ParameterDescriptionTypeDefault value
urlMandatory Url to redirectString
domainMandatory Domain name of the
idAlias slug, it's the id of your link (domainName/id)StringrandomId()
titleUsed for the open graph titleStringnull (can be autofill with the autofill parameter)
descriptionUsed for the open graph descriptionStringnull (can be autofill with the autofill parameter)
imageUsed for the open graph description, must be an urlStringnull (can be autofill with the autofill parameter)
pixelsUsed for pixelling your short link and retargeting purposePixel[][]
showGDPRDisplay the GDPR popup if pixels are presentsBooleanfalse
tagsUsed for searching and sorting in the dahsboardString[][]
noteSome notes visible in admin panelStringnull
deepLinkingEnableEnable Deeplink if it is possibleBooleanfalse
linkScriptsList of script wihch will be added to a link if linkScriptEnable is trueInt[]null
linkScriptEnableEnable linkScripts connected to a linkBooleanfalse
maskingEnable link cloakingBooleanfalse
linkExpirationSet up date then link will be expiried and redirect endpointLinkExpirationnull
passwordProtectShow password protection popupPasswordProtectnull

Pixel type

ParameterDescriptionTypeDefault value
platformMandatory Which platform belongs the pixelPlatform
valueMandatory Value of the pixelString
idIt's the id of your pixel in the databaseUUIDrandomId()

LinkExpiration type

ParameterDescriptionTypeDefault value
enableMandatory Is link expiration enabledBoolean
endMandatory link exparation end date - exaxmple: 2021-11-11T06:59:01.499ZString
urlMandatory Url the link will be redirected then link become expiredUUIDrandomId()
timezoneMandatory timezoneInt

PasswordProtect type

ParameterDescriptionTypeDefault value
enableMandatory Is password protection enabledBoolean
passwordMandatory Password of protected linkString
type Platform =
| 'linkedin'
| 'facebook'
| 'gtm'
| 'quora'
| 'pinterest'
| 'twitter'
| 'ga'
| 'bing'
| 'nexus'
| 'adroll'
| 'adwords';

Rate limits: 10.000 links/day; 1.000 links/hour max. For any higher limits needs, please reach us on our chat.