Skip to Content
GuidesAPI Reference
LinksUpdate Link
PATCH/api/v1/links/:id

Update a link

Partially update an existing link. Only fields included in the request are changed. Pass null explicitly to clear a nullable field.

Authorization
Authorizationstringheaderrequired

Bearer token. Format: Bearer YOUR_API_KEY

Path Parameters
idstringpathrequired

The ID of the link to update.

Bodyapplication/json
urlstringbodyoptional

New destination URL.

titlestring | nullbodyoptional

Display name. Pass null to clear.

descriptionstring | nullbodyoptional

Meta description. Pass null to clear.

imagestring | nullbodyoptional

OG image URL. Pass null to clear.

redirectType301 | 302 | 307 | 308bodyoptional

HTTP redirect type.

isActivebooleanbodyoptional

Enable or disable the link.

cloakedbooleanbodyoptional

Hide the destination URL from the browser.

passwordstring | nullbodyoptional

Password protection. Pass null to remove.

expiresAtstring | null (ISO 8601)bodyoptional

Expiry timestamp. Pass null to remove.

maxClicksnumber | nullbodyoptional

Click cap. Pass null to remove.

tagIdsstring[]bodyoptional

Replaces the full tag list for this link.

forwardParametersbooleanbodyoptional

Forward query parameters to destination.

blockBotsbooleanbodyoptional

Block bot traffic.

metaPixelIdstring | nullbodyoptional

Facebook/Meta Pixel ID. Pass null to clear.

googleTagIdstring | nullbodyoptional

Google Analytics measurement ID. Pass null to clear.

webhookUrlsstring | nullbodyoptional

Comma-separated webhook URLs. Pass null to clear.

Last updated on