TOOL API
tto_
Creates a TikTok One webpage anchor for the web destination link type via `/open_api/v1.3/tto/tcm/anchor/create/`. This endpoint creates a `WEB_ANCHOR` with `anchor_sub_type=DESTINATION`, which displays a website link above a creator's video description and in the comment section. The destination subtype is available only in countries where TikTok Shop is not yet available; TikTok Shop is currently available in Indonesia, Thailand, Vietnam, Philippines, Malaysia, Singapore, United States, United Kingdom, and Saudi Arabia. To use this endpoint, you need a TTO Creator Marketplace account ID associated with the authorized `Access-Token`; retrieve accessible account IDs from `/tto/oauth2/tcm/`.
Call information
- Tool slug
- tiktok-ads.tto_tcm_anchor_create
- Provider
- TikTok for Business
- Average response
- 0 ms
- Calls in 7 days
- 0
Input parameters
anchor_namerequiredThe internal name of the anchor. Maximum length: 32 characters. This value is not shown to users in the TikTok app.
anchor_sub_typeRequired when `anchor_type` is `WEB_ANCHOR`. The specific webpage anchor type. Supported value: `DESTINATION`, which directs viewers to a web destination link that opens in TikTok and appears both in the creator's video and the comment section. When `anchor_sub_type` is `DESTINATION`, you must also provide `category_label_id` and `call_to_action.landing_page_url`. This subtype is available only in countries where TikTok Shop is not yet available; TikTok Shop is currently available in Indonesia, Thailand, Vietnam, Philippines, Malaysia, Singapore, United States, United Kingdom, and Saudi Arabia.
anchor_titlerequiredThe anchor title. When `anchor_sub_type` is `DESTINATION`, supported values are `WATCH_NOW`, `LISTEN_NOW`, `READ_MORE`, `SHOW_NOW`, `GET_OFFER`, `LEARN_MORE`, `CONTACT_US`, `JOIN_NOW`, and `APPLY_NOW`.
anchor_typerequiredThe anchor type. Supported value: `WEB_ANCHOR`, which creates a webpage anchor that displays your website link above the creator's video description.
call_to_actionrequiredAnchor link information. When `anchor_sub_type` is `DESTINATION`, you must provide `landing_page_url` in this object.
category_label_idRequired when `anchor_sub_type` is `DESTINATION`. The category ID for your product or service. Supported documented values are: `1` Furniture, `2` Kid's Fashion, `3` Automotive & Motorcycle, `4` Womenswear & Underwear, `5` Home Supplies, `6` Virtual Products, `7` Computers & Office Equipment, `8` Menswear & Underwear, `9` Pet Supplies, `10` Food & Beverages, `11` Pre-Owned, `12` Service, `13` Baby & Nursery, `14` Household Appliances, `15` Textiles & Soft Furnishings, `16` Beauty & Personal Care, `17` Shoes, `18` Toys & Hobbies, `19` Tools & Hardware, `20` Finance, `21` Kitchenware, `22` Phones & Electronics, `23` Fashion Accessories, `24` Home Improvement, `25` Health, `26` Restaurant & bar, `27` Entertainment & media, `28` Travel & hotel, `29` Others, `30` Luggage & Bags, `31` Books, Magazines & Audio, `32` Jewelry Accessories & Derivatives, `33` Collectibles, `34` Muslim Fashion, `35` Sports & Outdoor. When `anchor_sub_type` is `DESTINATION`, the allowed `country_code` values depend on this category.
country_coderequiredThe country or region code for the anchor. The app information from that country or region's app store is used, and the anchor is not available in other countries or regions. When `anchor_sub_type` is `DESTINATION`, supported `country_code` values vary by `category_label_id`, so the selected code must be valid for the chosen category. Example: `AU`.
thumbnail_urlRequired when `upload_type` is `UPLOAD_BY_URL`. A publicly accessible thumbnail URL for the anchor. Requirements: file size within 2 MB; format must be JPEG, PNG, or GIF; resolution must be 210 x 375 pixels. This value is not shown to users in the TikTok app.
tto_tcm_account_idrequiredThe ID of the TTO Creator Marketplace account. Use an account ID that is accessible through the authorized `Access-Token`; obtain valid IDs from `/tto/oauth2/tcm/`.
upload_typerequiredThe thumbnail upload method. If `UPLOAD_BY_URL`, you must provide `thumbnail_url` and send the request with `Content-Type: application/json`.