DELETE/api/v6/urlshortener/links/{domain}/{code}

Delete a short link

The link stops redirecting and disappears from the API. Its code stays taken, and you can restore it for 90 days.

Scope and limits

Scope

API key with the urlshortener service enabled and the urlshortener.write capability granted

Usage limit

35 requests per second

A soft delete: the link stops redirecting right away (the visitor gets 404) and disappears from every API response, statistics included. What was charged is kept, and who deleted it is recorded. Its code stays taken forever on that domain: nobody can create another link with it, but you can restore this one, with no new charge, for 90 days. After that the link is archived with its visits and can no longer be restored; the code stays taken.

A link blocked by Hablame (status: blocked) cannot be deleted: it returns 409 LINK_BLOCKED.

Requires a key that can write

Besides the urlshortener service, the API key needs the urlshortener.write capability, which only an owner or an administrator of your organization can grant when creating the key. Without it, the key lists and reads links, statistics, the overview, the domains and the pricing, and gets 403 AUTH_CAPABILITY_NOT_ALLOWED here.

Path parameters

domain
stringrequired
Domain of the link, as the API returns it in domain. Compared in lowercase. It names the link that answers at that short URL today; for one on a domain that no longer belongs to your organization (domainStatus: released), add domainStatus=released.
code
stringrequired
Code or alias of the link. Compared in lowercase.

Query parameters

domainStatus
stringoptional
With released, the link is the one on a domain that no longer belongs to your organization (the one the list returns with domainStatus: released), even if that name is today another domain with the same code. Without it, domain names the domain that has that name today. Any other value returns 400 VALIDATION_INVALID_PARAMETER.
released

Responses

204

Link deleted. The response has no body.

401

Invalid or missing credentials.

403

The API key does not have the URL shortener enabled (or it is turned off for your organization), lacks the urlshortener.write capability to create and edit links, cannot be used from the request network, or the organization is not active.

404

No link of your organization with that domain and code, or it was already deleted.

409

The link is blocked by Hablame.

429

Request limit exceeded.

Possible errors

Codes this endpoint can return in error.code. The full detail lives in the catalog.

See the full catalog
DELETE /api/v6/urlshortener/links/{domain}/{code}
curl -X DELETE 'https://developers.hablame.co/api/v6/urlshortener/links/h0b.co/a1b2c3d' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer hk_YOUR_API_KEY'

Try-It

Run the request against the real API with your own API key.

The key is used only in your browser for this request. It is not stored nor sent anywhere else.

Parameters

Domain of the link, as the API returns it in domain. Compared in lowercase. It names the link that answers at that short URL today; for one on a domain that no longer belongs to your organization (domainStatus: released), add domainStatus=released.

Code or alias of the link. Compared in lowercase.

With released, the link is the one on a domain that no longer belongs to your organization (the one the list returns with domainStatus: released), even if that name is today another domain with the same code. Without it, domain names the domain that has that name today. Any other value returns 400 VALIDATION_INVALID_PARAMETER.

DELETE https://developers.hablame.co/api/v6/urlshortener/links/h0b.co/a1b2c3d

Response

You have not sent a request yet.