TOOL API

lead_field_get

Retrieves the field names collected by an Instant Form or by direct message leads using /open_api/v1.3/lead/field/get/. The source is controlled by `lead_source`: `INSTANT_FORM` returns fields for an Instant Form, and `DIRECT_MESSAGE` returns fields for leads generated from direct messages of the associated Business Account. Depending on where the leads are stored, you may need an ad account `advertiser_id` or a Business Center form library `library_id`. To look up required IDs, use /page/library/get/ for form libraries and /page/get/ with `business_type=LEAD_GEN` for Instant Form pages.

ecommerceOAuth1 credits

Call information

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

Input parameters

advertiser_id

Advertiser ID. Required when the leads are under an ad account.

lead_sourcerequired

Source of the leads. `INSTANT_FORM` means leads generated through an Instant Form; when set to `INSTANT_FORM`, `page_id` is required. `DIRECT_MESSAGE` means leads generated from direct messages of the associated Business Account; when set to `DIRECT_MESSAGE`, `page_id` is not supported.

library_id

ID of a form library. Required when the leads are under a form library of a Business Center. To obtain valid library IDs, use /page/library/get/.

page_id

Page ID of an Instant Form. Required when `lead_source` is `INSTANT_FORM`. Not supported when `lead_source` is `DIRECT_MESSAGE`. To obtain valid Instant Form page IDs, use /page/get/ and set `business_type` to `LEAD_GEN`.