Link Management
Create a short link
POST /api/links
Access follows your key scope, workspace permissions and subscription. Replace example IDs with records from your own workspace.
Path parameters
No path parameters.
Query parameters
No query parameters.
JSON request body
Provide a valid original_url (originalURL is also accepted). domainId selects your domain; omit it only when your account has a default domain. path is optional: omitting it generates a slug.
Request fields
Field names detected from the handler; this list may be incomplete and does not indicate requiredness or types.
path, slug, original_url, title, description, tags, folder_id, cloaking, password_contact, note, expires_at, expired_url, ttl, clicks_limit, utm_source, utm_medium, utm_campaign, utm_term, utm_content, android_url, iphone_url, android_package, android_action, android_component, split_urls, rotation, redirect_type, skip_qs, url_policy, archived, geo_rules, integration_ga, integration_gtm, integration_fb, integration_adroll, tracking_settings, tracking_code, og, twitter, app_links, qr_style, permissions, bundle_id, routing_rules, app_deep_link, referrer_rules, returning_rule, click_alerts, bot_policy, password, encrypt, domainId
Recent requests
This page only. Credentials and responses are not saved.
| Time | Method | Status |
|---|
Response codes
- 200 / 201
- Read the resource or report; bulk requests can contain item errors.
- 400
- Check IDs, JSON, dates and filters.
- 401
- Check key expiry, revocation and membership.
- 402 / 403
- Check plan, role and key scope.
- 404
- Resource not found in the permitted workspace or domain.
- 429
- Wait for Retry-After and reduce request frequency.
Language
Your key is sent only to this installation when you select Try it.
Response
Run a request to see its response.