Skip to main content
destination_url is the only required field. Everything else has a sensible default.
This endpoint takes multipart/form-data because it can carry a preview image. With cURL that means -F rather than -d.

The fields that matter most

Grouped by what you are trying to do

Set utm_analytics_enabled=true and the UTM fields are appended to the destination URL:
Also available: utm_term, utm_content, utm_id. See UTM parameters.
Visitors see a password prompt before the redirect. See Password protection.
See Routing rules.

Updating

update_shortlink takes the same fields plus name to say which link:
Only the fields you send are changed. Changing destination_url takes effect immediately for everyone, including people who saved the link months ago — which is the point of a Shortlink, and also the risk.

Deleting

Bulk-only, even for one link:
Deleting a link breaks it everywhere it has already been shared. If the goal is to stop it working but keep the record and its analytics, disable it instead: bulk_edit with action="disable".