Create Link
Creates a new link in the current workspace. The API enforces plan limits and feature availability for the authenticated organization.
Request body
Need to attach a stored social preview image that already lives on ShortPen? Setsocial_share_image_datato the base64 payload provided by previous uploads or send the legacysocial_share_image_sessionvalue.
Response highlights
data.id: ID of the new link, theurl_idof Edit Link.data.link— fully qualified link combining the selected domain and slug.data.short_url— same value aslink. Deprecated — will be removed in a future version; migrate todata.link.data.qr— base64-encoded PNG whengenerate_qrevaluates to true; otherwisenull.data.created—truefor newly created links.
message so you can trigger a plan upgrade workflow or notify an operator.
PUT or PATCH /v1/links.Authorizations
Body
Common fields shared between link creation and editing.
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