LinkedIn Lead Gen Forms and Conversion API

App · 11 actions

Read lead forms and responses, manage notifications and conversion rules, and report server-side conversion events.

Actions

ActionWhat it does
Create conversionCreate conversion.
Create formCreate form.
Create lead notificationCreate lead notification.
Delete lead notificationDelete lead notification.
Get conversionGet conversion.
Get formGet form.
Get responseGet response.
List conversionsList conversions.
List formsList forms.
List responsesList responses.
Send conversionSend conversion.

Create conversion

Create conversion.

Inputs

NamenametextRequired
Name.
Accountaccounttext
Account.
TypetypetextRequired
Type.One of: ADD_TO_CART (Add to cart), DOWNLOAD, INSTALL, KEY_PAGE_VIEW (Key page view), LEAD, PURCHASE, SIGN_UP (Sign up), OTHER.
Post click attribution window sizepost_click_attribution_window_sizenumberRequired
Post click attribution window size.One of: 1, 7, 30, 90.
View through attribution window sizeview_through_attribution_window_sizenumberRequired
View through attribution window size.One of: 1, 7, 30, 90.
Attribution typeattribution_typetextRequired
Attribution type.One of: LAST_TOUCH_BY_CAMPAIGN (Last touch by campaign), LAST_TOUCH_BY_CONVERSION (Last touch by conversion).

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {
    "id": "example"
  }
}

Create form

Create form.

Inputs

OwnerownerobjectRequired
Owner.
NamenametextRequired
Name.
Creation localecreation_localeobjectRequired
Creation locale.
ContentcontentobjectRequired
Content.
StatestatetextRequired
State.One of: DRAFT, PUBLISHED.
Hidden fieldshidden_fieldslist
Hidden fields.

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {
    "id": "example"
  }
}

Create lead notification

Create lead notification.

Inputs

WebhookwebhooktextRequired
Webhook.
OwnerownerobjectRequired
Owner.
Lead typelead_typetextRequired
Lead type.One of: SPONSORED, EVENT, COMPANY, ORGANIZATION_PRODUCT (Organization product).
Versioned formversioned_formtext
Versioned form.

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {
    "id": "example"
  }
}

Delete lead notification

Delete lead notification.

Inputs

Notification idnotification_idtextRequired
Notification id.

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {}
}

Get conversion

Get conversion.

Inputs

Conversion idconversion_idtextRequired
Conversion id.

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {}
}

Get form

Get form.

Inputs

Form idform_idtextRequired
Form id.

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {}
}

Get response

Get response.

Inputs

Response idresponse_idtextRequired
Response id.

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {}
}

List conversions

List conversions.

Inputs

Accountaccounttext
Account.
Startstartnumber
Start.At least 0.
Countcountnumber
Count.From 1 to 100.

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {
    "elements": []
  }
}

List forms

List forms.

Inputs

Owner idowner_idtext
Owner id.
Owner typeowner_typetext
Owner type.One of: sponsoredAccount, organization.
Startstartnumber
Start.At least 0.
Countcountnumber
Count.From 1 to 100.

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {
    "elements": []
  }
}

List responses

List responses.

Inputs

Owner idowner_idtext
Owner id.
Owner typeowner_typetext
Owner type.One of: sponsoredAccount, organization.
Lead typelead_typetextRequired
Lead type.One of: SPONSORED, EVENT, COMPANY, ORGANIZATION_PRODUCT (Organization product).
Startstartnumber
Start.At least 0.
Countcountnumber
Count.From 1 to 100.
Limited to test leadslimited_to_test_leadstrue/false
Limited to test leads.
Versioned lead gen form urnversioned_lead_gen_form_urntext
Versioned lead gen form urn.

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {
    "elements": []
  }
}

Send conversion

Send conversion.

Inputs

ConversionconversiontextRequired
Conversion.
Conversion happened atconversion_happened_atdate and timeRequired
Conversion happened at.
Event idevent_idtextRequired
Event id.
UseruserobjectRequired
User.
Conversion valueconversion_valueobject
Conversion value.

Outputs

dataobject
Linked In Lead Gen Forms and Conversion API response data.
Example output
{
  "data": {}
}

On this page