Short links
Create and manage short links inside a project.
GET /shorts/availability
Check short_name availability
Checks whether the host + `short_name` combination is free before creating a link.
Behaviour
Errors: 400 (validation), 404 (`subdomain_not_found_error`), 403 (API key permissions).
Query parameters
Responses
DELETE /shorts/bulk
Bulk delete short links
Deletes the listed short links in one request.
Behaviour
HTTP 204 — all deleted; HTTP 207 — partial delete (see `errors`).
Request body (JSON)
Responses
PATCH /shorts/bulk
Bulk update short links
Updates several short links in one request.
Behaviour
Request body (JSON)
Responses
GET /shorts/{scope_id}
List short links
Returns short links in the given scope with optional filtering.
Behaviour
Boolean flags (`with_password`, `with_captcha`, `with_expiration`, `with_beginning`, `with_max_clicks`, `with_budget`) select links with/without those constraints. `tags_mode`: `any` or `all`. Archive is hidden by default — pass `is_archived=true` to include it. Response 200.
Path parameters
Query parameters
Responses
POST /shorts/{scope_id}
Create a short link
Creates one short link in the given scope.
Behaviour
Path parameters
Request body (JSON)
Responses
POST /shorts/{scope_id}/bulk
Bulk create short links
Creates several short links in one request.
Behaviour
HTTP 201 — all created; HTTP 207 — partial success (see `errors`).