Popl

App · 13 actions

Search captured leads, manage member business cards and lead tags, and read team analytics.

Actions

ActionWhat it does
Add lead tagsAdd lead tags.
Bulk update template linkBulk update template link.
Delete leadDelete lead.
Get analyticsGet analytics.
Get leadGet lead.
Invite membersInvite members.
List membersList members.
List tagsList tags.
Remove lead tagsRemove lead tags.
Remove membersRemove members.
Search leadsSearch leads.
Update member cardUpdate member card.
Update template linkUpdate template link.

Add lead tags

Add lead tags.

Inputs

Legacy lead idlegacy_lead_idtextRequired
Legacy lead id.
Membermember_idnumberRequired
Member id.
Tag idstag_idslistRequired
Tag ids.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

Bulk update template link.

Inputs

Wildcard idwildcard_idtextRequired
Wildcard id.
Members and valuesmembers_and_valueslistRequired
Members and values.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "result": []
    },
    "message": "example"
  }
}

Delete lead

Delete lead.

Inputs

Membermember_idnumberRequired
Member id.
Legacy lead idlegacy_lead_idtextRequired
Legacy lead id.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

Get analytics

Get analytics.

Inputs

Startstartdate and timeRequired
Start.
Endenddate and time
End.

Outputs

datalist
Result.
Example output
{
  "data": []
}

Get lead

Get lead.

Inputs

Lead idlead_idtextRequired
Lead id.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "assignedMembers": [],
      "leadId": "example",
      "legacyLeadId": "example",
      "systemFields": {
        "captureDatetime": "example",
        "email": "example",
        "firstName": "example",
        "lastName": "example",
        "userPid": 1
      },
      "tags": []
    }
  }
}

Invite members

Invite members.

Inputs

MembersmemberslistRequired
Members.
Send invitationssend_invitationstrue/false
Send invitations.
Team IDpopl_team_idnumber
Team ID.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

List members

List members.

Inputs

None.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "teamMembers": []
    },
    "message": "example"
  }
}

List tags

List tags.

Inputs

None.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": []
  }
}

Remove lead tags

Remove lead tags.

Inputs

Legacy lead idlegacy_lead_idtextRequired
Legacy lead id.
Membermember_idnumberRequired
Member id.
Tag idstag_idslistRequired
Tag ids.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

Remove members

Remove members.

Inputs

Member idsmember_idslistRequired
Member ids.
Remove accessoriesremove_accessoriestrue/false
Remove accessories.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

Search leads

Search leads.

Inputs

Team IDpopl_team_idnumber
Team ID.
Member idsmember_idslist
Member ids.
Subteam idssubteam_idslist
Subteam ids.
Start timestart_timedate and time
Start time.
End timeend_timedate and time
End time.
Tag idstag_idslist
Tag ids.
Campaign idscampaign_idslist
Campaign ids.
Lead sourceslead_sourceslist
Lead sources.
Exportedexportedtrue/false
Exported.
Has emailhas_emailtrue/false
Has email.
Lead entrieslead_entriestext
Lead-entry grouping accepted by Popl, such as single.
Queryquerylist
Query.
Sort directionsort_directiontext
Sort direction.One of: ASC, DESC.
Cursorcursortext
Cursor.
Include default leadsinclude_default_leadstrue/false
Include default leads.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "cursor": "example",
      "leads": []
    }
  }
}

Update member card

Update member card.

Inputs

Card idcard_idtextRequired
Card id.
Namenametext
Name.
Job titlejobTitletext
Job title.
Companycompanytext
Company.
Descriptiondescriptiontext
Description.
Locationlocationtext
Location.
Pronounspronounstext
Pronouns.
Photophototext
Photo.
Logologotext
Logo.
Bannerbannertext
Banner.
Privateprivatenumber
Private.One of: 0, 1.
Directdirectnumber
Direct.One of: 0, 1.
Lead capture modeleadCaptureModenumber
Lead capture mode.One of: 0, 1.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "response": {
        "data": {
          "id": 1,
          "name": "example"
        },
        "message": "example"
      }
    },
    "message": "example"
  }
}

Update template link.

Inputs

Membermember_idnumberRequired
Member id.
Wildcard idwildcard_idtextRequired
Wildcard id.
ValuevaluetextRequired
Value.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "wasAnyCardUpdated": false
    },
    "message": "example"
  }
}

On this page