Popl Documentation
  • Popl Documentation
  • Integrations
    • Syncing Members from Azure Active Directory (Entra ID)
      • Entra ID (Azure) - Auto Sync™
      • Entra ID (Azure) - Permissions
    • Syncing Members from Google Workspace
      • Google Workspace - Auto Sync™
      • Google Workspace - Permissions
    • Syncing Members from Workday
      • Workday - Auto Sync™
      • Workday - Permissions
    • Salesforce Integration
      • Salesforce - Lead/Contact Sync Logic
    • HubSpot Integration
    • HubSpot Integration (Legacy)
      • HubSpot - Contact Sync Logic (Legacy)
    • Dynamics 365 Sales Integration
    • Outlook Contact Sync - Full Team Integration
    • Outlook Contact Sync - Individual Member Integration
    • Zoho Integration
    • Monday Integration
    • Pipedrive Integration
    • Pardot Integration
    • Chili Piper Integration
    • Zapier Integration
    • VinSolutions Integration
    • Marketo Integration
    • Badge Kit Integration
  • SSO (SAML 2.0)
    • Azure SAML
    • Okta SAML
    • SCIM Provisioning
  • Email Signatures
    • Microsoft Outlook Email Signature Add-In
  • Members
    • Create New Member
    • Update Member
    • Update Template Links
    • Get Members
    • Remove Member
  • Leads/Contacts
    • Get Last Lead
    • Get Leads by Time Period
    • Delete Lead
  • Analytics
    • Get Analytics
    • Get Views
Powered by GitBook
On this page
  1. Members

Create New Member

Use Popl APIs to create a new member

PreviousMicrosoft Outlook Email Signature Add-InNextUpdate Member

Last updated 7 months ago

This API will create a new Popl account by email. If an account with a particular email already exists, this API will update that account instead of creating.

Don't forget to before calling this API.

  • Create Member: Create a new member and have the option to assign the member to a team or send an email invite

POST https://api.popl.co/api/pub/members/inviteMember

{
  "shouldSendInvites": true, // OPTIONAL: defaults to true
  "payload": [
    {
      "email": "example@example.com", // REQUIRED
      "jobTitle": "Software Engineer",
      "name": "John Doe",
      "bio": "Experienced software engineer.",
      "company": "Tech Corp",
      "photo": "http://example.com/photo.jpg",
      "location": "New York",
      "subteam": "Development",
      "subteamIds": [1, 2],
      "importType": "manual",
      "isPro": 1,
      "leadCaptureMode": 0,
      "links": [
        {
          "id": 123,
          "title": "LinkedIn",
          "value": "http://linkedin.com/in/johndoe",
          "icon": "linkedin",
          "updateExisting": true,
          "desc": "John's LinkedIn profile",
          "help_title": "LinkedIn Profile"
        }
      ],
      "msID": "MS123456",
      "department": "Engineering"
    }
  ],
  "teamId": 10
}

The parameters shown above are optional except "email" which is the only required parameter to create a new member. See descriptions for each parameter below:

  • email (string) required

    • The login email for the new member

  • jobTitle (string)

    • The job title for the new member

  • name (string)

    • The name for the new member

  • bio (string)

    • The bio for the new member

  • company (string)

    • The company name for the new member

  • subteam (string)

    • The subteam id that the new member should be added to.

  • photo (array)

    • The profile photo link for the new member.

    • This can be any link that is publicly accessible

  • location (string)

    • The location/address for the new member

  • leadCaptureMode (string)

    • This parameter will set lead capture mode on or off for the new member

    • This value must be either "0" or "1", default is "0" (disabled)

  • links (array)

    • This parameter will create links that appear on the member's digital card.

    • Links can be any piece of content that Popl has available ranging from phone numbers, emails, websites, embedded videos and more.

    • Link Parameters:

      • id (integer)

      • title (string)

        • The title that will be shown for this particular link. This value is optional and will use the default title if not provided.

      • icon (string)

        • The icon link for the new piece of content. This value is optional and will use the default icon if not provided.

      • value (string)

        • The actual link content value. So for example, if this was an email link, the value would be "john@swift.com"

      • updateExisting (boolean)

        • Whether this new link being added should replace an existing one if it exists, or create a new one. The default is to create a new link, even if one with the same value already exists.

  • templateId (integer)

    • The id of the template that should be applied to the new member. If a template id is provided that does not exist, a template will not be added to the member. This value is optional.

  • shouldSendInvites (boolean)

    • Should the API send this new member an email invite to claim their new digital business card. The default is true.

With 🤍 from Popl.

The id of the specific link that is being used. Email link = 9, phone number (call) = 31, text message = 8, LinkedIn = 7,

Check out to instantly create high-converting digital business cards for your team.

If any issues or questions, please contact us at , we are available nearly 24/7 and will get back to you within 6-8 hours or less.

contact us for a full list of link ids
Popl Teams
teams@popl.co
authenticate