TikTok Lead Generation

App · 9 actions

Retrieve TikTok Instant Form and direct-message leads, manage test leads, and start regional lead export jobs.

Actions

ActionWhat it does
Create lead exportCreate lead export.
Create test leadCreate test lead.
Delete test leadDelete test lead.
Get latest leadGet latest lead.
Get lead export statusGet lead export status.
Get lead fieldsGet lead fields.
Get test leadGet test lead.
List form librariesList form libraries.
List instant formsList instant forms.

Create lead export

Create lead export.

Inputs

Advertiser idadvertiser_idtext
Advertiser id.
Library idlibrary_idtext
Library id.
Pagepage_idtext
Page id.
Ad idad_idtext
Ad id.
Lead regionlead_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 idadvertiser_idtext
Advertiser id.
Library idlibrary_idtext
Library id.
Lead sourcelead_sourcetext
Lead source.One of: INSTANT_FORM (Instant form), DIRECT_MESSAGE (Direct message).
Pagepage_idtext
Page id.

Outputs

dataobject
Tik Tok Lead Generation response data.
Example output
{
  "data": {}
}

Delete test lead

Delete test lead.

Inputs

Advertiser idadvertiser_idtext
Advertiser id.
Library idlibrary_idtext
Library id.
Lead idlead_idtextRequired
Lead id.

Outputs

dataobject
Tik Tok Lead Generation response data.
Example output
{
  "data": {}
}

Get latest lead

Get latest lead.

Inputs

Advertiser idadvertiser_idtext
Advertiser id.
Library idlibrary_idtext
Library id.
Lead sourcelead_sourcetext
Lead source.One of: INSTANT_FORM (Instant form), DIRECT_MESSAGE (Direct message).
Pagepage_idtext
Page id.

Outputs

dataobject
Tik Tok Lead Generation response data.
Example output
{
  "data": {}
}

Get lead export status

Get lead export status.

Inputs

Advertiser idadvertiser_idtext
Advertiser id.
Library idlibrary_idtext
Library id.
Pagepage_idtext
Page id.
Ad idad_idtext
Ad id.
Lead regionlead_regiontext
Lead region.One of: eu, us.
Task idtask_idtextRequired
Task id.

Outputs

dataobject
Tik Tok Lead Generation response data.
Example output
{
  "data": {}
}

Get lead fields

Get lead fields.

Inputs

Advertiser idadvertiser_idtext
Advertiser id.
Library idlibrary_idtext
Library id.
Lead sourcelead_sourcetext
Lead source.One of: INSTANT_FORM (Instant form), DIRECT_MESSAGE (Direct message).
Pagepage_idtext
Page id.

Outputs

dataobject
Tik Tok Lead Generation response data.
Example output
{
  "data": {}
}

Get test lead

Get test lead.

Inputs

Advertiser idadvertiser_idtext
Advertiser id.
Library idlibrary_idtext
Library id.
Lead sourcelead_sourcetext
Lead source.One of: INSTANT_FORM (Instant form), DIRECT_MESSAGE (Direct message).
Pagepage_idtext
Page id.

Outputs

dataobject
Tik Tok Lead Generation response data.
Example output
{
  "data": {}
}

List form libraries

List form libraries.

Inputs

Pagepagenumber
Page.At least 1.
Page sizepage_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 idadvertiser_idtext
Advertiser id.
Library idlibrary_idtext
Library id.
Pagepagenumber
Page.At least 1.
Page sizepage_sizenumber
Page size.From 1 to 100.
Statusstatustext
Status.One of: EDITED, PUBLISHED.
Titletitletext
Title.

Outputs

dataobject
Tik Tok Lead Generation response data.
Example output
{
  "data": {}
}

On this page