Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Jobs
  5. Linkedin Conversion Api

Linkedin Conversion Api

markdownView as Markdown

Create and manage data import and export jobs.

LinkedinConversionApi: Create job

POSThttps://api.lytics.io/v2/job/linkedin-conversion-api

Create a LinkedinConversionApi job

Sample Request
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "ad_account_id": 0,
    "attribution_type": "string",
    "audience_events": "enters_only",
    "campaign_ids": [
      0
    ],
    "conversion_currency_code": "string",
    "conversion_currency_value": "string",
    "conversion_type": "string",
    "event_id": "string",
    "event_time": "string",
    "existing_conversion_rules": 0,
    "id_fields_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "lead_form_id": "string",
    "post_click_attribution_window_size": 0,
    "rule_association_type": "ALL_CAMPAIGNS",
    "rule_name": "string",
    "segment_ids": [
      "string"
    ],
    "user_data_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "view_through_attribution_window_size": 0,
    "withbackfill": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|201 Created
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "ad_account_id": 0,
      "attribution_type": "string",
      "audience_events": "enters_only",
      "campaign_ids": [
        0
      ],
      "conversion_currency_code": "string",
      "conversion_currency_value": "string",
      "conversion_type": "string",
      "event_id": "string",
      "event_time": "string",
      "existing_conversion_rules": 0,
      "id_fields_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "lead_form_id": "string",
      "post_click_attribution_window_size": 0,
      "rule_association_type": "ALL_CAMPAIGNS",
      "rule_name": "string",
      "segment_ids": [
        "string"
      ],
      "user_data_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "view_through_attribution_window_size": 0,
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

LinkedinConversionApi: Get job

GEThttps://api.lytics.io/v2/job/linkedin-conversion-api/{id}

Get the summary of a LinkedinConversionApi job

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "ad_account_id": 0,
      "attribution_type": "string",
      "audience_events": "enters_only",
      "campaign_ids": [
        0
      ],
      "conversion_currency_code": "string",
      "conversion_currency_value": "string",
      "conversion_type": "string",
      "event_id": "string",
      "event_time": "string",
      "existing_conversion_rules": 0,
      "id_fields_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "lead_form_id": "string",
      "post_click_attribution_window_size": 0,
      "rule_association_type": "ALL_CAMPAIGNS",
      "rule_name": "string",
      "segment_ids": [
        "string"
      ],
      "user_data_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "view_through_attribution_window_size": 0,
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

LinkedinConversionApi: Update job

PUThttps://api.lytics.io/v2/job/linkedin-conversion-api/{id}

Update a LinkedinConversionApi job

Sample Request
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "ad_account_id": 0,
    "attribution_type": "string",
    "audience_events": "enters_only",
    "campaign_ids": [
      0
    ],
    "conversion_currency_code": "string",
    "conversion_currency_value": "string",
    "conversion_type": "string",
    "event_id": "string",
    "event_time": "string",
    "existing_conversion_rules": 0,
    "id_fields_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "lead_form_id": "string",
    "post_click_attribution_window_size": 0,
    "rule_association_type": "ALL_CAMPAIGNS",
    "rule_name": "string",
    "segment_ids": [
      "string"
    ],
    "user_data_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "view_through_attribution_window_size": 0,
    "withbackfill": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "ad_account_id": 0,
      "attribution_type": "string",
      "audience_events": "enters_only",
      "campaign_ids": [
        0
      ],
      "conversion_currency_code": "string",
      "conversion_currency_value": "string",
      "conversion_type": "string",
      "event_id": "string",
      "event_time": "string",
      "existing_conversion_rules": 0,
      "id_fields_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "lead_form_id": "string",
      "post_click_attribution_window_size": 0,
      "rule_association_type": "ALL_CAMPAIGNS",
      "rule_name": "string",
      "segment_ids": [
        "string"
      ],
      "user_data_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "view_through_attribution_window_size": 0,
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.ad_account_idoptionalinteger

Select LinkedIn Ads Account

config.attribution_typeoptionalstring
config.audience_eventsoptionalstring

Select which type of audience trigger events to send webhooks

One of: enters_only, exits_only

config.campaign_idsoptionalinteger[]

Select the campaigns to associate the new conversion rule. If no campaigns are provided, select the rule association type to define how the campaigns are associated with the conversion rule.

config.conversion_currency_codeoptionalstring

Select the currency code for the conversion value

config.conversion_currency_valueoptionalstring

Select the Lytics field that has the conversion value

config.conversion_typeoptionalstring
config.event_idoptionalstring
config.event_timeoptionalstring
config.existing_conversion_rulesoptionalinteger
config.id_fields_mappingrequiredobject[]

Map the value from Lytics field to LinkedIn's Identifier field. At least one identifier must be mapped

config.lead_form_idoptionalstring

Select the Lytics user profile field that contains the LinkedIn leadGenFormResponse ID

config.post_click_attribution_window_sizeoptionalinteger
config.rule_association_typeoptionalstring

Select conversion rule association type. When no campaigns are provided, this defines how the campaigns are associated with the conversion rule. By default, it is set to ALL_CAMPAIGNS.

One of: ALL_CAMPAIGNS, OBJECTIVE_BASED

config.rule_nameoptionalstring
config.segment_idsoptionalstring[]

Select the audience to export to LinkedIn

config.user_data_mappingoptionalobject[]
config.view_through_attribution_window_sizeoptionalinteger
config.withbackfilloptionalboolean
descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.ad_account_idoptionalinteger

Select LinkedIn Ads Account

config.attribution_typeoptionalstring
config.audience_eventsoptionalstring

Select which type of audience trigger events to send webhooks

One of: enters_only, exits_only

config.campaign_idsoptionalinteger[]

Select the campaigns to associate the new conversion rule. If no campaigns are provided, select the rule association type to define how the campaigns are associated with the conversion rule.

config.conversion_currency_codeoptionalstring

Select the currency code for the conversion value

config.conversion_currency_valueoptionalstring

Select the Lytics field that has the conversion value

config.conversion_typeoptionalstring
config.event_idoptionalstring
config.event_timeoptionalstring
config.existing_conversion_rulesoptionalinteger
config.id_fields_mappingrequiredobject[]

Map the value from Lytics field to LinkedIn's Identifier field. At least one identifier must be mapped

config.lead_form_idoptionalstring

Select the Lytics user profile field that contains the LinkedIn leadGenFormResponse ID

config.post_click_attribution_window_sizeoptionalinteger
config.rule_association_typeoptionalstring

Select conversion rule association type. When no campaigns are provided, this defines how the campaigns are associated with the conversion rule. By default, it is set to ALL_CAMPAIGNS.

One of: ALL_CAMPAIGNS, OBJECTIVE_BASED

config.rule_nameoptionalstring
config.segment_idsoptionalstring[]

Select the audience to export to LinkedIn

config.user_data_mappingoptionalobject[]
config.view_through_attribution_window_sizeoptionalinteger
config.withbackfilloptionalboolean
descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring