openapi: 3.2.0 info: title: TikTok API for Business — Marketing Creative Management API description: TikTok API for Business (Marketing API) v1.3. This document is a mechanical union of the 202 per-operation OpenAPI 3.0.1 documents TikTok publishes in yml_files/ of its own SDK repository (https://github.com/tiktok/tiktok-business-api-sdk), which are the swagger-codegen inputs for TikTok's first-party Java/Python/JavaScript SDKs. Operation content (paths, parameters, responses, tags and the x-open-* extensions) is preserved verbatim; only info, servers and components.securitySchemes were written by API Evangelist, because the per-operation fragments carry placeholder info blocks and no servers block. The servers values are the production and sandbox base URLs TikTok documents at https://business-api.tiktok.com/portal/docs?id=1738855331457026 . version: v1.3 contact: name: TikTok API for Business support url: https://business-api.tiktok.com/portal/docs?id=1795190020378625 termsOfService: https://business-api.tiktok.com/portal/docs?id=1737191804348417 x-source: https://github.com/tiktok/tiktok-business-api-sdk/tree/main/yml_files x-harvested-by: API Evangelist enrichment pipeline x-harvested: '2026-08-13' servers: - url: https://business-api.tiktok.com/open_api/v1.3 description: Production - url: https://sandbox-ads.tiktok.com/open_api/v1.3 description: Sandbox security: - AccessToken: [] tags: - name: Creative Management paths: /creative/asset/delete/: post: operationId: Creative Asset Delete parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.advertiser_id image_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.image_ids video_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.video_ids required: - advertiser_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete creative assets. [Asset Delete](https://business-api.tiktok.com/portal/docs?id=1797202997456897) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: string - children: - type: string name: video_ids required: false source: $.http.body.video_ids sub_type: string type: array - children: - type: string name: image_ids required: false source: $.http.body.image_ids sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id image_ids: $.http.body.image_ids video_ids: $.http.body.video_ids response_cookie: [] response_header: [] response_rule: failed_image_ids: $.rpc.output.failed_image_ids failed_video_ids: $.rpc.output.failed_video_ids x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/asset/share/: post: operationId: Creative Asset Share parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id asset_type: default: VIDEO description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: VIDEO value: '3' - description: '' is_valid: true key: IMAGE value: '2' - description: '' is_valid: true key: MUSIC value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.asset_type material_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 20 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.material_ids shared_advertiser_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 10 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.shared_advertiser_ids required: - advertiser_id - material_ids - shared_advertiser_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: SShare creative assets with other advertiser accounts. [Asset Share](https://business-api.tiktok.com/portal/docs?id=1773192725768193) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - children: - type: number name: material_ids required: true source: $.http.body.material_ids sub_type: number type: array - children: - type: number name: shared_advertiser_ids required: true source: $.http.body.shared_advertiser_ids sub_type: number type: array - name: asset_type required: true source: $.http.body.asset_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id asset_type: $.http.body.asset_type material_ids: $.http.body.material_ids shared_advertiser_ids: $.http.body.shared_advertiser_ids response_cookie: [] response_header: [] response_rule: failed_infos: $.rpc.output.failed_infos x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/image/edit/: post: operationId: Creative Image Edit parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id edit_method: default: fix_size description: '' maxLength: 100 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: fix_size value: fix_size - description: '' is_valid: true key: only_gauss_pad value: only_gauss_pad - description: '' is_valid: true key: gauss_padding_reserve_score value: gauss_padding_reserve_score key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 6 x-open-source: $.http.body.edit_method height: description: '' format: int64 minimum: 3 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.height image_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.image_id image_name: description: '' maxLength: 100 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.image_name width: description: '' format: int64 minimum: 3 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.width required: - advertiser_id - image_id - width - height type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Edit an image according to the size you want as well as apply creative trimmings. [Image Edit](https://business-api.tiktok.com/portal/docs?id=1739067107903489) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: image_id required: true source: $.http.body.image_id type: string - name: width required: true source: $.http.body.width type: number - name: height required: true source: $.http.body.height type: number - name: image_name required: false source: $.http.body.image_name type: string - name: edit_method required: true source: $.http.body.edit_method type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id edit_method: $.http.body.edit_method height: $.http.body.height image_id: $.http.body.image_id image_name: $.http.body.image_name width: $.http.body.width response_cookie: [] response_header: [] response_rule: create_time: $.rpc.output.create_time displayable: $.rpc.output.displayable file_name: $.rpc.output.file_name format: $.rpc.output.format height: $.rpc.output.height image_id: $.rpc.output.image_id image_url: $.rpc.output.image_url is_carousel_usable: $.rpc.output.is_carousel_usable material_id: $.rpc.output.material_id modify_time: $.rpc.output.modify_time signature: $.rpc.output.signature size: $.rpc.output.size width: $.rpc.output.width x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/portfolio/create/: post: operationId: Creative Portfolio Create parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id creative_portfolio_type: default: CTA description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804132825869313 enum_package_name: CreativePortfolioType enums: - description: '' is_valid: true key: CARD value: '2' - description: '' is_valid: true key: COUNTDOWN_STICKER value: '7' - description: '' is_valid: true key: CTA value: '1' - description: '' is_valid: true key: DESTINATION_CARD value: '25' - description: '' is_valid: true key: DOWNLOAD_CARD value: '13' - description: '' is_valid: true key: DYNAMIC_ADD_ON value: '200' - description: '' is_valid: true key: FLIGHT_CARD value: '22' - description: Corresponds to GESTURE is_valid: true key: GESTURE value: '4' - description: '' is_valid: true key: GIFTCODE_STICKER value: '8' - description: '' is_valid: true key: HOTEL_CARD value: '21' - description: AutoInventoryCard is_valid: true key: INVENTORY_CARD value: '18' - description: '' is_valid: true key: LIVE_REMINDER_COUNTDOWN_STICKER value: '14' - description: Corresponds to MOVIE_CARD is_valid: true key: MEDIA_CARD value: '20' - description: '' is_valid: true key: NON_CLICK_SUPER_LIKE value: '12' - description: Corresponds to PAINTED_EGG is_valid: true key: PREMIUM_BADGE value: '5' - description: '' is_valid: true key: PRODUCT_CARD value: '11' - description: '' is_valid: true key: PRODUCT_INFO_CARD value: '24' - description: '' is_valid: true key: PRODUCT_SHOWCASE_TILE value: '26' - description: '' is_valid: true key: PRODUCT_TILE value: '17' - description: '' is_valid: true key: REMINDER_COUNTDOWN_STICKER value: '10' - description: '' is_valid: true key: SHAKE_SURPRISE value: '15' - description: '' is_valid: true key: SHOPIFY_PRODUCT_CARD value: '19' - description: Corresponds to VOTING_STICKER is_valid: true key: STICKER value: '6' - description: '' is_valid: true key: STORY_SELECTION value: '16' - description: '' is_valid: true key: SUPER_LIKE value: '9' - description: InfomativeCTA is_valid: true key: WEB_INFO_CARD value: '23' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.creative_portfolio_type portfolio_content: description: '' items: properties: ad_text: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 38 x-open-source: $.http.body.portfolio_content[].title advanced_audio_info: description: '' properties: video_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].advanced_audio_info.video_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 x-open-source: $.http.body.portfolio_content[].advanced_audio_info advanced_gesture_icon: description: '' properties: image_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].advanced_gesture_icon.image_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 x-open-source: $.http.body.portfolio_content[].advanced_gesture_icon advanced_gesture_image: description: '' properties: image_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].advanced_gesture_image.image_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 x-open-source: $.http.body.portfolio_content[].advanced_gesture_image advanced_interact_shape: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804268028189761 enum_package_name: CreativeGestureInteractShape enums: - description: '' is_valid: true key: CURVE value: '1' - description: '' is_valid: true key: LINE value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 11 x-open-source: $.http.body.portfolio_content[].advanced_interact_shape advanced_interact_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804138054020098 enum_package_name: CreativePortfolioGestureInteract enums: - description: '' is_valid: true key: CLICK value: '0' - description: '' is_valid: true key: SLIDE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 10 x-open-source: $.http.body.portfolio_content[].advanced_interact_type app_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 19 x-open-source: $.http.body.portfolio_content[].app_id asset_content: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.portfolio_content[].asset_content asset_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.portfolio_content[].asset_ids badge_image_info: description: '' properties: image_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].advanced_image_info.image_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.portfolio_content[].advanced_image_info badge_position: description: '' properties: angle: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.portfolio_content[].advanced_position.angle position_x: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].advanced_position.position_x position_y: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.portfolio_content[].advanced_position.position_y type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.portfolio_content[].advanced_position badge_show_time: description: '' format: int64 minimum: 3 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.portfolio_content[].advanced_show_time call_to_action: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 21 x-open-source: $.http.body.portfolio_content[].cta call_to_action_text: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.portfolio_content[].advanced_guide_text_bottom card_image_index: description: '' format: int64 minimum: 0 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 45 x-open-source: $.http.body.portfolio_content[].card_image_index card_show_price: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 43 x-open-source: $.http.body.portfolio_content[].card_show_price card_tags: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804139531927554 enum_package_name: ProductTag enums: - description: '' is_valid: true key: BRAND value: '1' - description: '' is_valid: true key: CATEGORY value: '2' - description: '' is_valid: true key: DESC value: '5' - description: '' is_valid: true key: FREE_SHIPPING value: '4' - description: '' is_valid: true key: MATERIAL value: '3' key_format: string strict: true use_part: false validate_only: false value_format: int32 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 44 x-open-source: $.http.body.portfolio_content[].card_tags card_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804137888825410 enum_package_name: CreativePortfolioCardType enums: - description: '' is_valid: true key: IMAGE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].card_type catalog_authorized_bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 29 x-open-source: $.http.body.portfolio_content[].catalog_authorized_bc catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 28 x-open-source: $.http.body.portfolio_content[].product_platform_id category_label: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 18 x-open-source: $.http.body.portfolio_content[].category_label country_code: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 23 x-open-source: $.http.body.portfolio_content[].country_code description: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 17 x-open-source: $.http.body.portfolio_content[].description display_price_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 48 x-open-source: $.http.body.portfolio_content[].display_price_info dynamic_format: default: UNSET description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1826186631243841 enum_package_name: DynamicCreativeStrategy enums: - description: smart creative is_valid: true key: DYNAMIC_CREATIVE value: '1' - description: 未设置 is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 41 x-open-source: $.http.body.portfolio_content[].vertical_creative_strategy gesture_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1829049153107970 enum_package_name: GestureType enums: - description: '' is_valid: true key: CLICK value: '0' - description: '' is_valid: true key: CURVED_SLIDE value: '2' - description: '' is_valid: true key: STRAIGHT_SLIDE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 50 identity_authorized_bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 34 x-open-source: $.http.body.portfolio_content[].identity_bc_id identity_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 32 x-open-source: $.http.body.portfolio_content[].identity_id identity_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800331041544193 enum_package_name: IdentityType enums: - description: '' is_valid: true key: AUTH_CODE value: '2' - description: '' is_valid: true key: BC_AUTH_TT value: '5' - description: '' is_valid: true key: BC_SELF_TT value: '4' - description: '' is_valid: true key: CUSTOMIZED_USER value: '1' - description: TTS 授权来源TT账号 is_valid: false key: TTS_TT value: '8' - description: '' is_valid: true key: TT_USER value: '3' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 33 x-open-source: $.http.body.portfolio_content[].identity_type image_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.portfolio_content[].image_uri image_optimization_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 49 x-open-source: $.http.body.portfolio_content[].enable_image_optimization interactive_music_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 51 item_group_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 37 x-open-source: $.http.body.portfolio_content[].spu_list layouts: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: TYPE_1 value: '1' - description: '' is_valid: true key: TYPE_2 value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 x-open-source: $.http.body.portfolio_content[].layouts mobile_app_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 22 x-open-source: $.http.body.portfolio_content[].origin_app_id pop_up_window_image_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 primary_text: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1826185093536770 enum_package_name: VerticalCatalogCardTextType enums: - description: '' is_valid: true key: CUSTOM_LABEL value: '1' - description: '' is_valid: true key: DEALS value: '3' - description: '' is_valid: true key: GENRE value: '2' - description: '' is_valid: true key: NONE value: '5' - description: '' is_valid: true key: RATING value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 24 x-open-source: $.http.body.portfolio_content[].primary_text product_set_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 35 x-open-source: $.http.body.portfolio_content[].product_set_id product_source: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807533400732674 enum_package_name: ProductSource enums: - description: '' is_valid: true key: CATALOG value: '1' - description: '' is_valid: true key: SHOWCASE value: '3' - description: '' is_valid: true key: STORE value: '2' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 27 x-open-source: $.http.body.portfolio_content[].product_source product_specific_type: default: UNSET description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807533365234690 enum_package_name: ProductSpecificType enums: - description: '' is_valid: true key: ALL value: '1' - description: '' is_valid: true key: CUSTOMIZED_PRODUCTS value: '3' - description: '' is_valid: true key: PRODUCT_SET value: '2' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 40 x-open-source: $.http.body.portfolio_content[].product_specific_type profile_image: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 20 x-open-source: $.http.body.portfolio_content[].avatar secondary_text: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1826185093536770 enum_package_name: VerticalCatalogCardTextType enums: - description: '' is_valid: true key: CUSTOM_LABEL value: '1' - description: '' is_valid: true key: DEALS value: '3' - description: '' is_valid: true key: GENRE value: '2' - description: '' is_valid: true key: NONE value: '5' - description: '' is_valid: true key: RATING value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 25 x-open-source: $.http.body.portfolio_content[].secondary_text selling_points: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 5 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 46 x-open-source: $.http.body.portfolio_content[].selling_points showcase_products: description: '' items: properties: catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 x-open-source: $.http.body.portfolio_content[].showcase_spu_list[].catalog_id item_group_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].showcase_spu_list[].spu_id store_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.portfolio_content[].showcase_spu_list[].shop_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 20 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 39 x-open-source: $.http.body.portfolio_content[].showcase_spu_list sku_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 36 x-open-source: $.http.body.portfolio_content[].sku_ids slide_dimension: description: '' properties: dimension_height: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 dimension_width: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 53 slide_length: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 52 sticker_param: description: '' properties: color: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: ORANGE value: ORANGE - description: '' is_valid: true key: BLACK value: BLACK - description: '' is_valid: true key: RED value: RED - description: '' is_valid: true key: BLUE value: BLUE key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 3 x-open-source: $.http.body.portfolio_content[].sticker_param.color cutoff_time: description: '' format: datetime type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.portfolio_content[].sticker_param.cutoff_time display_angle: description: '' format: int64 maximum: 180 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.portfolio_content[].sticker_param.display_angle giftcode: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 x-open-source: $.http.body.portfolio_content[].sticker_param.giftcode landing_page_url: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.portfolio_content[].sticker_param.landing_page_url live_tiktok_user_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 11 x-open-source: $.http.body.portfolio_content[].sticker_param.live_account_user_id opacity: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: '0.7' value: '0.7' - description: '' is_valid: true key: '0.8' value: '0.8' - description: '' is_valid: true key: '0.9' value: '0.9' - description: '' is_valid: true key: '1' value: '1' key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 8 x-open-source: $.http.body.portfolio_content[].sticker_param.opacity position_x: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.portfolio_content[].sticker_param.position_x position_y: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.portfolio_content[].sticker_param.position_y predefined_placement: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 x-open-source: $.http.body.portfolio_content[].sticker_param.predefined_placement reminder_time: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1826186173387777 enum_package_name: ReminderTime enums: - description: '' is_valid: true key: FIVE_MINUTES_AFTER value: '4' - description: '' is_valid: true key: ONE_DAY_EARLIER value: '2' - description: '' is_valid: true key: ONE_HOUR_EARLIER value: '1' - description: '' is_valid: true key: ONE_MINUTE_AFTER value: '3' - description: '' is_valid: true key: ONE_MINUTE_EARLIER value: '0' - description: '' is_valid: true key: TEN_MINUTES_AFTER value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 9 x-open-source: $.http.body.portfolio_content[].sticker_param.reminder_time size: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: '0.6' value: '0.6' - description: '' is_valid: true key: '0.7' value: '0.7' - description: '' is_valid: true key: '0.8' value: '0.8' - description: '' is_valid: true key: '0.9' value: '0.9' - description: '' is_valid: true key: '1' value: '1' - description: '' is_valid: true key: '1.1' value: '1.1' key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 7 x-open-source: $.http.body.portfolio_content[].sticker_param.size sticker_type: default: COUNTDOWN description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804139609682946 enum_package_name: StickerType enums: - description: '' is_valid: true key: COUNTDOWN value: '7' - description: '' is_valid: true key: GIFTCODE value: '8' - description: '' is_valid: true key: LIVE_REMINDER_COUNTDOWN value: '14' - description: '' is_valid: true key: REMINDER_COUNTDOWN value: '10' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 12 x-open-source: $.http.body.portfolio_content[].sticker_param.sticker_type title: description: '' maxLength: 54 minLength: 1 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].sticker_param.title required: - title - color type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 26 x-open-source: $.http.body.portfolio_content[].sticker_param store_authorized_bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 31 x-open-source: $.http.body.portfolio_content[].shop_authorized_bc store_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 30 x-open-source: $.http.body.portfolio_content[].shop_id tags: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804139457244162 enum_package_name: CreativePortfolioDownloadCardTag enums: - description: '' is_valid: true key: CATEGORIES value: '1' - description: '' is_valid: true key: COMMENT_VOLUME value: '5' - description: '' is_valid: true key: FILESIZE value: '2' - description: '' is_valid: true key: RANKING value: '4' - description: '' is_valid: true key: RATING value: '3' key_format: string strict: true use_part: false validate_only: false value_format: int32 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 15 x-open-source: $.http.body.portfolio_content[].tags title: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 47 x-open-source: $.http.body.portfolio_content[].card_title vertical_video_strategy: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1828883174105281 enum_package_name: CreativeVerticalVideoStrategy enums: - description: '' is_valid: true key: CATALOG_UPLOADED_VIDEOS value: '5' - description: '' is_valid: true key: CATALOG_VIDEOS value: '2' - description: '' is_valid: true key: LIVE_STREAM value: '3' - description: '' is_valid: true key: SINGLE_VIDEO value: '1' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 42 x-open-source: $.http.body.portfolio_content[].vertical_video_strategy type: object x-open-allow-strlist: false x-open-allow-strnum: false minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.portfolio_content required: - advertiser_id - portfolio_content type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a portfolio. [Creative Portfolie Create](https://business-api.tiktok.com/portal/docs?id=1739091950439426) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: creative_portfolio_type required: false source: $.http.body.creative_portfolio_type type: number - children: - children: - name: card_type required: false source: $.http.body.portfolio_content[].card_type type: number - children: - type: number is_expand: false name: asset_ids required: false source: $.http.body.portfolio_content[].asset_ids sub_type: number type: array - name: asset_content required: false source: $.http.body.portfolio_content[].asset_content type: string - name: image_uri required: false source: $.http.body.portfolio_content[].image_id type: string - name: jump_image_uri required: false source: $.http.body.portfolio_content[].pop_up_window_image_id type: string - name: advanced_show_time required: false source: $.http.body.portfolio_content[].badge_show_time type: number - name: advanced_guide_text_bottom required: false source: $.http.body.portfolio_content[].call_to_action_text type: string - children: - name: position_x required: false source: $.http.body.portfolio_content[].advanced_position.position_x type: number - name: position_y required: false source: $.http.body.portfolio_content[].advanced_position.position_y type: number - name: angle required: false source: $.http.body.portfolio_content[].advanced_position.angle type: number is_expand: true name: advanced_position required: false source: $.http.body.portfolio_content[].badge_position type: object - children: - name: image_id required: false source: $.http.body.portfolio_content[].advanced_image_info.image_id type: string is_expand: true name: advanced_image_info required: false source: $.http.body.portfolio_content[].badge_image_info type: object - name: advanced_interact_type required: false source: $.http.body.portfolio_content[].advanced_interact_type type: number - name: advanced_interact_shape required: false source: $.http.body.portfolio_content[].advanced_interact_shape type: number - children: - name: image_id required: false source: $.http.body.portfolio_content[].advanced_gesture_icon.image_id type: string is_expand: true name: advanced_gesture_icon required: false source: $.http.body.portfolio_content[].advanced_gesture_icon type: object - children: - name: image_id required: false source: $.http.body.portfolio_content[].advanced_gesture_image.image_id type: string is_expand: true name: advanced_gesture_image required: false source: $.http.body.portfolio_content[].advanced_gesture_image type: object - children: - name: video_id required: false source: $.http.body.portfolio_content[].advanced_audio_info.video_id type: string is_expand: true name: advanced_audio_info required: false source: $.http.body.portfolio_content[].advanced_audio_info type: object - children: - type: number is_expand: true name: tags required: false source: $.http.body.portfolio_content[].tags sub_type: number type: array - children: - type: number is_expand: true name: layouts required: false source: $.http.body.portfolio_content[].layouts sub_type: number type: array - name: description required: false source: $.http.body.portfolio_content[].description type: string - name: category_label required: false source: $.http.body.portfolio_content[].category_label type: string - name: app_id required: false source: $.http.body.portfolio_content[].app_id type: string - name: avatar required: false source: $.http.body.portfolio_content[].profile_image type: string - name: cta required: false source: $.http.body.portfolio_content[].call_to_action type: string - name: origin_app_id required: false source: $.http.body.portfolio_content[].mobile_app_id type: string - children: - type: string is_expand: true name: country_code required: false source: $.http.body.portfolio_content[].country_code sub_type: string type: array - name: primary_text required: false source: $.http.body.portfolio_content[].primary_text type: number - name: secondary_text required: false source: $.http.body.portfolio_content[].secondary_text type: number - children: - name: title required: true source: $.http.body.portfolio_content[].sticker_param.title type: string - name: cutoff_time required: false source: $.http.body.portfolio_content[].sticker_param.cutoff_time type: string - name: color required: true source: $.http.body.portfolio_content[].sticker_param.color type: string - name: display_angle required: false source: $.http.body.portfolio_content[].sticker_param.display_angle type: number - name: position_x required: false source: $.http.body.portfolio_content[].sticker_param.position_x type: number - name: position_y required: false source: $.http.body.portfolio_content[].sticker_param.position_y type: number - name: size required: false source: $.http.body.portfolio_content[].sticker_param.size type: string - name: opacity required: false source: $.http.body.portfolio_content[].sticker_param.opacity type: string - name: reminder_time required: false source: $.http.body.portfolio_content[].sticker_param.reminder_time type: number - name: landing_page_url required: false source: $.http.body.portfolio_content[].sticker_param.landing_page_url type: string - name: live_account_user_id required: false source: $.http.body.portfolio_content[].sticker_param.live_tiktok_user_id type: number - name: sticker_type required: false source: $.http.body.portfolio_content[].sticker_param.sticker_type type: number - name: giftcode required: false source: $.http.body.portfolio_content[].sticker_param.giftcode type: string - name: predefined_placement required: false source: $.http.body.portfolio_content[].sticker_param.predefined_placement type: string is_expand: true name: sticker_param required: false type: object - name: product_source required: false source: $.http.body.portfolio_content[].product_source type: number - name: product_platform_id required: false source: $.http.body.portfolio_content[].catalog_id type: number - name: catalog_authorized_bc required: false source: $.http.body.portfolio_content[].catalog_authorized_bc_id type: number - name: shop_id required: false source: $.http.body.portfolio_content[].store_id type: number - name: shop_authorized_bc required: false source: $.http.body.portfolio_content[].store_authorized_bc_id type: number - name: identity_id required: false source: $.http.body.portfolio_content[].identity_id type: string - name: identity_type required: false source: $.http.body.portfolio_content[].identity_type type: number - name: identity_bc_id required: false source: $.http.body.portfolio_content[].identity_authorized_bc_id type: number - name: product_set_id required: false source: $.http.body.portfolio_content[].product_set_id type: number - children: - type: string is_expand: true name: sku_ids required: false source: $.http.body.portfolio_content[].sku_ids sub_type: string type: array - children: - type: string is_expand: true name: spu_list required: false source: $.http.body.portfolio_content[].item_group_ids sub_type: string type: array - name: title required: false source: $.http.body.portfolio_content[].ad_text type: string - children: - children: - name: spu_id required: false source: $.http.body.portfolio_content[].showcase_products[].item_group_id type: string - name: shop_id required: false source: $.http.body.portfolio_content[].showcase_products[].store_id type: number - name: catalog_id required: false source: $.http.body.portfolio_content[].showcase_products[].catalog_id type: number is_expand: true type: object is_expand: true name: showcase_spu_list required: false sub_type: object type: array - name: product_specific_type required: false source: $.http.body.portfolio_content[].product_specific_type type: number - name: vertical_creative_strategy required: false source: $.http.body.portfolio_content[].dynamic_format type: number - name: vertical_video_strategy required: false source: $.http.body.portfolio_content[].vertical_video_strategy type: number - name: card_show_price required: false source: $.http.body.portfolio_content[].card_show_price type: boolean - children: - type: number is_expand: true name: card_tags required: false source: $.http.body.portfolio_content[].card_tags sub_type: number type: array - name: card_image_index required: false source: $.http.body.portfolio_content[].card_image_index type: number - children: - type: string is_expand: true name: selling_points required: false source: $.http.body.portfolio_content[].selling_points sub_type: string type: array - name: card_title required: false source: $.http.body.portfolio_content[].title type: string - name: display_price_info required: false source: $.http.body.portfolio_content[].display_price_enabled type: boolean - name: enable_image_optimization required: false source: $.http.body.portfolio_content[].image_optimization_enabled type: boolean - name: gesture_type required: false source: $.http.body.portfolio_content[].gesture_type type: number - name: interactive_music_id required: false source: $.http.body.portfolio_content[].interactive_music_id type: string - name: slide_length required: false source: $.http.body.portfolio_content[].slide_length type: number - children: - name: dimension_width required: false source: $.http.body.portfolio_content[].slide_dimension.dimension_width type: number - name: dimension_height required: false source: $.http.body.portfolio_content[].slide_dimension.dimension_height type: number is_expand: false name: slide_dimension required: false source: $.http.body.portfolio_content[].slide_dimension type: object is_expand: true type: object is_expand: true name: portfolio_content required: true sub_type: object type: array - children: - name: app_id required: false source: $.http.body.context_info.app_id type: number - name: core_user_id required: false source: $.http.body.context_info.core_user_id type: number - name: developer_id required: false source: $.http.body.context_info.developer_id type: number - name: x_forwarded_for required: false source: $.http.body.context_info.x_forwarded_for type: string - name: x_real_ip required: false source: $.http.body.context_info.x_real_ip type: string - name: user_agent required: false source: $.http.body.context_info.user_agent type: string - name: referer required: false source: $.http.body.context_info.referer type: string is_expand: false name: context_info required: true source: $.http.body.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id context_info: $.http.body.context_info creative_portfolio_type: $.http.body.creative_portfolio_type portfolio_content[][]: - advanced_audio_info: $.http.body.portfolio_content[].advanced_audio_info advanced_gesture_icon: $.http.body.portfolio_content[].advanced_gesture_icon advanced_gesture_image: $.http.body.portfolio_content[].advanced_gesture_image advanced_guide_text_bottom: $.http.body.portfolio_content[].call_to_action_text advanced_image_info: $.http.body.portfolio_content[].badge_image_info advanced_interact_shape: $.http.body.portfolio_content[].advanced_interact_shape advanced_interact_type: $.http.body.portfolio_content[].advanced_interact_type advanced_position: $.http.body.portfolio_content[].badge_position advanced_show_time: $.http.body.portfolio_content[].badge_show_time app_id: $.http.body.portfolio_content[].app_id asset_content: $.http.body.portfolio_content[].asset_content asset_ids: $.http.body.portfolio_content[].asset_ids avatar: $.http.body.portfolio_content[].profile_image card_image_index: $.http.body.portfolio_content[].card_image_index card_show_price: $.http.body.portfolio_content[].card_show_price card_tags: $.http.body.portfolio_content[].card_tags card_title: $.http.body.portfolio_content[].title card_type: $.http.body.portfolio_content[].card_type catalog_authorized_bc: $.http.body.portfolio_content[].catalog_authorized_bc_id category_label: $.http.body.portfolio_content[].category_label country_code: $.http.body.portfolio_content[].country_code cta: $.http.body.portfolio_content[].call_to_action description: $.http.body.portfolio_content[].description display_price_info: $.http.body.portfolio_content[].display_price_enabled enable_image_optimization: $.http.body.portfolio_content[].image_optimization_enabled gesture_type: $.http.body.portfolio_content[].gesture_type identity_bc_id: $.http.body.portfolio_content[].identity_authorized_bc_id identity_id: $.http.body.portfolio_content[].identity_id identity_type: $.http.body.portfolio_content[].identity_type image_uri: $.http.body.portfolio_content[].image_id interactive_music_id: $.http.body.portfolio_content[].interactive_music_id jump_image_uri: $.http.body.portfolio_content[].pop_up_window_image_id layouts: $.http.body.portfolio_content[].layouts origin_app_id: $.http.body.portfolio_content[].mobile_app_id primary_text: $.http.body.portfolio_content[].primary_text product_platform_id: $.http.body.portfolio_content[].catalog_id product_set_id: $.http.body.portfolio_content[].product_set_id product_source: $.http.body.portfolio_content[].product_source product_specific_type: $.http.body.portfolio_content[].product_specific_type secondary_text: $.http.body.portfolio_content[].secondary_text selling_points: $.http.body.portfolio_content[].selling_points shop_authorized_bc: $.http.body.portfolio_content[].store_authorized_bc_id shop_id: $.http.body.portfolio_content[].store_id showcase_spu_list[][]: - catalog_id: $.http.body.portfolio_content[].showcase_products[].catalog_id shop_id: $.http.body.portfolio_content[].showcase_products[].store_id spu_id: $.http.body.portfolio_content[].showcase_products[].item_group_id sku_ids: $.http.body.portfolio_content[].sku_ids slide_dimension: $.http.body.portfolio_content[].slide_dimension slide_length: $.http.body.portfolio_content[].slide_length spu_list: $.http.body.portfolio_content[].item_group_ids sticker_param[]: - color: $.http.body.portfolio_content[].sticker_param.color cutoff_time: $.http.body.portfolio_content[].sticker_param.cutoff_time display_angle: $.http.body.portfolio_content[].sticker_param.display_angle giftcode: $.http.body.portfolio_content[].sticker_param.giftcode landing_page_url: $.http.body.portfolio_content[].sticker_param.landing_page_url live_account_user_id: $.http.body.portfolio_content[].sticker_param.live_tiktok_user_id opacity: $.http.body.portfolio_content[].sticker_param.opacity position_x: $.http.body.portfolio_content[].sticker_param.position_x position_y: $.http.body.portfolio_content[].sticker_param.position_y predefined_placement: $.http.body.portfolio_content[].sticker_param.predefined_placement reminder_time: $.http.body.portfolio_content[].sticker_param.reminder_time size: $.http.body.portfolio_content[].sticker_param.size sticker_type: $.http.body.portfolio_content[].sticker_param.sticker_type title: $.http.body.portfolio_content[].sticker_param.title tags: $.http.body.portfolio_content[].tags title: $.http.body.portfolio_content[].ad_text vertical_creative_strategy: $.http.body.portfolio_content[].dynamic_format vertical_video_strategy: $.http.body.portfolio_content[].vertical_video_strategy response_cookie: [] response_header: [] response_rule: creative_portfolio_id: $.rpc.output.creative_portfolio_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/portfolio/get/: get: operationId: Creative Portfolio Get parameters: - description: '' in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: '' in: query name: creative_portfolio_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.creative_portfolio_id x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get a portfolio by ID. [Portfolio Get](https://business-api.tiktok.com/portal/docs?id=1739092113671170) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: creative_portfolio_id required: true source: $.http.query.creative_portfolio_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id creative_portfolio_id: $.http.query.creative_portfolio_id response_cookie: [] response_header: [] response_rule: creative_portfolio_id: $.rpc.output.creative_portfolio_id creative_portfolio_type: $.rpc.output.creative_portfolio_type portfolio_content: $.rpc.output.portfolio_content x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/portfolio/list/: get: operationId: Creative Portfolio List parameters: - description: '' in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - content: application/json: schema: properties: creative_portfolio_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.creative_portfolio_ids creative_portfolio_types: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804132825869313 enum_package_name: CreativePortfolioType enums: - description: '' is_valid: true key: CARD value: '2' - description: '' is_valid: true key: COUNTDOWN_STICKER value: '7' - description: '' is_valid: true key: CTA value: '1' - description: '' is_valid: true key: DESTINATION_CARD value: '25' - description: '' is_valid: true key: DOWNLOAD_CARD value: '13' - description: '' is_valid: false key: DYNAMIC_ADD_ON value: '200' - description: '' is_valid: true key: FLIGHT_CARD value: '22' - description: Corresponds to GESTURE is_valid: true key: GESTURE value: '4' - description: '' is_valid: true key: GIFTCODE_STICKER value: '8' - description: '' is_valid: true key: HOTEL_CARD value: '21' - description: AutoInventoryCard is_valid: true key: INVENTORY_CARD value: '18' - description: '' is_valid: true key: LIVE_REMINDER_COUNTDOWN_STICKER value: '14' - description: Corresponds to MOVIE_CARD is_valid: true key: MEDIA_CARD value: '20' - description: '' is_valid: false key: NON_CLICK_SUPER_LIKE value: '12' - description: Corresponds to PAINTED_EGG is_valid: true key: PREMIUM_BADGE value: '5' - description: '' is_valid: true key: PRODUCT_CARD value: '11' - description: '' is_valid: false key: PRODUCT_INFO_CARD value: '24' - description: '' is_valid: true key: PRODUCT_SHOWCASE_TILE value: '26' - description: '' is_valid: true key: PRODUCT_TILE value: '17' - description: '' is_valid: true key: REMINDER_COUNTDOWN_STICKER value: '10' - description: '' is_valid: false key: SHAKE_SURPRISE value: '15' - description: '' is_valid: false key: SHOPIFY_PRODUCT_CARD value: '19' - description: Corresponds to VOTING_STICKER is_valid: false key: STICKER value: '6' - description: '' is_valid: false key: STORY_SELECTION value: '16' - description: '' is_valid: true key: SUPER_LIKE value: '9' - description: InfomativeCTA is_valid: true key: WEB_INFO_CARD value: '23' key_format: string strict: true use_part: true validate_only: false value_format: int32 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.creative_portfolio_types type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.filtering description: '' in: query name: filtering required: false x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 20 format: int64 maximum: 100 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 4 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get portfolios within an ad account. [Portfolio List](https://business-api.tiktok.com/portal/docs?id=1766324010279938) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - children: - type: number is_expand: true name: creative_portfolio_types required: false source: $.http.query.filtering.creative_portfolio_types sub_type: number type: array - children: - type: number is_expand: true name: creative_portfolio_ids required: false source: $.http.query.filtering.creative_portfolio_ids sub_type: number type: array is_expand: true name: filtering required: false source: $.http.query.filtering type: object - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: creative_portfolios[][]: - advanced_audio_info: $.rpc.output.creative_portfolios[].creative_portfolio_content.advanced_audio_info advanced_gesture_icon: $.rpc.output.creative_portfolios[].creative_portfolio_content.advanced_gesture_icon advanced_gesture_image: $.rpc.output.creative_portfolios[].creative_portfolio_content.advanced_gesture_image advanced_interact_shape: $.rpc.output.creative_portfolios[].creative_portfolio_content.advanced_interact_shape advanced_interact_type: $.rpc.output.creative_portfolios[].creative_portfolio_content.advanced_interact_type app_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.app_id badge_image_info: $.rpc.output.creative_portfolios[].creative_portfolio_content.badge_image_info badge_position[]: - angle: $.rpc.output.creative_portfolios[].creative_portfolio_content.badge_position.angle position_x: $.rpc.output.creative_portfolios[].creative_portfolio_content.badge_position.position_x position_y: $.rpc.output.creative_portfolios[].creative_portfolio_content.badge_position.position_y badge_show_time: $.rpc.output.creative_portfolios[].creative_portfolio_content.badge_show_time call_to_action_text: $.rpc.output.creative_portfolios[].creative_portfolio_content.call_to_action_text card_image_index: $.rpc.output.creative_portfolios[].creative_portfolio_content.card_image_index card_show_price: $.rpc.output.creative_portfolios[].creative_portfolio_content.card_show_price card_tags: $.rpc.output.creative_portfolios[].creative_portfolio_content.card_tags card_type: $.rpc.output.creative_portfolios[].creative_portfolio_content.card_type content_url: $.rpc.output.creative_portfolios[].creative_portfolio_content.content_url creative_portfolio_id: $.rpc.output.creative_portfolios[].creative_portfolio_id creative_portfolio_preview_url: $.rpc.output.creative_portfolios[].creative_portfolio_preview_url creative_portfolio_type: $.rpc.output.creative_portfolios[].creative_portfolio_type description: $.rpc.output.creative_portfolios[].creative_portfolio_content.description display_price_enabled: $.rpc.output.creative_portfolios[].creative_portfolio_content.display_price_enabled gesture_type: $.rpc.output.creative_portfolios[].creative_portfolio_content.gesture_type image_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.image_id image_optimization_enabled: $.rpc.output.creative_portfolios[].creative_portfolio_content.image_optimization_enabled interactive_music_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.interactive_music_id layouts: $.rpc.output.creative_portfolios[].creative_portfolio_content.layouts pop_up_window_image_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.pop_up_window_image_id primary_text: $.rpc.output.creative_portfolios[].creative_portfolio_content.primary_text secondary_text: $.rpc.output.creative_portfolios[].creative_portfolio_content.secondary_text selling_points: $.rpc.output.creative_portfolios[].creative_portfolio_content.selling_points slide_dimension[]: - dimension_height: $.rpc.output.creative_portfolios[].creative_portfolio_content.slide_dimension.dimension_height dimension_width: $.rpc.output.creative_portfolios[].creative_portfolio_content.slide_dimension.dimension_width slide_length: $.rpc.output.creative_portfolios[].creative_portfolio_content.slide_length sticker_param[]: - color: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.color cutoff_time: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.cutoff_time display_angle: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.display_angle giftcode: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.giftcode landing_page_url: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.landing_page_url live_tiktok_user_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.live_tiktok_user_id opacity: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.opacity position_x: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.position_x position_y: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.position_y predefined_placement: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.predefined_placement reminder_time: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.reminder_time size: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.size sticker_type: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.sticker_type title: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.title tags: $.rpc.output.creative_portfolios[].creative_portfolio_content.tags thumbnail_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.thumbnail_id title: $.rpc.output.creative_portfolios[].creative_portfolio_content.title page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /creative/shareable_link/create/: post: operationId: Creative Shareable_link Create parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: shared_assets: description: '' items: properties: asset_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.shared_assets[].asset_id asset_name: description: '' maxLength: 30 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.shared_assets[].asset_name type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 20 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.shared_assets sharer: description: '' maxLength: 30 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.sharer required: - shared_assets - sharer type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: '' tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - children: - name: asset_id required: false source: $.http.body.shared_assets[].asset_id type: string - name: asset_name required: false source: $.http.body.shared_assets[].asset_name type: string type: object name: shared_assets required: true source: $.http.body.shared_assets sub_type: object type: array - name: sharer required: true source: $.http.body.sharer type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: shared_assets: $.http.body.shared_assets sharer: $.http.body.sharer response_cookie: [] response_header: [] response_rule: shareable_link: $.rpc.output.shareable_link x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/smart_text/generate/: post: operationId: Creative Smart_text Generate parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: adgroup_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.adgroup_id advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id industry_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 x-open-source: $.http.body.industry_id keywords: description: '' items: minLength: 1 type: string x-open-allow-strlist: false x-open-allow-strnum: false minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.keywords language: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804052384859137 enum_package_name: SmartTextLanguage enums: - description: '' is_valid: true key: EN value: '1' - description: '' is_valid: true key: JA value: '2' - description: '' is_valid: true key: RU value: '5' - description: '' is_valid: true key: VI value: '3' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.language limit: default: 10 description: '' format: int64 maximum: 20 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.limit param_type: default: CUSTOMIZED description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: CUSTOMIZED value: CUSTOMIZED - description: '' is_valid: true key: RECOMMENDED value: RECOMMENDED key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 3 x-open-source: $.http.body.param_type required: - advertiser_id - adgroup_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use smart text. [Smart Text Generate](https://business-api.tiktok.com/portal/docs?id=1739084248002626) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: adgroup_id required: true source: $.http.body.adgroup_id type: number - name: param_type required: false source: $.http.body.param_type type: string - name: language required: false source: $.http.body.language type: number - name: industry_id required: false source: $.http.body.industry_id type: number - children: - type: string name: keywords required: false source: $.http.body.keywords sub_type: string type: array - name: limit required: true source: $.http.body.limit type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adgroup_id: $.http.body.adgroup_id advertiser_id: $.http.body.advertiser_id industry_id: $.http.body.industry_id keywords: $.http.body.keywords language: $.http.body.language limit: $.http.body.limit param_type: $.http.body.param_type response_cookie: [] response_header: [] response_rule: generate_id: $.rpc.output.generate_id industry_id: $.rpc.output.industry_id language: $.rpc.output.language texts: $.rpc.output.texts x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /discovery/detail/: get: operationId: Discovery Detail parameters: - description: '' in: query name: hashtag_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.hashtag_id x-open-field-id: 1 - description: '' in: query name: discovery_type required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805543041665089 enum_package_name: DiscoveryType enums: - description: '' is_valid: true key: HASHTAG value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.discovery_type x-open-field-id: 2 - description: '' in: query name: country_code required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.country_code x-open-field-id: 3 - description: '' in: query name: date_range required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805543099909121 enum_package_name: DiscoveryPeriodType enums: - description: '' is_valid: true key: 120DAY value: l120d - description: '' is_valid: true key: 1DAY value: l1d - description: '' is_valid: true key: 30DAY value: l30d - description: '' is_valid: true key: 7DAY value: l7d key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.date_range x-open-field-id: 4 - description: '' in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get details of a popular hashtag. [Discovery Detail](https://business-api.tiktok.com/portal/docs?id=1825119047070721) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: hashtag_id required: true source: $.http.query.hashtag_id type: number - name: discovery_type required: true source: $.http.query.discovery_type type: number - name: country_code required: true source: $.http.query.country_code type: string - name: date_range required: true source: $.http.query.date_range type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id country_code: $.http.query.country_code date_range: $.http.query.date_range discovery_type: $.http.query.discovery_type hashtag_id: $.http.query.hashtag_id response_cookie: [] response_header: [] response_rule: audience_insights: $.rpc.output.audience_insights hashtag_id: $.rpc.output.hashtag_id hashtag_name: $.rpc.output.hashtag_name hashtag_status: $.rpc.output.hashtag_status posts: $.rpc.output.posts posts_global_lifetime: $.rpc.output.posts_global_lifetime top_country_list: $.rpc.output.top_country_list trending_history[][]: - date: $.rpc.output.trending_history[].date rank_position_daily: $.rpc.output.trending_history[].rank_position_daily views_daily: $.rpc.output.trending_history[].views_daily views: $.rpc.output.views views_global_lifetime: $.rpc.output.views_global_lifetime x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /discovery/trending_list/: get: operationId: Discovery Trending_list parameters: - description: '' in: query name: discovery_type required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805543041665089 enum_package_name: DiscoveryType enums: - description: '' is_valid: true key: HASHTAG value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.discovery_type x-open-field-id: 1 - description: '' in: query name: country_code required: false schema: default: US type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.country_code x-open-field-id: 2 - description: '' in: query name: category_name required: false schema: default: ALL type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805543216364546 enum_package_name: DiscoveryHashtagCategory enums: - description: '' is_valid: true key: ACADEMIC_RESOURCES value: ACADEMIC_RESOURCES - description: '' is_valid: true key: ALL value: ALL - description: '' is_valid: true key: ANIMATION_AND_COMICS value: ANIMATION_AND_COMICS - description: '' is_valid: true key: APPAREL_AND_ACCESSORIES value: APPAREL_AND_ACCESSORIES - description: '' is_valid: true key: ART value: ART - description: '' is_valid: true key: AUTOMOTIVE value: AUTOMOTIVE - description: '' is_valid: true key: BABY_CARE value: BABY_CARE - description: '' is_valid: true key: BABY_KIDS_AND_MATERNITY value: BABY_KIDS_AND_MATERNITY - description: '' is_valid: true key: BEAUTY value: BEAUTY - description: '' is_valid: true key: BEAUTY_AND_PERSONAL_CARE value: BEAUTY_AND_PERSONAL_CARE - description: '' is_valid: true key: BEAUTY_SERVICES value: BEAUTY_SERVICES - description: '' is_valid: true key: BUSINESS_AND_FINANCE value: BUSINESS_AND_FINANCE - description: '' is_valid: true key: BUSINESS_SERVICES value: BUSINESS_SERVICES - description: '' is_valid: true key: CARD_AND_BOARD_GAMES value: CARD_AND_BOARD_GAMES - description: '' is_valid: true key: CAREER_AND_PROFESSIONAL_GROWTH value: CAREER_AND_PROFESSIONAL_GROWTH - description: '' is_valid: true key: COLLEGE value: COLLEGE - description: '' is_valid: true key: COMEDY value: COMEDY - description: '' is_valid: true key: COMMUNITY_UPDATES_AND_ISSUES value: COMMUNITY_UPDATES_AND_ISSUES - description: '' is_valid: true key: CONVENTIONAL_AND_MAINSTREAM_SPORTS value: CONVENTIONAL_AND_MAINSTREAM_SPORTS - description: '' is_valid: true key: COOKING value: COOKING - description: '' is_valid: true key: CRAFTING_AND_CREATIONS value: CRAFTING_AND_CREATIONS - description: '' is_valid: true key: CULTURE value: CULTURE - description: '' is_valid: true key: DANCE value: DANCE - description: '' is_valid: true key: DIARY_AND_VLOG value: DIARY_AND_VLOG - description: '' is_valid: true key: DRINKS value: DRINKS - description: '' is_valid: true key: EATING_EXPERIENCES value: EATING_EXPERIENCES - description: '' is_valid: true key: EDUCATION value: EDUCATION - description: '' is_valid: true key: ENTERTAINMENT_AND_SPORTS_NEWS value: ENTERTAINMENT_AND_SPORTS_NEWS - description: '' is_valid: true key: ENVIRONMENT value: ENVIRONMENT - description: '' is_valid: true key: EXERCISE_AND_FITNESS value: EXERCISE_AND_FITNESS - description: '' is_valid: true key: EXTREME_AND_ADVENTURE_SPORTS value: EXTREME_AND_ADVENTURE_SPORTS - description: '' is_valid: true key: FAMILY value: FAMILY - description: '' is_valid: true key: FINANCIAL_SERVICES value: FINANCIAL_SERVICES - description: '' is_valid: true key: FOOD value: FOOD - description: '' is_valid: true key: FOOD_AND_BEVERAGE value: FOOD_AND_BEVERAGE - description: '' is_valid: true key: FOOD_RECOMMENDATIONS value: FOOD_RECOMMENDATIONS - description: '' is_valid: true key: GADGETS_AND_INNOVATION value: GADGETS_AND_INNOVATION - description: '' is_valid: true key: GAMES value: GAMES - description: '' is_valid: true key: GENERAL_TRAVEL value: GENERAL_TRAVEL - description: '' is_valid: true key: HAIR_CARE value: HAIR_CARE - description: '' is_valid: true key: HEALTH value: HEALTH - description: '' is_valid: true key: HEALTH_AND_WELLNESS value: HEALTH_AND_WELLNESS - description: '' is_valid: true key: HISTORY_AND_LITERATURE value: HISTORY_AND_LITERATURE - description: '' is_valid: true key: HOME_AND_GARDEN value: HOME_AND_GARDEN - description: '' is_valid: true key: HOME_IMPROVEMENT value: HOME_IMPROVEMENT - description: '' is_valid: true key: HOUSEHOLD_PRODUCTS value: HOUSEHOLD_PRODUCTS - description: '' is_valid: true key: LEARNING_AND_DEVELOPMENT value: LEARNING_AND_DEVELOPMENT - description: '' is_valid: true key: LEISURE_AND_RECREATION_FACILITIES value: LEISURE_AND_RECREATION_FACILITIES - description: '' is_valid: true key: LIFE_SERVICES value: LIFE_SERVICES - description: '' is_valid: true key: LIVESTOCK_AND_FARMING value: LIVESTOCK_AND_FARMING - description: '' is_valid: true key: MISCELLANEOUS_PERFORMANCES value: MISCELLANEOUS_PERFORMANCES - description: '' is_valid: true key: MOVIES_AND_TV value: MOVIES_AND_TV - description: '' is_valid: true key: MUSIC value: MUSIC - description: '' is_valid: true key: NEWS_AND_ENTERTAINMENT value: NEWS_AND_ENTERTAINMENT - description: '' is_valid: true key: OTHER_BEAUTY value: OTHER_BEAUTY - description: '' is_valid: true key: OTHER_FASHION value: OTHER_FASHION - description: '' is_valid: true key: OTHER_TRANSPORTATION value: OTHER_TRANSPORTATION - description: '' is_valid: true key: OUTDOOR_RECREATION value: OUTDOOR_RECREATION - description: '' is_valid: true key: OUTFITS value: OUTFITS - description: '' is_valid: true key: PERFORMING_ARTS value: PERFORMING_ARTS - description: '' is_valid: true key: PERSONAL_PHOTOGRAPHY value: PERSONAL_PHOTOGRAPHY - description: '' is_valid: true key: PETS value: PETS - description: '' is_valid: true key: PET_CARE_AND_ACCESSORIES value: PET_CARE_AND_ACCESSORIES - description: '' is_valid: true key: PHOTOGRAPHY value: PHOTOGRAPHY - description: '' is_valid: true key: PRODUCTIVITY_AND_EFFICIENCY value: PRODUCTIVITY_AND_EFFICIENCY - description: '' is_valid: true key: ROMANCE value: ROMANCE - description: '' is_valid: true key: SCIENCE value: SCIENCE - description: '' is_valid: true key: SENSORY_EXPERIENCES value: SENSORY_EXPERIENCES - description: '' is_valid: true key: SHOWS_FESTIVALS_AND_EXHIBITIONS value: SHOWS_FESTIVALS_AND_EXHIBITIONS - description: '' is_valid: true key: SOFTWARE_AND_APPS value: SOFTWARE_AND_APPS - description: '' is_valid: true key: SPECIAL_EFFECTS value: SPECIAL_EFFECTS - description: '' is_valid: true key: SPORTS value: SPORTS - description: '' is_valid: true key: SPORTS_AND_OUTDOOR value: SPORTS_AND_OUTDOOR - description: '' is_valid: true key: SUPERNATURAL_AND_HORROR value: SUPERNATURAL_AND_HORROR - description: '' is_valid: true key: TECHNOLOGY value: TECHNOLOGY - description: '' is_valid: true key: TOYS_COLLECTIBLES_AND_MEMORABILIA value: TOYS_COLLECTIBLES_AND_MEMORABILIA - description: '' is_valid: true key: TRAVEL value: TRAVEL - description: '' is_valid: true key: VEHICLE_AND_TRANSPORTATION value: VEHICLE_AND_TRANSPORTATION - description: '' is_valid: true key: VIDEO_GAMES value: VIDEO_GAMES - description: '' is_valid: true key: WILDLIFE_AND_EXOTIC_PETS value: WILDLIFE_AND_EXOTIC_PETS key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.category_name x-open-field-id: 3 - description: '' in: query name: date_range required: false schema: default: 7DAY type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805543099909121 enum_package_name: DiscoveryPeriodType enums: - description: '' is_valid: true key: 120DAY value: l120d - description: '' is_valid: true key: 1DAY value: l1d - description: '' is_valid: true key: 30DAY value: l30d - description: '' is_valid: true key: 7DAY value: l7d key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.date_range x-open-field-id: 4 - description: '' in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get popular hashtags. [Trending List](https://business-api.tiktok.com/portal/docs?id=1825119032526849) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: discovery_type required: true source: $.http.query.discovery_type type: number - name: country_code required: true source: $.http.query.country_code type: string - name: category_name required: true source: $.http.query.category_name type: string - name: date_range required: true source: $.http.query.date_range type: string - name: advertiser_id required: true source: $.http.query.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id category_name: $.http.query.category_name country_code: $.http.query.country_code date_range: $.http.query.date_range discovery_type: $.http.query.discovery_type response_cookie: [] response_header: [] response_rule: filter_info: category_name: $.rpc.output.filter_info.category_name country_code: $.rpc.output.filter_info.country_code date_range: $.rpc.output.filter_info.date_range list[][]: - hashtag_id: $.rpc.output.hashtag_list[].hashtag_id hashtag_name: $.rpc.output.hashtag_list[].hashtag_name posts: $.rpc.output.hashtag_list[].posts posts_global_lifetime: $.rpc.output.hashtag_list[].posts_global_lifetime rank_change: $.rpc.output.hashtag_list[].rank_change rank_position: $.rpc.output.hashtag_list[].rank_position top_country_list: $.rpc.output.hashtag_list[].top_country_list trending_history[][]: - date: $.rpc.output.hashtag_list[].trending_history[].date rank_position_daily: $.rpc.output.hashtag_list[].trending_history[].rank_position_daily views_daily: $.rpc.output.hashtag_list[].trending_history[].views_daily views: $.rpc.output.hashtag_list[].views views_global_lifetime: $.rpc.output.hashtag_list[].views_global_lifetime x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /playable/delete/: post: operationId: Playable Delete parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id playable_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.playable_id required: - advertiser_id - playable_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete a playable ad. [Playable Delete](https://business-api.tiktok.com/portal/docs?id=1737733368940546) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: playable_id required: true source: $.http.body.playable_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id playable_id: $.http.body.playable_id response_cookie: [] response_header: [] response_rule: playable_id: $.rpc.output.playable_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /playable/get/: get: operationId: Playable Get parameters: - description: '' in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: '' in: query name: playable_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.playable_id x-open-field-id: 2 - description: '' in: query name: playable_url required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.playable_url x-open-field-id: 3 - description: '' in: query name: playable_name required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.playable_name x-open-field-id: 4 - description: '' in: query name: status required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1801609276794881 enum_package_name: PlayableStatus enums: - description: '' is_valid: true key: AUDIT_FAIL value: '3' - description: '' is_valid: true key: AUDIT_SUCCESS value: '4' - description: '' is_valid: true key: VALIDATE_FAIL value: '1' - description: '' is_valid: true key: VALIDATE_SUCCESS value: '2' - description: '' is_valid: true key: VALIDATING value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.status x-open-field-id: 5 - description: '' in: query name: operation_status required: false schema: default: SAVED type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1801609323127810 enum_package_name: PlayableOperateStatus enums: - description: '' is_valid: true key: DELETED value: '2' - description: '' is_valid: true key: SAVED value: '1' - description: '' is_valid: true key: UPLOADED value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.operation_status x-open-field-id: 6 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 7 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 500 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 8 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to get a list of playables. [Playable Get](https://business-api.tiktok.com/portal/docs?id=1737732758495234) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: playable_id required: false source: $.http.query.playable_id type: number - name: playable_url required: false source: $.http.query.playable_url type: string - name: playable_name required: false source: $.http.query.playable_name type: string - name: status required: false source: $.http.query.status type: number - name: operation_status required: false source: $.http.query.operation_status type: number - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id operation_status: $.http.query.operation_status page: $.http.query.page page_size: $.http.query.page_size playable_id: $.http.query.playable_id playable_name: $.http.query.playable_name playable_url: $.http.query.playable_url status: $.http.query.status response_cookie: [] response_header: [] response_rule: list: $.rpc.output.playable_list page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /playable/save/: post: operationId: Playable Save parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id playable_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.playable_id playable_name: description: '' maxLength: 20 minLength: 1 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.playable_name required: - advertiser_id - playable_id - playable_name type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to save a playable. [Playable Save](https://business-api.tiktok.com/portal/docs?id=1737732203851777) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: playable_id required: true source: $.http.body.playable_id type: number - name: playable_name required: true source: $.http.body.playable_name type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id playable_id: $.http.body.playable_id playable_name: $.http.body.playable_name response_cookie: [] response_header: [] response_rule: playable_id: $.rpc.output.playable_id playable_name: $.rpc.output.playable_name playable_orientation: $.rpc.output.playable_orientation playable_url: $.rpc.output.playable_url status: $.rpc.output.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /playable/upload/: post: operationId: Playable Upload parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: multipart/form-data: schema: properties: advertiser_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id file_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.file_id playable_package: description: '' format: binary type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.playable_package upload_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: UPLOAD_BY_FILE value: UPLOAD_BY_FILE - description: '' is_valid: true key: UPLOAD_BY_URL value: UPLOAD_BY_URL - description: '' is_valid: true key: UPLOAD_BY_FILE_ID value: UPLOAD_BY_FILE_ID - description: '' is_valid: true key: UPLOAD_BY_VIDEO_ID value: UPLOAD_BY_VIDEO_ID - description: '' is_valid: true key: UPLOAD_BY_TIKTOK_ITEM_ID value: UPLOAD_BY_TIKTOK_ITEM_ID key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 2 x-open-source: $.http.body.upload_type required: - advertiser_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: You can use this endpoint to upload Playable Ad contents. [Playable Upload](https://business-api.tiktok.com/portal/docs?id=1737730926765057) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: upload_type required: false source: $.http.body.upload_type type: string - name: playable_package required: false source: $.http.body.playable_package type: string - name: file_id required: false source: $.http.body.file_id type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id file_id: $.http.body.file_id playable_package: $.http.body.playable_package upload_type: $.http.body.upload_type response_cookie: [] response_header: [] response_rule: task_id: $.rpc.output.task_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /playable/validate/: get: operationId: Playable Validate parameters: - description: '' in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: '' in: query name: playable_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.playable_id x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Check the status of the playable. [Playable Validate](https://business-api.tiktok.com/portal/docs?id=1737732054892545) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: playable_id required: true source: $.http.query.playable_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id playable_id: $.http.query.playable_id response_cookie: [] response_header: [] response_rule: fail_message: $.rpc.output.fail_message playable_id: $.rpc.output.playable_id playable_orientation: $.rpc.output.playable_orientation playable_url: $.rpc.output.playable_url status: $.rpc.output.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false components: securitySchemes: AccessToken: type: apiKey in: header name: Access-Token description: Long-term access token issued by POST /oauth2/access_token/ after advertiser authorization. See https://business-api.tiktok.com/portal/docs?id=1738373164380162