openapi: 3.2.0 info: title: TikTok API for Business — Marketing BC 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: BC paths: /bc/account/transaction/get/: get: operationId: Bc Account Transaction Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: child_bc_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.child_bc_id x-open-field-id: 2 - description: '' in: query name: transaction_level 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: 1807919387053057 enum_package_name: TransactionLevel enums: - description: '' is_valid: true key: ADVERTISER value: '2' - description: '' is_valid: true key: BC value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.transaction_level x-open-field-id: 3 - content: application/json: schema: properties: account_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: 3 account_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 billing_types: 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: 5 end_time: description: '' format: datetime type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 owner_of_account: 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: 2 start_time: description: '' format: datetime type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 transaction_types: 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: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false description: '' in: query name: filtering required: false x-open-field-id: 4 - description: '' in: query name: page required: false schema: default: 1 format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 6 - 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 the transaction records of a BC or ad accounts. [BC Account Transaction Get](https://business-api.tiktok.com/portal/docs?id=1792849810925569) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: false source: $.http.query.bc_id type: number - name: child_bc_id required: false source: $.http.query.child_bc_id type: number - name: transaction_level required: false source: $.http.query.transaction_level type: number - children: - type: string is_expand: true name: transaction_types required: false source: $.http.query.filtering.transaction_types[] sub_type: string type: array - children: - type: string is_expand: true name: owner_of_account required: false source: $.http.query.filtering.owner_of_account[] sub_type: string type: array - children: - type: number is_expand: true name: account_ids required: false source: $.http.query.filtering.account_ids[] sub_type: number type: array - name: account_name required: false source: $.http.query.filtering.account_name type: string - children: - type: string is_expand: true name: billing_types required: false source: $.http.query.filtering.billing_types[] sub_type: string type: array - name: start_time required: false source: $.http.query.filtering.start_time type: string - name: end_time required: false source: $.http.query.filtering.end_time type: string - 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: account_ids: $.http.query.filtering.account_ids[] account_name: $.http.query.filtering.account_name bc_id: $.http.query.bc_id billing_types: $.http.query.filtering.billing_types[] child_bc_id: $.http.query.child_bc_id end_time: $.http.query.filtering.end_time owner_of_account: $.http.query.filtering.owner_of_account[] page: $.http.query.page page_size: $.http.query.page_size start_time: $.http.query.filtering.start_time transaction_level: $.http.query.transaction_level transaction_types: $.http.query.filtering.transaction_types[] response_cookie: [] response_header: [] response_rule: page_info: $.rpc.output.page_info transaction_list: $.rpc.output.transaction_list x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/admin/delete/: post: operationId: Bc Asset Admin 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: asset_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.asset_ids asset_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.asset_type bc_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.bc_id child_bc_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.child_bc_id required: - bc_id - asset_type - asset_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: Delete assets. [BC Asset Admin Delete](https://business-api.tiktok.com/portal/docs?id=1739657251102722) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: child_bc_id required: false source: $.http.body.child_bc_id type: number - name: asset_type required: true source: $.http.body.asset_type type: number - children: - type: number name: asset_ids required: false source: $.http.body.asset_ids sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_ids: $.http.body.asset_ids asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id child_bc_id: $.http.body.child_bc_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/admin/get/: get: operationId: Bc Asset Admin Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: child_bc_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.child_bc_id x-open-field-id: 2 - description: '' in: query name: asset_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: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: false key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.asset_type x-open-field-id: 3 - content: application/json: schema: properties: advertiser_show_status: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800605795462145 enum_package_name: ShowAccountStatus enums: - description: '' is_valid: true key: SHOW_ACCOUNT_STATUS_APPROVED value: '2' - description: '' is_valid: true key: SHOW_ACCOUNT_STATUS_IN_REVIEW value: '3' - description: '' is_valid: true key: SHOW_ACCOUNT_STATUS_NOT_APPROVED value: '1' - description: '' is_valid: true key: SHOW_ACCOUNT_STATUS_PUNISHED value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.query.filtering.advertiser_show_status keyword: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.keyword relation_status: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803448727394305 enum_package_name: BCAssetRelationStatus enums: - description: '' is_valid: true key: BOUND value: '1' - description: '' is_valid: true key: PENDING value: '4' - description: 拒绝 is_valid: false key: REJECT value: '5' - description: 被拒绝 is_valid: true key: REJECTED value: '3' - description: '' is_valid: true key: UNBOUND value: '2' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.query.filtering.relation_status relation_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803448641906690 enum_package_name: AssetRelationType enums: - description: '' is_valid: true key: OWNER_BC value: '1' - description: '' is_valid: true key: OWNER_INDIVIDUAL value: '3' - description: '' is_valid: true key: OWNER_PARTNER value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.query.filtering.relation_type 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: 4 - 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: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 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: 6 - 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 assets of a Business Center as admins. [BC Asset Admin Get](https://business-api.tiktok.com/portal/docs?id=1739433007779841) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: child_bc_id required: false source: $.http.query.child_bc_id type: number - name: asset_type required: true source: $.http.query.asset_type type: number - children: - name: advertiser_show_status required: false source: $.http.query.filtering.advertiser_show_status type: number - name: keyword required: false source: $.http.query.filtering.keyword type: string - name: relation_type required: false source: $.http.query.filtering.relation_type type: number - name: relation_status required: false source: $.http.query.filtering.relation_status type: number 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: asset_type: $.http.query.asset_type bc_id: $.http.query.bc_id child_bc_id: $.http.query.child_bc_id filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - ad_creation_eligible: $.rpc.output.assets[].ad_creation_eligible advertiser_account_type: $.rpc.output.assets[].advertiser_account_type advertiser_role: $.rpc.output.assets[].advertiser_role advertiser_status: $.rpc.output.assets[].advertiser_status asset_id: $.rpc.output.assets[].asset_id asset_name: $.rpc.output.assets[].asset_name asset_type: $.rpc.output.assets[].asset_type catalog_role: $.rpc.output.assets[].catalog_role owner_bc_name: $.rpc.output.assets[].owner_bc_name pixel_code: $.rpc.output.assets[].pixel_code relation_status: $.rpc.output.assets[].relation_status relation_type: $.rpc.output.assets[].relation_type store_role: $.rpc.output.assets[].shop_role tt_account_roles: $.rpc.output.assets[].tt_account_roles page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/assign/: post: operationId: Bc Asset Assign 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_role: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356642456577 enum_package_name: AdvertiserRole enums: - description: '' is_valid: true key: ADMIN value: '0' - description: '' is_valid: true key: ANALYST value: '2' - description: '' is_valid: true key: OPERATOR value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.advertiser_role asset_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 x-open-source: $.http.body.asset_id asset_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.asset_type bc_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.bc_id catalog_role: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803438583019522 enum_package_name: CatalogRole enums: - description: '' is_valid: true key: ADMIN value: '1000' - description: '' is_valid: true key: AD_PROMOTE value: '1100' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.catalog_role form_library_role: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803457011208193 enum_package_name: FormLibraryRole enums: - description: '' is_valid: true key: ADMIN value: '6000' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 8 x-open-source: $.http.body.form_library_role store_role: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803457066320897 enum_package_name: StoreRole enums: - description: '' is_valid: true key: AD_PROMOTION value: '3100' - description: '' is_valid: true key: MANAGER value: '3000' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 9 x-open-source: $.http.body.store_role tt_account_roles: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803438620652801 enum_package_name: TTAccountRole enums: - description: '' is_valid: true key: DIRECT_MESSAGE value: '5005' - description: '' is_valid: true key: LIVE value: '5001' - description: '' is_valid: true key: POST value: '5000' 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: 7 x-open-source: $.http.body.tt_account_roles user_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.user_id required: - bc_id - user_id - asset_type - asset_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: Assign assets to a user. [BC Asset Assign](https://business-api.tiktok.com/portal/docs?id=1739438211077121) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: user_id required: true source: $.http.body.user_id type: number - name: asset_type required: true source: $.http.body.asset_type type: number - name: asset_id required: true source: $.http.body.asset_id type: number - name: advertiser_role required: false source: $.http.body.advertiser_role type: number - name: catalog_role required: false source: $.http.body.catalog_role type: number - children: - type: number name: tt_account_roles required: false source: $.http.body.tt_account_roles sub_type: number type: array - name: form_library_role required: false source: $.http.body.form_library_role type: number - name: store_role required: false source: $.http.body.store_role type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_role: $.http.body.advertiser_role asset_id: $.http.body.asset_id asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id catalog_role: $.http.body.catalog_role form_library_role: $.http.body.form_library_role store_role: $.http.body.store_role tt_account_roles: $.http.body.tt_account_roles user_id: $.http.body.user_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/get/: get: operationId: Bc Asset Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: asset_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: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: false key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.asset_type x-open-field-id: 2 - description: '' in: query name: child_bc_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.child_bc_id x-open-field-id: 3 - content: application/json: schema: properties: keyword: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.query.filtering.keyword user_email: description: '' format: email type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.user_email user_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.query.filtering.user_id 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: 4 - 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: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 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: 6 - 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 assets of a Business Center. [BC Asset Get](https://business-api.tiktok.com/portal/docs?id=1739432717798401) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: asset_type required: true source: $.http.query.asset_type type: number - name: child_bc_id required: false source: $.http.query.child_bc_id type: number - children: - name: user_id required: false source: $.http.query.filtering.user_id type: number - name: user_email required: false source: $.http.query.filtering.user_email type: string - name: keyword required: false source: $.http.query.filtering.keyword type: string 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: asset_type: $.http.query.asset_type bc_id: $.http.query.bc_id child_bc_id: $.http.query.child_bc_id filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - ad_creation_eligible: $.rpc.output.assets[].ad_creation_eligible advertiser_account_type: $.rpc.output.assets[].advertiser_account_type advertiser_role: $.rpc.output.assets[].advertiser_role asset_id: $.rpc.output.assets[].asset_id asset_name: $.rpc.output.assets[].asset_name asset_type: $.rpc.output.assets[].asset_type catalog_role: $.rpc.output.assets[].catalog_role owner_bc_name: $.rpc.output.assets[].owner_bc_name store_role: $.rpc.output.assets[].shop_role tt_account_roles: $.rpc.output.assets[].tt_account_roles page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/member/get/: get: operationId: Bc Asset Member Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: asset_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: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: false key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: false key: PIXEL value: '3' - description: '' is_valid: false key: STOREFRONT value: '5' - description: '' is_valid: false key: TIKTOK_SHOP value: '10' - description: '' is_valid: false key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.asset_type x-open-field-id: 2 - description: '' in: query name: asset_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.asset_id x-open-field-id: 3 - content: application/json: schema: properties: keyword: description: '' maxLength: 250 type: string 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-source: $.http.query.keyword description: '' in: query name: filtering required: false x-open-field-id: 4 - 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: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 20 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: 6 - 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 members by an asset. [BC Asset Member Get](https://business-api.tiktok.com/portal/docs?id=1739659558931458) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: asset_type required: true source: $.http.query.asset_type type: number - name: asset_id required: true source: $.http.query.asset_id type: number - name: keyword required: false source: $.http.query.filtering.keyword type: string - 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: asset_id: $.http.query.asset_id asset_type: $.http.query.asset_type bc_id: $.http.query.bc_id keyword: $.http.query.filtering.keyword page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list: $.rpc.output.members page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/partner/get/: get: operationId: Bc Asset Partner Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: asset_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: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.asset_type x-open-field-id: 2 - description: '' in: query name: asset_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.asset_id x-open-field-id: 3 - content: application/json: schema: properties: keyword: description: '' type: string 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-source: $.http.query.keyword description: '' in: query name: filtering required: false x-open-field-id: 4 - 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: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 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: 6 - 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 partners by assets. [BC Asset Partner Get](https://business-api.tiktok.com/portal/docs?id=1739663268166722) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: asset_type required: true source: $.http.query.asset_type type: number - name: asset_id required: true source: $.http.query.asset_id type: number - name: keyword required: false source: $.http.query.filtering.keyword type: string - 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: asset_id: $.http.query.asset_id asset_type: $.http.query.asset_type bc_id: $.http.query.bc_id keyword: $.http.query.filtering.keyword page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list: $.rpc.output.partners page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/unassign/: post: operationId: Bc Asset Unassign 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: asset_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 x-open-source: $.http.body.asset_id asset_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.asset_type bc_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.bc_id user_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.user_id required: - bc_id - user_id - asset_type - asset_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: Revoke the access to an asset from a user. [BC Asset Unassign](https://business-api.tiktok.com/portal/docs?id=1739448126749698) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: user_id required: true source: $.http.body.user_id type: number - name: asset_type required: true source: $.http.body.asset_type type: number - name: asset_id required: true source: $.http.body.asset_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_id: $.http.body.asset_id asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id user_id: $.http.body.user_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset_group/create/: post: operationId: Bc Asset_group 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: asset_group_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.asset_group_name 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.assets[].asset_id asset_type: default: ADVERTISER description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197592334338 enum_package_name: BCAssetGroupAssetType enums: - description: '' is_valid: true key: ADVERTISER value: ADVERTISER key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 2 x-open-source: $.http.body.assets[].asset_type required: - asset_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 200 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.assets bc_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.bc_id members: description: '' items: properties: asset_roles: additionalProperties: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197697677314 enum_package_name: BCAssetGroupRole enums: - description: '' is_valid: true key: ADVERTISER_ROLE_ADMIN value: ADVERTISER_ROLE_ADMIN - description: '' is_valid: true key: ADVERTISER_ROLE_ANALYST value: ADVERTISER_ROLE_ANALYST - description: '' is_valid: true key: ADVERTISER_ROLE_OPERATOR value: ADVERTISER_ROLE_OPERATOR key_format: string strict: true use_part: false validate_only: false value_format: string description: '' type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.members[].asset_roles member_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.members[].member_id required: - member_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.members required: - bc_id - asset_group_name - assets - members 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 an Asset Group in your Business Center. [BC Asset Group Create](https://business-api.tiktok.com/portal/docs?id=1749001658583105) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: asset_group_name required: true source: $.http.body.asset_group_name type: string - children: - children: - name: asset_id required: true source: $.http.body.assets[].asset_id type: string - name: asset_type required: true source: $.http.body.assets[].asset_type type: string is_expand: true type: object is_expand: true name: assets required: true source: $.http.body.assets sub_type: object type: array - children: - children: - name: member_id required: true source: $.http.body.members[].member_id type: string - children: - type: string is_expand: true name: asset_roles required: false source: $.http.body.members[].asset_roles sub_type: string type: dict is_expand: true type: object is_expand: true name: members required: true source: $.http.body.members sub_type: object type: array - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number - name: x_real_ip required: false source: $.context.source_ip type: string is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_group_name: $.http.body.asset_group_name assets: $.http.body.assets bc_id: $.http.body.bc_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id x_real_ip: $.context.source_ip members: $.http.body.members response_cookie: [] response_header: [] response_rule: asset_group_id: $.rpc.output.asset_group_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset_group/delete/: post: operationId: Bc Asset_group 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: asset_group_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 1 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.asset_group_ids bc_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.bc_id required: - bc_id - asset_group_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: Remove members' access to an Asset Group. [BC Asset Group Delete](https://business-api.tiktok.com/portal/docs?id=1749001673406466) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - children: - type: number is_expand: true name: asset_group_ids required: true source: $.http.body.asset_group_ids[] sub_type: number type: array - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_group_ids: $.http.body.asset_group_ids[] bc_id: $.http.body.bc_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset_group/get/: get: operationId: Bc Asset_group Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: asset_group_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.asset_group_id x-open-field-id: 2 - description: '' in: query name: query_entity 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: 1815197887739905 enum_package_name: BCAssetGroupQueryEntity enums: - description: '' is_valid: true key: ASSET value: ASSET - description: '' is_valid: true key: MEMBER value: MEMBER key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.query_entity x-open-field-id: 3 - content: application/json: schema: properties: keyword: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.keyword required: - keyword 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: 4 - 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: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 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: 6 - 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 the assets or members of an Asset Group in a Business Center. [BC Asset Group Get](https://business-api.tiktok.com/portal/docs?id=1749001669670913) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: asset_group_id required: true source: $.http.query.asset_group_id type: number - name: query_entity required: true source: $.http.query.query_entity type: string - children: - name: keyword required: true source: $.http.query.filtering.keyword type: string is_expand: true name: filtering required: false source: $.http.query.filtering type: object - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number - name: x_real_ip required: false source: $.context.source_ip type: string is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_group_id: $.http.query.asset_group_id bc_id: $.http.query.bc_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id x_real_ip: $.context.source_ip filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size query_entity: $.http.query.query_entity response_cookie: [] response_header: [] response_rule: asset_group: asset_group_id: $.rpc.output.asset_group.asset_group_id asset_group_name: $.rpc.output.asset_group.asset_group_name assets: $.rpc.output.asset_group.assets members: $.rpc.output.asset_group.members page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /bc/asset_group/list/: get: operationId: Bc Asset_group List parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - content: application/json: schema: properties: keyword: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.keyword required: - keyword 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: 10 format: int64 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 all Asset Groups in your Business Center. [BC Asset Group List](https://business-api.tiktok.com/portal/docs?id=1749001665910786) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - children: - name: keyword required: true source: $.http.query.filtering.keyword type: string is_expand: true name: filtering required: false source: $.http.query.filtering type: object - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number - name: x_real_ip required: false source: $.context.source_ip type: string is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id x_real_ip: $.context.source_ip filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: asset_groups[][]: - asset_group_id: $.rpc.output.asset_groups[].asset_group_id asset_group_name: $.rpc.output.asset_groups[].asset_group_name assets: $.rpc.output.asset_groups[].assets members: $.rpc.output.asset_groups[].members page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /bc/asset_group/update/: post: operationId: Bc Asset_group Update 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: action: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197776304130 enum_package_name: BCAssetGroupAction enums: - description: '' is_valid: true key: ADD value: ADD - description: '' is_valid: true key: DELETE value: DELETE key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 4 x-open-source: $.http.body.action asset_group_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.asset_group_id asset_group_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.asset_group_name 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.assets[].asset_id asset_type: default: ADVERTISER description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197592334338 enum_package_name: BCAssetGroupAssetType enums: - description: '' is_valid: true key: ADVERTISER value: ADVERTISER key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 2 x-open-source: $.http.body.assets[].asset_type required: - asset_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 200 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.assets bc_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.bc_id members: description: '' items: properties: asset_roles: additionalProperties: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197697677314 enum_package_name: BCAssetGroupRole enums: - description: '' is_valid: true key: ADVERTISER_ROLE_ADMIN value: ADVERTISER_ROLE_ADMIN - description: '' is_valid: true key: ADVERTISER_ROLE_ANALYST value: ADVERTISER_ROLE_ANALYST - description: '' is_valid: true key: ADVERTISER_ROLE_OPERATOR value: ADVERTISER_ROLE_OPERATOR key_format: string strict: true use_part: false validate_only: false value_format: string description: '' type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.members[].asset_roles member_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.members[].member_id required: - member_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.members update_entity: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197825973249 enum_package_name: BCAssetGroupUpdateEntity enums: - description: '' is_valid: true key: ASSET value: ASSET - description: '' is_valid: true key: MEMBER value: MEMBER - description: '' is_valid: true key: NAME value: NAME key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 3 x-open-source: $.http.body.update_entity required: - bc_id - asset_group_id - update_entity 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: Update assets, members or the name of an Asset Group. [BC Asset Group Update](https://business-api.tiktok.com/portal/docs?id=1749001662156801) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: asset_group_id required: true source: $.http.body.asset_group_id type: number - name: update_entity required: true source: $.http.body.update_entity type: string - name: action required: false source: $.http.body.action type: string - name: asset_group_name required: false source: $.http.body.asset_group_name type: string - children: - children: - name: asset_id required: true source: $.http.body.assets[].asset_id type: string - name: asset_type required: true source: $.http.body.assets[].asset_type type: string is_expand: true type: object is_expand: true name: assets required: false source: $.http.body.assets sub_type: object type: array - children: - children: - name: member_id required: true source: $.http.body.members[].member_id type: string - children: - type: string is_expand: true name: asset_roles required: false source: $.http.body.members[].asset_roles sub_type: string type: dict is_expand: true type: object is_expand: true name: members required: false source: $.http.body.members sub_type: object type: array - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number - name: x_real_ip required: false source: $.context.source_ip type: string is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: action: $.http.body.action asset_group_id: $.http.body.asset_group_id asset_group_name: $.http.body.asset_group_name assets: $.http.body.assets bc_id: $.http.body.bc_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id x_real_ip: $.context.source_ip members: $.http.body.members update_entity: $.http.body.update_entity response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/balance/get/: get: operationId: Bc Balance Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: child_bc_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.child_bc_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 the balance of a Business Center. [BC Balance Get](https://business-api.tiktok.com/portal/docs?id=1739939128198145) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: child_bc_id required: false source: $.http.query.child_bc_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id child_bc_id: $.http.query.child_bc_id response_cookie: [] response_header: [] response_rule: account_balance: $.rpc.output.account_balance bc_id: $.rpc.output.bc_id cash_balance: $.rpc.output.cash_balance currency: $.rpc.output.currency frozen_balance: $.rpc.output.frozen_balance grant_balance: $.rpc.output.grant_balance tax: $.rpc.output.tax valid_account_balance: $.rpc.output.valid_account_balance valid_cash_balance: $.rpc.output.valid_cash_balance valid_grant_balance: $.rpc.output.valid_grant_balance x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/billing_group/create/: post: operationId: Bc Billing_group Create parameters: - description: '' in: header name: Access-Token required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 requestBody: content: application/json: schema: properties: advertiser_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.advertiser_ids bc_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.bc_id billing_group_emails: description: '' items: type: string 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: 3 x-open-source: $.http.body.billing_group_emails billing_group_name: description: '' maxLength: 100 minLength: 1 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.billing_group_name billing_group_type: default: AUCTION description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799595859566593 enum_package_name: BillingGroupType20 enums: - description: '' is_valid: true key: AUCTION value: '2' - description: '' is_valid: true key: RESERVATION value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 6 x-open-source: $.http.body.billing_group_type is_primary: default: false description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.is_primary required: - bc_id - billing_group_name - 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: Create a billing group in a Business Center. [BC Billing Group Create](https://business-api.tiktok.com/portal/docs?id=1738947780033537) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: billing_group_name required: true source: $.http.body.billing_group_name type: string - children: - type: string is_expand: true name: billing_group_emails required: false source: $.http.body.billing_group_emails sub_type: string type: array - children: - type: number is_expand: true name: advertiser_ids required: true source: $.http.body.advertiser_ids sub_type: number type: array - name: is_primary required: true source: $.http.body.is_primary type: boolean - name: billing_group_type required: true source: $.http.body.billing_group_type type: number - name: core_user_id required: true source: $.context.core_user_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_ids: $.http.body.advertiser_ids bc_id: $.http.body.bc_id billing_group_emails: $.http.body.billing_group_emails billing_group_name: $.http.body.billing_group_name billing_group_type: $.http.body.billing_group_type core_user_id: $.context.core_user_id is_primary: $.http.body.is_primary response_cookie: [] response_header: [] response_rule: billing_group_id: $.rpc.output.billing_group_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/billing_group/get/: get: operationId: Bc Billing_group Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - content: application/json: schema: properties: billed_to_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799071172528130 enum_package_name: BillingGroupReconBillTo enums: - description: '' is_valid: true key: ACCOUNT value: '1' - description: '' is_valid: true key: ADVERTISER value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 2 x-open-source: $.http.query.filtering.recon_bill_to billing_group_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 x-open-source: $.http.query.filtering.billing_group_id billing_group_name: description: '' maxLength: 256 minLength: 1 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.query.filtering.billing_group_name billing_group_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799071211040770 enum_package_name: AdvertiserType enums: - description: '' is_valid: true key: AUCTION value: '2' - description: '' is_valid: true key: RESERVATION value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 3 x-open-source: $.http.query.filtering.advertiser_type invoice_group_by: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799071148973058 enum_package_name: BillingGroupReconGroupBy enums: - description: '' is_valid: true key: ACCOUNT value: '1' - description: '' is_valid: true key: ADVERTISER value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 1 x-open-source: $.http.query.filtering.recon_group_by status: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.query.filtering.status 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 maximum: 9223372036854776000 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: 10 format: int64 maximum: 50 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 all billing groups in a Business Center. [BC Billing Group Get](https://business-api.tiktok.com/portal/docs?id=1738944324279297) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - children: - name: recon_group_by required: false source: $.http.query.filtering.invoice_group_by type: number - name: recon_bill_to required: false source: $.http.query.filtering.billed_to_type type: number - name: advertiser_type required: false source: $.http.query.filtering.billing_group_type type: number - name: billing_group_id required: false source: $.http.query.filtering.billing_group_id type: number - name: billing_group_name required: false source: $.http.query.filtering.billing_group_name type: string - name: status required: false source: $.http.query.filtering.status type: number is_expand: true name: filtering required: false type: object - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - name: core_user_id required: true source: $.context.core_user_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id core_user_id: $.context.core_user_id filtering: advertiser_type: $.http.query.filtering.billing_group_type billing_group_id: $.http.query.filtering.billing_group_id billing_group_name: $.http.query.filtering.billing_group_name recon_bill_to: $.http.query.filtering.billed_to_type recon_group_by: $.http.query.filtering.invoice_group_by status: $.http.query.filtering.status page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - advertisers: $.rpc.output.bg_list[].advertiser_info_list billed_to_type: $.rpc.output.bg_list[].recon_bill_to billing_group_emails: $.rpc.output.bg_list[].contact_emails billing_group_id: $.rpc.output.bg_list[].billing_group_id billing_group_name: $.rpc.output.bg_list[].billing_group_name billing_group_type: $.rpc.output.bg_list[].advertiser_type invoice_group_by: $.rpc.output.bg_list[].recon_group_by invoice_object_name: $.rpc.output.bg_list[].invoice_object_name is_primary: $.rpc.output.bg_list[].is_primary status: $.rpc.output.bg_list[].status page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/billing_group/update/: post: operationId: Bc Billing_group Update 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: add_advertiser_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: 5 x-open-source: $.http.body.add_advertiser_ids bc_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.bc_id billing_group_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.billing_group_id delete_advertiser_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: 6 x-open-source: $.http.body.delete_advertiser_ids is_primary: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.is_primary new_billing_group_emails: description: '' items: format: email maxLength: 20 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: 4 x-open-source: $.http.body.billing_group_emails new_billing_group_name: description: '' maxLength: 100 minLength: 1 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.billing_group_name required: - bc_id - billing_group_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: Update settings of a billing group. [BC Billing Group Update](https://business-api.tiktok.com/portal/docs?id=1738947843447809) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: billing_group_id required: true source: $.http.body.billing_group_id type: number - name: billing_group_name required: false source: $.http.body.new_billing_group_name type: string - children: - type: string is_expand: true name: billing_group_emails required: false source: $.http.body.new_billing_group_emails[] sub_type: string type: array - children: - type: number is_expand: true name: add_advertiser_ids required: false source: $.http.body.add_advertiser_ids sub_type: number type: array - children: - type: number is_expand: true name: delete_advertiser_ids required: false source: $.http.body.delete_advertiser_ids sub_type: number type: array - name: is_primary required: false source: $.http.body.is_primary type: boolean - name: core_user_id required: true source: $.context.core_user_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: add_advertiser_ids: $.http.body.add_advertiser_ids bc_id: $.http.body.bc_id billing_group_emails: $.http.body.new_billing_group_emails[] billing_group_id: $.http.body.billing_group_id billing_group_name: $.http.body.new_billing_group_name core_user_id: $.context.core_user_id delete_advertiser_ids: $.http.body.delete_advertiser_ids is_primary: $.http.body.is_primary response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/get/: get: operationId: Bc Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: scene required: false schema: default: SINGLE_ACCOUNT type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803660327790593 enum_package_name: BCGetScene enums: - description: '' is_valid: true key: SINGLE_ACCOUNT value: '1' - description: '' is_valid: true key: TIERED_ACCOUNT value: '2' key_format: string strict: true use_part: false validate_only: true value_format: int32 x-open-source: $.http.query.scene x-open-field-id: 2 - content: application/json: schema: properties: keyword: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 keyword_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803660403768321 enum_package_name: BCSearchKeywordType enums: - description: '' is_valid: true key: ASSET value: '5' - description: '' is_valid: true key: MEMBER value: '4' - description: '' is_valid: true key: PARTNER value: '3' - description: '' is_valid: true key: TIER value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 relation_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803660432711682 enum_package_name: TierBCRelationType enums: - description: '' is_valid: true key: CHILD value: '2' - description: '' is_valid: true key: PARENT value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 type: object x-open-allow-strlist: false x-open-allow-strnum: false description: '' in: query name: filtering required: false x-open-field-id: 3 - description: '' in: query name: page required: false schema: default: 1 format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 4 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 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: 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 Business Centers that you have access to. [BC Get](https://business-api.tiktok.com/portal/docs?id=1737115687501826) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: false source: $.http.query.bc_id type: number - name: scene required: false source: $.http.query.scene type: string - name: keyword required: false source: $.http.query.filtering.keyword type: string - name: keyword_type required: false source: $.http.query.filtering.keyword_type type: number - name: relation_type required: false source: $.http.query.filtering.relation_type 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: bc_id: $.http.query.bc_id keyword: $.http.query.filtering.keyword keyword_type: $.http.query.filtering.keyword_type page: $.http.query.page page_size: $.http.query.page_size relation_type: $.http.query.filtering.relation_type scene: $.http.query.scene response_cookie: [] response_header: [] response_rule: list[][]: - bc_info[]: - bc_id: $.rpc.output.bc_infos[].bc_base_info.bc_id company: $.rpc.output.bc_infos[].bc_base_info.company currency: $.rpc.output.bc_infos[].bc_base_info.currency name: $.rpc.output.bc_infos[].bc_base_info.bc_name organization_type: $.rpc.output.bc_infos[].bc_base_info.organization_type registered_area: $.rpc.output.bc_infos[].bc_base_info.registered_area status: $.rpc.output.bc_infos[].bc_base_info.status timezone: $.rpc.output.bc_infos[].bc_base_info.timezone type: $.rpc.output.bc_infos[].bc_base_info.type binding_status: $.rpc.output.bc_infos[].binding_status ext_user_role: $.rpc.output.bc_infos[].ext_user_role user_role: $.rpc.output.bc_infos[].user_role page_info: $.rpc.output.page_info parent_bc: bc_info: bc_id: $.rpc.output.parent_bc.bc_base_info.bc_id company: $.rpc.output.parent_bc.bc_base_info.company currency: $.rpc.output.parent_bc.bc_base_info.currency name: $.rpc.output.parent_bc.bc_base_info.bc_name organization_type: $.rpc.output.parent_bc.bc_base_info.organization_type registered_area: $.rpc.output.parent_bc.bc_base_info.registered_area status: $.rpc.output.parent_bc.bc_base_info.status timezone: $.rpc.output.parent_bc.bc_base_info.timezone type: $.rpc.output.parent_bc.bc_base_info.type binding_status: $.rpc.output.parent_bc.binding_status ext_user_role: $.rpc.output.parent_bc.ext_user_role user_role: $.rpc.output.parent_bc.user_role x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /bc/invoice/unpaid/get/: get: operationId: Bc Invoice Unpaid Get parameters: - description: '' in: query name: bc_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: 1 - description: '' in: query name: invoice_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: null enum_package_name: null enums: - description: '' is_valid: true key: RECON value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 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: Finance Managers and Finance Analysts of a Business Center account can use this endpoint to get total unpaid amount of their Business Center accounts. [BC Invoice Unpaid Get](https://business-api.tiktok.com/portal/docs?id=1740295904843777) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: BcId required: false source: $.http.query.bc_id type: number - name: Classify required: false source: $.http.query.invoice_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: BcId: $.http.query.bc_id Classify: $.http.query.invoice_type response_cookie: [] response_header: [] response_rule: result: $.rpc.output.Currency2NeedPayAmount x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/member/delete/: post: operationId: Bc Member 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: bc_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.bc_id child_bc_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.child_bc_id user_email: description: '' format: email type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.user_email user_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.user_id required: - bc_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 member. [BC Member Delete](https://business-api.tiktok.com/portal/docs?id=1739939482851329) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: child_bc_id required: false source: $.http.body.child_bc_id type: number - name: user_id required: false source: $.http.body.user_id type: number - name: user_email required: false source: $.http.body.user_email type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id child_bc_id: $.http.body.child_bc_id user_email: $.http.body.user_email user_id: $.http.body.user_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/member/get/: get: operationId: Bc Member Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: child_bc_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - string(%s) x-open-source: $.http.query.child_bc_id x-open-field-id: 2 - content: application/json: schema: properties: keyword: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.keyword relation_status: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802163238919169 enum_package_name: UserRelationStatusToBC enums: - description: '' is_valid: true key: BOUND value: '1' - description: '' is_valid: true key: PENDING value: '4' - description: 被拒绝 is_valid: true key: REJECTED value: '3' - description: '' is_valid: true key: UNBOUND value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.query.filtering.relation_status user_role: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802163064740866 enum_package_name: BCUserRole enums: - description: '' is_valid: true key: ADMIN value: '1' - description: '' is_valid: true key: STANDARD value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.query.filtering.user_role 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: 3 - description: '' in: query name: page required: false schema: default: 1 format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 4 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 BC members. [BC Member Get](https://business-api.tiktok.com/portal/docs?id=1739939404802049) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: child_bc_id required: false source: $.http.query.child_bc_id type: number - children: - name: keyword required: false source: $.http.query.filtering.keyword type: string - name: user_role required: false source: $.http.query.filtering.user_role type: number - name: relation_status required: false source: $.http.query.filtering.relation_status type: number 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: bc_id: $.http.query.bc_id child_bc_id: $.http.query.child_bc_id filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - ext_user_role[]: - finance_role: $.rpc.output.members[].finance_role relation_status: $.rpc.output.members[].relation_status user_email: $.rpc.output.members[].user_email user_id: $.rpc.output.members[].user_id user_name: $.rpc.output.members[].user_name user_role: $.rpc.output.members[].user_role page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/member/invite/: post: operationId: Bc Member Invite 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_role: default: ANALYST description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356642456577 enum_package_name: AdvertiserRole enums: - description: '' is_valid: true key: ADMIN value: '0' - description: '' is_valid: true key: ANALYST value: '2' - description: '' is_valid: true key: OPERATOR value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.advertiser_role asset_ids: description: '' items: default: '[]' 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: 5 x-open-source: $.http.body.asset_ids asset_type: default: ADVERTISER description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: false key: CATALOG value: '4' - description: '' is_valid: false key: DOMAIN value: '6' - description: '' is_valid: false key: LEAD value: '9' - description: '' is_valid: false key: PIXEL value: '3' - description: '' is_valid: false key: STOREFRONT value: '5' - description: '' is_valid: false key: TIKTOK_SHOP value: '10' - description: '' is_valid: false key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.asset_type bc_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.bc_id emails: description: '' items: format: email type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.emails ext_user_role: description: '' properties: finance_role: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802167339779074 enum_package_name: BCFinanceRole enums: - description: '' is_valid: true key: ANALYST value: '6' - description: '' is_valid: true key: MANAGER value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 user_role: default: STANDARD description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802163064740866 enum_package_name: BCUserRole enums: - description: '' is_valid: true key: ADMIN value: '1' - description: '' is_valid: true key: STANDARD value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.user_role required: - bc_id - emails 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: Invite members to BC. [BC Member Invite](https://business-api.tiktok.com/portal/docs?id=1739939455765505) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - children: - type: string is_expand: true name: emails required: true source: $.http.body.emails sub_type: string type: array - name: user_role required: false source: $.http.body.user_role type: number - name: asset_type required: false source: $.http.body.asset_type type: number - children: - type: number is_expand: true name: asset_ids required: true source: $.http.body.asset_ids sub_type: number type: array - name: advertiser_role required: false source: $.http.body.advertiser_role type: number - name: finance_role required: false source: $.http.body.ext_user_role.finance_role type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_role: $.http.body.advertiser_role asset_ids: $.http.body.asset_ids asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id emails: $.http.body.emails finance_role: $.http.body.ext_user_role.finance_role user_role: $.http.body.user_role response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/member/update/: post: operationId: Bc Member Update 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: bc_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.bc_id child_bc_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.child_bc_id ext_user_role: description: '' properties: finance_role: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802167339779074 enum_package_name: BCFinanceRole enums: - description: '' is_valid: true key: ANALYST value: '6' - description: '' is_valid: true key: MANAGER value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.finance_role user_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.user_id user_name: description: '' maxLength: 250 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.user_name user_role: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802163064740866 enum_package_name: BCUserRole enums: - description: '' is_valid: true key: ADMIN value: '1' - description: '' is_valid: true key: STANDARD value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.user_role required: - bc_id - user_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: Update member information. [BC Member Update](https://business-api.tiktok.com/portal/docs?id=1739696704424961) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: child_bc_id required: false source: $.http.body.child_bc_id type: number - name: user_id required: true source: $.http.body.user_id type: number - name: user_role required: false source: $.http.body.user_role type: number - name: user_name required: false source: $.http.body.user_name type: string - name: finance_role required: false source: $.http.body.ext_user_role.finance_role type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id child_bc_id: $.http.body.child_bc_id finance_role: $.http.body.ext_user_role.finance_role user_id: $.http.body.user_id user_name: $.http.body.user_name user_role: $.http.body.user_role response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/partner/add/: post: operationId: Bc Partner Add 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_role: default: ANALYST description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356642456577 enum_package_name: AdvertiserRole enums: - description: '' is_valid: true key: ADMIN value: '0' - description: '' is_valid: true key: ANALYST value: '2' - description: '' is_valid: true key: OPERATOR value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 7 x-open-source: $.http.body.advertiser_role asset_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 50 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.asset_ids asset_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: false key: CATALOG value: '4' - description: '' is_valid: false key: DOMAIN value: '6' - description: '' is_valid: false key: LEAD value: '9' - description: '' is_valid: false key: PIXEL value: '3' - description: '' is_valid: false key: STOREFRONT value: '5' - description: '' is_valid: false key: TIKTOK_SHOP value: '10' - description: '' is_valid: false key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.asset_type bc_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.bc_id catalog_role: default: AD_PROMOTE description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803438583019522 enum_package_name: CatalogRole enums: - description: '' is_valid: true key: ADMIN value: '1000' - description: '' is_valid: true key: AD_PROMOTE value: '1100' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 8 x-open-source: $.http.body.catalog_role partner_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 x-open-source: $.http.body.partner_id source_child_bc_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.source_child_bc_id target_child_bc_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.target_child_bc_id required: - bc_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: Add partner to Business Center. [BC Partner Add](https://business-api.tiktok.com/portal/docs?id=1739662756510721) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: target_child_bc_id required: false source: $.http.body.target_child_bc_id type: number - name: source_child_bc_id required: false source: $.http.body.source_child_bc_id type: number - name: partner_id required: false source: $.http.body.partner_id type: number - name: asset_type required: true source: $.http.body.asset_type type: number - children: - type: number name: asset_ids required: true source: $.http.body.asset_ids sub_type: number type: array - name: advertiser_role required: false source: $.http.body.advertiser_role type: number - name: catalog_role required: false source: $.http.body.catalog_role type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_role: $.http.body.advertiser_role asset_ids: $.http.body.asset_ids asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id catalog_role: $.http.body.catalog_role partner_id: $.http.body.partner_id source_child_bc_id: $.http.body.source_child_bc_id target_child_bc_id: $.http.body.target_child_bc_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/partner/asset/delete/: post: operationId: Bc Partner 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: asset_ids: description: '' items: default: '[]' 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: 4 x-open-source: $.http.body.asset_ids asset_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.asset_type bc_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.bc_id partner_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.partner_id required: - bc_id - partner_id - asset_type - asset_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: Cancel asset sharing. [BC Partner Asset Delete](https://business-api.tiktok.com/portal/docs?id=1739662800930817) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: partner_id required: true source: $.http.body.partner_id type: number - name: asset_type required: true source: $.http.body.asset_type type: number - children: - type: number name: asset_ids required: true source: $.http.body.asset_ids sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_ids: $.http.body.asset_ids asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id partner_id: $.http.body.partner_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/partner/asset/get/: get: operationId: Bc Partner Asset Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: partner_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.partner_id x-open-field-id: 2 - description: '' in: query name: asset_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: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: false key: LEAD value: '9' - description: '' is_valid: false key: PIXEL value: '3' - description: '' is_valid: false key: STOREFRONT value: '5' - description: '' is_valid: false key: TIKTOK_SHOP value: '10' - description: '' is_valid: false key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.asset_type x-open-field-id: 3 - description: '' in: query name: share_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: 1803477991512065 enum_package_name: ShareType enums: - description: '' is_valid: true key: SHARED value: '2' - description: '' is_valid: true key: SHARING value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.share_type x-open-field-id: 4 - content: application/json: schema: properties: keyword: description: '' type: string 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-source: $.http.query.keyword description: '' in: query name: filtering required: false x-open-field-id: 5 - 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: 6 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 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: 7 - 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 partner assets. [BC Partner Asset Get](https://business-api.tiktok.com/portal/docs?id=1739662828320769) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: partner_id required: true source: $.http.query.partner_id type: number - name: asset_type required: true source: $.http.query.asset_type type: number - name: share_type required: true source: $.http.query.share_type type: number - name: keyword required: false source: $.http.query.filtering.keyword type: string - 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: asset_type: $.http.query.asset_type bc_id: $.http.query.bc_id keyword: $.http.query.filtering.keyword page: $.http.query.page page_size: $.http.query.page_size partner_id: $.http.query.partner_id share_type: $.http.query.share_type response_cookie: [] response_header: [] response_rule: list: $.rpc.output.assets page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/partner/delete/: post: operationId: Bc Partner 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: bc_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.bc_id partner_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.partner_id required: - bc_id - partner_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 partner. [BC Partner Delete](https://business-api.tiktok.com/portal/docs?id=1739662779301890) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: partner_id required: true source: $.http.body.partner_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id partner_id: $.http.body.partner_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/partner/get/: get: operationId: Bc Partner Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - 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: 2 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 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: 3 - content: application/json: schema: properties: name: description: '' type: string 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 description: '' in: query name: filtering required: false 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 partners. [BC Partner Get](https://business-api.tiktok.com/portal/docs?id=1739662727395330) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: keyword required: false source: $.http.query.filtering.name type: string - 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: bc_id: $.http.query.bc_id keyword: $.http.query.filtering.name page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list: $.rpc.output.partners page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/pixel/link/get/: get: operationId: Bc Pixel Link Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: pixel_code required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.pixel_code 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: 10 format: int64 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: Use this endpoint to get a list of ad accounts that have been linked to the request pixel. [BC Pixel Link Get](https://business-api.tiktok.com/portal/docs?id=1753994966965249) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: pixel_code required: true source: $.http.query.pixel_code type: string - 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: bc_id: $.http.query.bc_id page: $.http.query.page page_size: $.http.query.page_size pixel_code: $.http.query.pixel_code response_cookie: [] response_header: [] response_rule: list: $.rpc.output.advertisers page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/pixel/link/update/: post: operationId: Bc Pixel Link Update 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_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.advertiser_ids bc_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.bc_id pixel_code: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.pixel_code relation_status: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803549054361601 enum_package_name: PixelAdvertiserRelationStatus enums: - description: '' is_valid: true key: LINK value: '999' - description: '' is_valid: true key: UNLINK value: '9999' key_format: string strict: true use_part: false validate_only: true value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.relation_status required: - bc_id - pixel_code - advertiser_ids - relation_status 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 link and unlink pixel to advertiser accounts. [BC Pixel Link Update](https://business-api.tiktok.com/portal/docs?id=1753994950327297) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: pixel_code required: true source: $.http.body.pixel_code type: string - children: - type: number name: advertiser_ids required: true source: $.http.body.advertiser_ids sub_type: number type: array - name: relation_status required: true source: $.http.body.relation_status type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_ids: $.http.body.advertiser_ids bc_id: $.http.body.bc_id pixel_code: $.http.body.pixel_code relation_status: $.http.body.relation_status response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/pixel/transfer/: post: operationId: Bc Pixel Transfer 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: bc_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.bc_id pixel_code: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.pixel_code required: - bc_id - pixel_code 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: Transfer Pixel from Advertiser to BC. [BC Pixel Transfer](https://business-api.tiktok.com/portal/docs?id=1753994928261122) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: pixel_code required: true source: $.http.body.pixel_code type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id pixel_code: $.http.body.pixel_code response_cookie: [] response_header: [] response_rule: asset_id: $.rpc.output.asset_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/transaction/get/: get: operationId: Bc Transaction Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - content: application/json: schema: properties: funds_type: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803629000016898 enum_package_name: FundsType enums: - description: '' is_valid: true key: FUNDS_TYPE_CASH value: '1' - description: '' is_valid: true key: FUNDS_TYPE_GRANT 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: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.funds_types description: '' in: query name: filtering required: false x-open-field-id: 2 - description: '' in: query name: start_date required: false schema: format: date type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.start_date x-open-field-id: 3 - description: '' in: query name: end_date required: false schema: format: date type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.end_date x-open-field-id: 4 - description: '' in: query name: page required: false schema: default: 1 format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 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: 6 - 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 translaction records of a Business Center. [BC Transaction Get](https://business-api.tiktok.com/portal/docs?id=1739939140408322) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - children: - type: number is_expand: true name: funds_types required: false source: $.http.query.filtering.funds_type[] sub_type: number type: array - name: start_date required: false source: $.http.query.start_date type: string - name: end_date required: false source: $.http.query.end_date type: string - 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: bc_id: $.http.query.bc_id end_date: $.http.query.end_date funds_types: $.http.query.filtering.funds_type[] page: $.http.query.page page_size: $.http.query.page_size start_date: $.http.query.start_date response_cookie: [] response_header: [] response_rule: list: $.rpc.output.transactions page_info: $.rpc.output.page_info transaction_summary: $.rpc.output.transaction_summary x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/transfer/: post: operationId: Bc Transfer 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: 4 x-open-source: $.http.body.advertiser_id bc_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.bc_id cash_amount: description: '' format: float type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.cash_amount child_bc_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.child_bc_id grant_amount: description: '' format: float type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.grant_amount request_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.request_id transfer_level: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.transfer_level transfer_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1811243935576066 enum_package_name: TransferType enums: - description: '' is_valid: true key: RECHARGE value: '1' - description: '' is_valid: true key: REFUND value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.transfer_type required: - bc_id - transfer_type 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: Process payments (recharge money to or deduct money from an ad account in a Business Center. [BC Transfer](https://business-api.tiktok.com/portal/docs?id=1739939095321601) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: child_bc_id required: false source: $.http.body.child_bc_id type: number - name: transfer_level required: false source: $.http.body.transfer_level type: string - name: advertiser_id required: false source: $.http.body.advertiser_id type: number - name: transfer_type required: true source: $.http.body.transfer_type type: number - name: cash_amount required: false source: $.http.body.cash_amount type: number - name: grant_amount required: false source: $.http.body.grant_amount type: number - name: request_id required: false source: $.http.body.request_id type: string - 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: 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 bc_id: $.http.body.bc_id cash_amount: $.http.body.cash_amount child_bc_id: $.http.body.child_bc_id context_info: $.http.body.context_info grant_amount: $.http.body.grant_amount request_id: $.http.body.request_id transfer_level: $.http.body.transfer_level transfer_type: $.http.body.transfer_type response_cookie: [] response_header: [] response_rule: advertiser_id: $.rpc.output.advertiser_id bc_id: $.rpc.output.bc_id child_bc_id: $.rpc.output.child_bc_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/create/: post: operationId: Bc 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: bc_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.bc_name company_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.company contact_info: description: '' properties: email: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 phone: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 phone_region_code: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 secondary_industry: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 currency: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.currency plugin_partner: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.plugin_partner registered_area: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.registered_area timezone: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.timezone type: default: NORMAL description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803660610513921 enum_package_name: BusinessCenterType enums: - description: '' is_valid: false key: AGENCY value: '2' - description: '' is_valid: false key: DIRECT value: '4' - description: '' is_valid: true key: NORMAL value: '1' - description: '' is_valid: true key: SELF_SERVICE value: '5' - description: '' is_valid: true key: SELF_SERVICE_AGENCY value: '6' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.type required: - bc_name - timezone 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: null tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_name required: true source: $.http.body.bc_name type: string - name: timezone required: true source: $.http.body.timezone type: string - name: plugin_partner required: false source: $.http.body.plugin_partner type: string - name: type required: false source: $.http.body.type type: number - name: registered_area required: false source: $.http.body.registered_area type: string - name: currency required: false source: $.http.body.currency type: string - name: company required: false source: $.http.body.company_name type: string - children: - name: secondary_industry required: false type: number - name: name required: false type: string - name: email required: false type: string - name: phone required: false type: string - name: phone_region_code required: false type: string is_expand: true name: contact_info required: false source: $.http.body.contact_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_name: $.http.body.bc_name company: $.http.body.company_name contact_info: $.http.body.contact_info currency: $.http.body.currency plugin_partner: $.http.body.plugin_partner registered_area: $.http.body.registered_area timezone: $.http.body.timezone type: $.http.body.type response_cookie: [] response_header: [] response_rule: bc_id: $.rpc.output.bc_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/image/upload/: post: operationId: Bc Image 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: bc_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.bc_id image_file: description: '' format: binary type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.image_file required: - bc_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: null tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: image_file required: false source: $.http.body.image_file type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id image_file: $.http.body.image_file response_cookie: [] response_header: [] response_rule: image_id: $.rpc.output.image_id image_url: $.rpc.output.image_url x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/member/assign/: post: operationId: Bc Member Assign 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: bc_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.bc_id target_child_bc_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.target_child_bc_id users: description: '' items: properties: ext_user_role: description: '' properties: finance_role: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802167339779074 enum_package_name: BCFinanceRole enums: - description: '' is_valid: true key: ANALYST value: '6' - description: '' is_valid: true key: MANAGER value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.members[].finance_role source_child_bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 x-open-source: $.http.body.members[].source_child_bc_id user_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.members[].user_id user_role: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802163064740866 enum_package_name: BCUserRole enums: - description: '' is_valid: true key: ADMIN value: '1' - description: '' is_valid: true key: STANDARD value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.members[].user_role required: - user_id - source_child_bc_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 100 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.members required: - bc_id - target_child_bc_id - users 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: null tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: target_child_bc_id required: true source: $.http.body.target_child_bc_id type: number - children: - children: - name: user_id required: false source: $.http.body.users[].user_id type: number - name: user_role required: false source: $.http.body.users[].user_role type: number - name: finance_role required: false source: $.http.body.users[].ext_user_role.finance_role type: number - name: source_child_bc_id required: false source: $.http.body.users[].source_child_bc_id type: number is_expand: true type: object is_expand: true name: members required: true source: '' sub_type: object type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id members[][]: - finance_role: $.http.body.users[].ext_user_role.finance_role source_child_bc_id: $.http.body.users[].source_child_bc_id user_id: $.http.body.users[].user_id user_role: $.http.body.users[].user_role target_child_bc_id: $.http.body.target_child_bc_id response_cookie: [] response_header: [] response_rule: null 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