TikTok Lead Generation
App · 9 actions
Retrieve TikTok Instant Form and direct-message leads, manage test leads, and start regional lead export jobs.
Actions
| Action | What it does |
|---|---|
| Create lead export | Create lead export. |
| Create test lead | Create test lead. |
| Delete test lead | Delete test lead. |
| Get latest lead | Get latest lead. |
| Get lead export status | Get lead export status. |
| Get lead fields | Get lead fields. |
| Get test lead | Get test lead. |
| List form libraries | List form libraries. |
| List instant forms | List instant forms. |
Create lead export
Create lead export.
Inputs
- Advertiser id
advertiser_idtext - Advertiser id.
- Library id
library_idtext - Library id.
- Page
page_idtext - Page id.
- Ad id
ad_idtext - Ad id.
- Lead region
lead_regiontext - Lead region.One of:
eu,us.
Outputs
dataobject- Tik Tok Lead Generation response data.
Example output
{
"data": {}
}Create test lead
Create test lead.
Inputs
- Advertiser id
advertiser_idtext - Advertiser id.
- Library id
library_idtext - Library id.
- Lead source
lead_sourcetext - Lead source.One of:
INSTANT_FORM(Instant form),DIRECT_MESSAGE(Direct message). - Page
page_idtext - Page id.
Outputs
dataobject- Tik Tok Lead Generation response data.
Example output
{
"data": {}
}Delete test lead
Delete test lead.
Inputs
- Advertiser id
advertiser_idtext - Advertiser id.
- Library id
library_idtext - Library id.
- Lead id
lead_idtextRequired - Lead id.
Outputs
dataobject- Tik Tok Lead Generation response data.
Example output
{
"data": {}
}Get latest lead
Get latest lead.
Inputs
- Advertiser id
advertiser_idtext - Advertiser id.
- Library id
library_idtext - Library id.
- Lead source
lead_sourcetext - Lead source.One of:
INSTANT_FORM(Instant form),DIRECT_MESSAGE(Direct message). - Page
page_idtext - Page id.
Outputs
dataobject- Tik Tok Lead Generation response data.
Example output
{
"data": {}
}Get lead export status
Get lead export status.
Inputs
- Advertiser id
advertiser_idtext - Advertiser id.
- Library id
library_idtext - Library id.
- Page
page_idtext - Page id.
- Ad id
ad_idtext - Ad id.
- Lead region
lead_regiontext - Lead region.One of:
eu,us. - Task id
task_idtextRequired - Task id.
Outputs
dataobject- Tik Tok Lead Generation response data.
Example output
{
"data": {}
}Get lead fields
Get lead fields.
Inputs
- Advertiser id
advertiser_idtext - Advertiser id.
- Library id
library_idtext - Library id.
- Lead source
lead_sourcetext - Lead source.One of:
INSTANT_FORM(Instant form),DIRECT_MESSAGE(Direct message). - Page
page_idtext - Page id.
Outputs
dataobject- Tik Tok Lead Generation response data.
Example output
{
"data": {}
}Get test lead
Get test lead.
Inputs
- Advertiser id
advertiser_idtext - Advertiser id.
- Library id
library_idtext - Library id.
- Lead source
lead_sourcetext - Lead source.One of:
INSTANT_FORM(Instant form),DIRECT_MESSAGE(Direct message). - Page
page_idtext - Page id.
Outputs
dataobject- Tik Tok Lead Generation response data.
Example output
{
"data": {}
}List form libraries
List form libraries.
Inputs
- Page
pagenumber - Page.At least 1.
- Page size
page_sizenumber - Page size.From 1 to 100.
Outputs
dataobject- Tik Tok Lead Generation response data.
Example output
{
"data": {}
}List instant forms
List instant forms.
Inputs
- Advertiser id
advertiser_idtext - Advertiser id.
- Library id
library_idtext - Library id.
- Page
pagenumber - Page.At least 1.
- Page size
page_sizenumber - Page size.From 1 to 100.
- Status
statustext - Status.One of:
EDITED,PUBLISHED. - Title
titletext - Title.
Outputs
dataobject- Tik Tok Lead Generation response data.
Example output
{
"data": {}
}