TOOL API

tool_open_url_get

Gets the corresponding TikTok in-app link for an open TikTok URL. The returned in-app link can be passed to the `deeplink` field when creating or updating a Reach & Frequency ad. TikTok in-app links is currently an allowlist-only feature; contact your TikTok representative for access. This endpoint is `/open_api/v1.3/tool/open_url/`. Compared with v1.2 (`/v1.2/tools/open_url/`), v1.3 uses `/v1.3/tool/open_url/` and changes `advertiser_id` from number to string.

ecommerceOAuth1 credits

Call information

Tool slug: tiktok-ads.tool_open_url_get
Provider: TikTok for Business
Average response: 0 ms
Calls in 7 days: 0

Input parameters

advertiser_idrequired

Advertiser ID.

urlrequired

Open TikTok URL to convert into a TikTok internal link.

url_typerequired

Type of the open TikTok URL. Supported values: `USER_PROFILE`; `VIDEO` for a video detail page; `HASHTAG_CHALLENGE` for a hashtag challenge page; `MUSIC` for a music page; `STICKER` for a sticker (special effect) page; `STICKER_SHOOTER` to shoot a video with a sticker (special effect).