API Reference
DUB LINKS API
Links

Delete a link

Delete a link for the authenticated workspace.

1 min read

delete/links/{linkId}

Request example

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.links.delete(link_id="<id>")

    # Handle response
    print(res)

Response

{
  "id": "<string>"
}

delete/links/{linkId}

Authorization

Authorizationstringheaderrequired#

Default authentication mechanism

Path parameters

linkIdstringrequired#

The id of the link to delete. You may use either linkId (obtained via /links/info endpoint) or externalId prefixed with ext_.

Responses

application/json

The deleted link ID.

idstringrequired#

The ID of the link.

errorobjectrequired#

Show child attributesHide child attributes

codeenum<string>required#

A short code indicating the error code returned.

Options:bad_request

messagestringrequired#

A human readable explanation of what went wrong.

doc_urlstring#

A link to our documentation with more details about this error code

errorobjectrequired#

Show child attributesHide child attributes

codeenum<string>required#

A short code indicating the error code returned.

Options:unauthorized

messagestringrequired#

A human readable explanation of what went wrong.

doc_urlstring#

A link to our documentation with more details about this error code

errorobjectrequired#

Show child attributesHide child attributes

codeenum<string>required#

A short code indicating the error code returned.

Options:forbidden

messagestringrequired#

A human readable explanation of what went wrong.

doc_urlstring#

A link to our documentation with more details about this error code

errorobjectrequired#

Show child attributesHide child attributes

codeenum<string>required#

A short code indicating the error code returned.

Options:not_found

messagestringrequired#

A human readable explanation of what went wrong.

doc_urlstring#

A link to our documentation with more details about this error code

errorobjectrequired#

Show child attributesHide child attributes

codeenum<string>required#

A short code indicating the error code returned.

Options:conflict

messagestringrequired#

A human readable explanation of what went wrong.

doc_urlstring#

A link to our documentation with more details about this error code

errorobjectrequired#

Show child attributesHide child attributes

codeenum<string>required#

A short code indicating the error code returned.

Options:invite_expired

messagestringrequired#

A human readable explanation of what went wrong.

doc_urlstring#

A link to our documentation with more details about this error code

errorobjectrequired#

Show child attributesHide child attributes

codeenum<string>required#

A short code indicating the error code returned.

Options:unprocessable_entity

messagestringrequired#

A human readable explanation of what went wrong.

doc_urlstring#

A link to our documentation with more details about this error code

errorobjectrequired#

Show child attributesHide child attributes

codeenum<string>required#

A short code indicating the error code returned.

Options:rate_limit_exceeded

messagestringrequired#

A human readable explanation of what went wrong.

doc_urlstring#

A link to our documentation with more details about this error code

errorobjectrequired#

Show child attributesHide child attributes

codeenum<string>required#

A short code indicating the error code returned.

Options:internal_server_error

messagestringrequired#

A human readable explanation of what went wrong.

doc_urlstring#

A link to our documentation with more details about this error code

Upsert link Retrieve link

github linkedin twitter website