Create New Member
Use Popl APIs to create a new member
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.
- Create Member: Create a new member and have the option to assign the member to a team or send an email invite
POST https://enterprise-api.poplme.co/v3/auth/signup/invite/public
{
"payload": [
{
"email": "{email_address}", //required
"jobTitle": "{job_title}",
"name": "{full_name}",
"bio": "{bio}",
"company": "{company_name}",
"subteam": "{subteam_id_to_add_member_to}",
"photo": "{link_to_photo}",
"location": "{location_or_address}",
"leadCaptureMode": "{1/0}",
"links": [
{"id": 9, "title": "Email", "icon": "", "value": "[email protected]", "updateExisting": true},
{"id": 31, "title": "Call", "icon": "", "value": "1234567890", "updateExisting": true}
]
}
],
"teamId": "{team_id_to_add_member_to}",
"shouldSendInvites": "{true/false}",
"apikey": "{your_api_key}"
}
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)
- The id of the specific link that is being used. Email link = 9, phone number (call) = 31, contact us for a full list of link ids
- title (string)
- The title that will be shown for this particular link
- icon (string)
- The icon link for the new piece of content
- value (string)
- The actual link content value. So for example, if this was an email link, the value would be [email protected]
- updateExisting (boolean)
- Whether this new link being added should replace an existing one if it exists, or create a new one either way. The default is
- teamId (string)
- The team id that the new member should be added to. If a team id is provided that does not exist, the member will not be added to any team.
- shouldSendInvites (boolean)
- Should the API also send this new member an email invite to claim their new digital business card. The default is false.
Last modified 3mo ago