Delete Existing Deep Link

  • Updated on Nov 6, 2025
  • Published on Feb 25, 2025
Prev Next
Delete
/url

This endpoint is used to delete existing deep link.

Note: This endpoint requires both App-Level and Sensitive Data permissions. You must pass an Access Token (API key) to use the DELETE method. Otherwise you may see an Unauthorized User error. See the Deep Linking API Overview's Authentication section for details.

Header parameters
Access-Token
stringRequired

The Branch Access Token of the originating app obtained in your Account Settings

Query parameters
url
stringRequired

The deep link url against which the details are to be fetched.

Examplehttps://example.app.link/{UNIQUE_PATH_HERE}
app_id
stringRequired

The Branch app_id against the associate deep link url

Responses
200

Ok

object
url
string

Deleted URL

Examplehttps://example.app.link/{UNIQUE_PATH_HERE}
deleted
boolean

Deletion status

Exampletrue
400

Authentication Failed

Result
"{\n    \"error\": {\n        \"message\": \"Authentication failed !\",\n        \"code\": 400\n    }\n}"
Expand All
object
error
object (inline_response_400_error)
message
string
ExampleAuthentication failed !
code
integer
Example400
429

Rate Limit Reached

Result
"{\n    \"error\": {\n        \"code\": 429,\n        \"message\": \"Rate limit reached.\"\n    }\n}"
Expand All
object
error
object (inline_response_400_error)
message
string
ExampleAuthentication failed !
code
integer
Example400
Tags