Reference

`GET` /status

Get a status of API key.

Example request

curl --request GET \
 --url https://api.linkdrip.com/v1/status \
 --header 'accept: application/json' \
 --header 'Authorization: Bearer [YOUR_API_KEY]'

Example response

{
  "success": true,
  "data": {
    "status": "ok"
  }
}

`POST` /create

Create a new link.

Example request

 curl --request POST \
 --url https://api.linkdrip.com/v1/create \
 --header 'accept: application/json' \
 --header 'Authorization: Bearer [YOUR_API_KEY]' \
 --data '{
    "target_url": "https://www.google.com",
    "title": "Title To Display",
    "description": "Description to show for the link",
    "og_image": "https://www.cdn.stuff.com/image.jpg",
    "utm_campaign": "UTM Campaign parameter",
    "utm_content": "UTM Content parameter",
    "utm_medium": "UTM Medium parameter",
    "utm_source": "UTM Source parameter",
    "utm_term": "UTM Term parameter",
    "custom_domain": "simonl.ink",
    "project_name": "Newsletters",
    "workspace_name": "LinkDrip Workspace"
  }'

Example response

{
  "success": true,
  "data": {
    "short_link": "https://drp.li/xUas9",
    "target_url": "https://www.goggle.com",
    "title": "Title To Display",
    "description": "Description to show for the link",
    "og_image": "https://www.cdn.stuff.com/image.jpg",
    "utm_campaign": "UTM Campaign parameter",
    "utm_content": "UTM Content parameter",
    "utm_medium": "UTM Medium parameter",
    "utm_source": "UTM Source parameter",
    "utm_term": "UTM Term parameter"
  }
}

The API returns only existing values. For example, if an attribute such as utm_term is set to null in the request, it will not be included in the response.

Reference attribute options for creating and updating links:

Attribute	isRequired	Description
target_url	true	Destination of your link.
title	false	OG data. If is not provided in the request, the system automatically retrieves it from the target URL and stores it along with the link.
description	false	OG data. If is not provided in the request, the system automatically retrieves it from the target URL and stores it along with the link.
og_image	false	OG data. If is not provided in the request, the system automatically retrieves it from the target URL and stores it along with the link.
utm_campaign	false	UTM Campaign parameter.
utm_content	false	UTM Content parameter.
utm_medium	false	UTM Medium parameter.
utm_source	false	UTM Source parameter.
utm_term	false	UTM Term parameter.
custom_domain	false	Custom domain. If a custom domain is provided, but is not owned and active by the user, the endpoint will return an error.
project_name	false	Project/Folder name. If a workspace or project name is provided, but does not exists/not owned by the account, the endpoint will return an error. If a workspace or project name is not provided, the link will be stored in the personal space in the default project.
workspace_name	false	Workspace name. If a workspace or project name is provided, but does not exists/not owned by the account, the endpoint will return an error. If a workspace or project name is not provided, the link will be stored in the personal space in the default project.

`GET` /:id

Get a specific link by ID.

Example request

curl --request GET \
 --url https://api.linkdrip.com/v1/xUas9 \
 --header 'accept: application/json' \
 --header 'Authorization: Bearer [YOUR_API_KEY]'

Example response

{
  "success": true,
  "data": {
    "short_link": "https://drp.li/xUas9",
    "target_url": "https://www.goggle.com",
    "title": "Title To Display",
    "description": "Description to show for the link",
    "og_image": "https://www.cdn.stuff.com/image.jpg",
    "utm_campaign": "UTM Campaign parameter",
    "utm_content": "UTM Content parameter",
    "utm_medium": "UTM Medium parameter",
    "utm_source": "UTM Source parameter",
    "utm_term": "UTM Term parameter"
  }
}

The API returns only existing values. For example, if an attribute such as utm_term is set to null in the request, it will not be included in the response.

`PUT` /:id

Update a specific link by ID.

Example request

curl --request PUT \
 --url https://api.linkdrip.com/xUas9 \
 --header 'accept: application/json' \
 --header 'Authorization: Bearer [YOUR_API_KEY]' \
 --data '{
    "target_url": "https://www.google.com",
    "title": "Title To Display",
    "description": "Description to show for the link",
    "og_image": "https://www.cdn.stuff.com/image.jpg",
    "utm_campaign": "UTM Campaign parameter",
    "utm_content": "UTM Content parameter",
    "utm_medium": "UTM Medium parameter",
    "utm_source": "UTM Source parameter",
    "utm_term": "UTM Term parameter",
    "custom_domain": "simonl.ink",
    "project_name": "Newsletters",
    "workspace_name": "LinkDrip Workspace"
  }'

Example response

{
  "success": true
}

The API returns only existing values. For example, if an attribute such as utm_term is set to null in the request, it will not be included in the response.

Reference attribute options for creating and updating links:

Attribute	isRequired	Description
target_url	false	Destination of your link.
title	false	OG data.
description	false	OG data.
og_image	false	OG data.
utm_campaign	false	UTM Campaign parameter.
utm_content	false	UTM Content parameter.
utm_medium	false	UTM Medium parameter.
utm_source	false	UTM Source parameter.
utm_term	false	UTM Term parameter.
custom_domain	false	Custom domain.
project_name	false	Project/Folder name.
workspace_name	false	Workspace name.

`DELETE` /:id

Removed a specific link by ID.

Example request

curl --request DELETE \
 --url https://api.linkdrip.com/xUas9 \
 --header 'accept: application/json' \
 --header 'Authorization: Bearer [YOUR_API_KEY]' \

Example response

{
  "success": true,
  "data": {
    "short_link": "https://drp.li/xUas9",
    "target_url": "https://www.goggle.com",
    "title": "Title To Display",
    "description": "Description to show for the link",
    "og_image": "https://www.cdn.stuff.com/image.jpg",
    "utm_campaign": "UTM Campaign parameter",
    "utm_content": "UTM Content paremeter",
    "utm_medium": "UTM Medium parameter",
    "utm_source": "UTM Source paremeter",
    "utm_term": "UTM Term paremeter"
  }
}

The API returns only existing values. For example, if an attribute such as utm_term is set to null in the request, it will not be included in the response.

Get Started

Reference

GET /status

POST /create

GET /:id

PUT /:id

DELETE /:id

`GET` /status

`POST` /create

`GET` /:id

`PUT` /:id

`DELETE` /:id