TOOL API

page_lead_task_download

Downloads leads for a completed lead download task created through `/page/lead/task/`. You must create the task first and wait until its `status` is `SUCCEED` before calling this endpoint. On success, the response is lead data in UTC+0 as a CSV file when the original CSV is <= 10MB, or a ZIP file when the original CSV is > 10MB, rather than JSON. On error, the endpoint may return JSON or may write an error message into the returned CSV file, depending on the error type. To protect customer information, only ad account admins can create/query lead download tasks or download leads; ad account roles are configured in the Business Center. If leads are migrated to a Business Center, only Business Center Admins can download them. Only support returning data from regions other than EEA/CH/UK/US.

ecommerceOAuth1 credits

Call information

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

Input parameters

advertiser_id

Required when the leads are under an ad account. Provide the advertiser ID in this case.

library_id

Required when the leads are under a Business Center. Provide the ID of the form library that contains the leads.

task_idrequired

Required task ID of the lead download task. The task must be created through `/page/lead/task/`, and you should call this endpoint only after that task reaches `status = SUCCEED`.