Update link with the Dub API

Changes a short link; only the fields sent change. A new domain or key changes the short link itself, and archived true hides the link from List links.

Identifier
dub_update_link

The request

POST https://connect.reportei.com/api/tools/dub_update_link/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "linkId": "<linkId>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
linkIdstringYesId of the link, from List links, Get link or Create link.
urlstringNoNew destination URL.
domainstringNoDomain of the short link, without protocol, from List domains.
keystringNoSlug of the short link, the part after the domain.
archivedbooleanNotrue archives the link, false restores it.
tagIdsarrayNoIds of all the tags of the link, from List tags or Create tag.
folderIdstringNoId of the folder of the link, from List folders.
commentsstringNoInternal notes about the link.
utm_sourcestringNoUTM source added to the destination URL, replacing the one in it.
utm_mediumstringNoUTM medium added to the destination URL, replacing the one in it.
utm_campaignstringNoUTM campaign added to the destination URL, replacing the one in it.
utm_termstringNoUTM term added to the destination URL, replacing the one in it.
utm_contentstringNoUTM content added to the destination URL, replacing the one in it.
trackConversionbooleanNotrue tracks leads and sales of the link. The workspace needs conversion tracking set up.
expiresAtstringNoWhen the link expires.
expiredUrlstringNoWhere the link sends visitors after it expires.
proxybooleanNotrue shows the custom preview of title, description and image when the link is shared.
titlestringNoTitle of the custom preview. Used when proxy is true.
descriptionstringNoDescription of the custom preview. Used when proxy is true.
imagestringNoURL of the image of the custom preview. Used when proxy is true.

Supported connections

Your customer connects their Dub account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/dub, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/dub_update_link. It becomes your agent's tool definition with no conversion.

Other Dub tools

See all 10 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.