Skip to content
Log in
Developer API
Get your keyGet a key

Reference · Your page

PATCH/short-links/{linkId}

Change a short link, or turn it off

Change where a short link sends people, its name, its ending (Plus plan and up) or its device and country rules (rules, the whole list, Plus plan and up), or turn it off (on: false, it stops sending anyone) and back on. Find ids with GET /api/v1/short-links. Free.

Key needs
create · Make things and spend credits
Spends
Nothing
Answers
Data
Request
curl -X PATCH https://vessero.com/api/v1/short-links/2b1a0f9e-8d7c-4b6a-95f4-e3d2c1b0a9f8 \
  -H "Authorization: Bearer $VESSERO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Path

  • linkIdstringrequired—

Body

  • urlstringThe new address it sends people to.
  • titlestringA new name for the person’s own list.
  • slugstringA new ending (Plus plan and up).
  • onbooleanfalse turns it off; true back on.
  • rulesobject[] · up to 6Some visitors sent elsewhere, the first rule that fits winning; everyone else goes to the link’s own address. [] takes them all off. Plus plan and up.
    • devicestringSend visitors on this device: ios (iPhone and iPad), android (Android), phone (Any phone or tablet), computer (A computer).iosandroidphonecomputer
    • countriesstring[] · up to 30Or send visitors in these countries, as two-letter codes (NG, GB, US).
    • urlstringrequiredWhere those visitors go.

Answers

  • 200okWhat it did, as data.
  • 400invalid_requestA field is missing or not accepted: see details.
  • 404not_foundNot found on this account.
  • 403feature_unavailableThe studio this needs is switched off for the account right now.