Update a link

Branded short links can be updated via a PUT method to https://app.linksgpt.com/api/v1/links/{id}, where {id} is the unique identifier (id) of the branded short link, If you don't know the link's id in advance, you can fetch it first with another API call. See List your links.

REQUEST EXAMPLE

cURL

curl 'https://app.linksgpt.com/api/v1/links/1678662715674986986' \
-X PUT \
-H 'apikey: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Language: en' \
-d \
'{
  "domain": "1664552993913047093",
  "title": "Linksgpt",
  "destination": "https://www.linksgpt.com",
  "path": "MdlM",
  "tags": [
    "Linksgpt"
  ],
  "utm": {
    "source": "facebook",
    "medium": "ad",
    "campaign": "summer_sale",
    "content": "image_ad1"
  }
}'

PATH PARAMETERS

Parameter	Constraints	Description
id	required	Unique identifier of the branded short link you want to update.

QUERY PARAMETERS

Parameter	Constraints	Description
workspace	optional	Your workspace id, if you do not specify the workspace context, the default workspace (your main workspace) will be used. If apikey is used as the authentication mode, you do not need to set this parameter.

REQUEST BODY

Content-Type: application/json

Payload Example

JSON

{
  "domain": "1646752269439338932",
  "title": "LinksGPT",
  "destination": "https://www.linksgpt.com",
  "path": "xxxx",
  "utm": {
    "source": "facebook",
    "medium": "ad",
    "campaign": "summer_sale",
    "content": "image_ad1"
  },
  "tags": [
    "tag1",
    "tag2"
  ]
}

Property	Type	Constraints	Description
domain	string	optional	A reference to the Domain resource for this short link. Specify either domain id or domain fullName. If not specified, will not be updated.
title	string	optional	A title you assign to the short link in order to remember what's behind it. If not specified, will not be updated.
destination	string	optional	The destination URL you want your branded short link to point to, will not be updated.
path	string	optional	The keyword portion of your branded short link. If not specified, will not be updated.
utm	object	optional	UTM params.
tags	array of strings	optional	Unique identifier of the Tag resource. If not specified, will not be updated. e.g. ["tag1", "tag2"]

RESPONSE EXAMPLE

JSON

{
  "code": 0,
  "message": "success",
  "data": null
}

See more HTTP Responses

RESPONSE DATA

The update link request has no actual data returned.