Lead Sync

Number of APIs: 13

This collection aims to focus on different lead syncing use cases and should be used with the lead-sync-env-versioning environment.

All requests for the Lead Sync collection are in the Restli 2.0 format and uses OAuth 2.0

  1. Use Cases-Sponsored - 2. Get the user's sponsored accounts (ad accounts) GET {{baseUrl}}/adAccounts?q=search&search=(status:(values:List(ACTIVE)),test:false)&fields=id,name,test,referenceInfo&count=10&start=0

  2. Use Cases-Sponsored - 4. Validate the user's organization role GET {{baseUrl}}/organizationAcls?q=roleAssignee&state=APPROVED

  3. Use Cases-Organic - 3. Get the user's organization(s) (company pages) GET {{baseUrl}}/organizationAcls?q=roleAssignee&state=APPROVED&count=10&start=0

  4. Use Cases-Organic - 5. Get forms for the user's Organization GET {{baseUrl}}/leadForms?owner=(organization:urn%3Ali%3Aorganization%3A{{organization_id}})&q=owner&count=10&start=0

  5. Use Cases-Organic - 8. [PULL] Schedule periodic form response (lead) pulls GET {{baseUrl}}/leadFormResponses?q=owner&owner=(organization:urn%3Ali%3Aorganization%3A{{organization_id}})&leadType=(leadType:{{leadtype_organic}})&limitedToTestLeads=false&submittedAtTimeRange=(start:{{timerange_start}},end:{{timerange_end}})&fields=ownerInfo,associatedEntityInfo,leadMetadataInfo,leadType,versionedLeadGenFormUrn,id,submittedAt,testLead,formResponse,form:(hiddenFields,creationLocale,name,id,content)&count=10&start=0

  6. Use Cases-Organic - 8. [PUSH] Subscribe for lead notification webhooks POST {{baseUrl}}/leadNotifications

  7. Use Cases-Organic - 9. [PUSH] Fetch full lead data after a lead notification is received GET {{baseUrl}}/leadFormResponses/{{lead_id}}?&fields=ownerInfo,associatedEntityInfo,leadMetadataInfo,leadType,versionedLeadGenFormUrn,id,submittedAt,testLead,formResponse,form:(hiddenFields,creationLocale,name,id,content)

  8. Use Cases-Organic - [PUSH] Delete a registered webhook by id DELETE {{baseUrl}}/leadnotifications/<webhook id>

  9. Use Cases-Sponsored - 8. [PULL] Schedule periodic form response (lead) pulls GET {{baseUrl}}/leadFormResponses?q=owner&owner=(sponsoredAccount:urn%3Ali%3AsponsoredAccount%3A{{sponsoredaccount_id}})&leadType=(leadType:{{leadtype_sponsored}})&limitedToTestLeads=false&submittedAtTimeRange=(start:{{timerange_start}},end:{{timerange_end}})&fields=ownerInfo,associatedEntityInfo,leadMetadataInfo,owner,leadType,versionedLeadGenFormUrn,id,submittedAt,testLead,formResponse,form:(hiddenFields,creationLocale,name,id,content)&count=10&start=0

  10. Use Cases-Sponsored - 8. [PUSH] Subscribe for lead notification webhooks POST {{baseUrl}}/leadNotifications