Edit Link
Updates an existing link identified by url_id. Only url_id is required — include at least one additional field to specify what to change. Omitted fields retain their current values. The API enforces the same plan limits and feature checks as creation.
url_id along with only the fields you want to change. Omitted fields retain their current values, so you can make targeted updates without resending the entire link configuration.
How it works
Onlyurl_id is strictly required. You must also include at least one additional field to specify what to change — otherwise the API returns a 400 error.
The edit endpoint shares the same internal logic as creation. When url_id is present in the request, the API locates the existing link and applies the supplied fields as an update. Any field you omit is preserved from the existing link, including settings like redirect type, password protection, cloaking, tracking, and social previews.
Both PUT and PATCH methods are accepted and behave identically.
Request body
Updating tags
Thetag_ids field follows the same “only what you send” rule as the rest of the edit endpoint, with one nuance worth calling out:
- Omit
tag_ids— the link’s existing tags are left untouched. - Send an array of IDs — the link’s tags are replaced with exactly that set (
[12, 18]keeps only tags 12 and 18). - Send an empty array
[]— every tag is removed from the link.
"[12,18]" is also accepted.
Response highlights
data.link— the fully qualified link after the update.data.short_url— same value aslink. Deprecated — will be removed in a future version; migrate todata.link.data.qr— base64-encoded QR PNG when a QR code exists; otherwisenull.data.created— alwaysfalsefor edit operations, confirming the link was updated rather than newly created.
Error handling
Authorizations
Body
Only url_id is required. At least one additional field must be provided to specify what to change. Omitted fields retain their current values.
Overrides the title shown in social previews.
Overrides the description shown in social previews.
Base64-encoded image used for the social preview.
IDs of the tags to associate with the link. On creation the listed tags are attached. On edit, sending this field replaces the link's tags with the supplied set — an empty array clears every tag, while omitting the field entirely leaves existing tags untouched. Tags must belong to the same workspace and organization; unknown IDs are ignored. A JSON-encoded string of IDs (e.g. "[12,18]") is also accepted for backwards compatibility.
ID of a QR template of the organization (POST /v1/get with resource: "qr_template"). The link's QR is generated, or regenerated on edit, with the template's design and logo; it implies generate_qr and replaces r, g, b and the logo fields. Paid plans only: a Free plan gets a 403. On create, with generate_qr and no qr_template_id, r, g, b or logo fields, the workspace's default template is used if one is set; null skips it.
7