Skip to API content
TalkLabs API Docs v3
Recipes
POST Polls

Create Lead

This is for capturing leads.

POST /api/v3/{appid}/poll/poll/{pollid}/lead

This method requires authentication.

This is for capturing leads. It can capture name and email address. If the email address is already in use, the name fields will be overwritten.

  • pollid: (required) The id of the poll

  • firstname: (optional) The first name of the user responding

  • lastname: (optional) The last name of the user responding

  • email: (required) The email address of the user responding

Response Code Description
200 OK
400 Bad Request, not formatted correctly. See response for details
403 Forbidden, token doesn't have permission to do this operation
409 Conflict, request is formatted OK but violates a rule
Request

Parameters

Values in the path and query string.

appid path
string TalkLabs ID required

The TalkLabs application ID assigned to your account.

Example: your-app-id
pollid path
string TalkLabs ID required

The TalkLabs assigned poll ID.

Example: poll-id
Request

JSON body

Send as application/json.

pollId
string TalkLabs ID required

The TalkLabs assigned poll ID.

firstName
string
lastName
string
email
string
Request example
{
  "email": "potus@test.com",
  "pollId": "poll-id"
}
Response

Status codes

Every JSON response uses the API result envelope.

200 OK ApiResult
400 Bad Request ApiResult
403 Forbidden ApiResult
500 Internal Server Error ApiResult
Example response · 200
{
  "message": "Success",
  "errors": {},
  "data": {
    "kind": "poll.poll",
    "id": "662da20fe45ad80a7f2bd950",
    "appid": "662bb49bf10e9a26a7e8ed92",
    "ownerid": "u-8842",
    "title": "Sample Poll 1: Vote for your favorite color",
    "description": "Vote for your favorite color",
    "posterurl": "",
    "embedcontenttop": "",
    "embedcontentbotton": "",
    "whenpollpublish": "2024-04-28T01:10:39.5358368Z",
    "whenpollopens": "2024-04-27T21:10:39.5358872-04:00",
    "whenpollcloses": null,
    "whenpollexpires": null,
    "displayresults": 1,
    "sortanswers": 0,
    "customtype": "",
    "customid": "sample-poll-1-vote",
    "custompayload": "",
    "customtags": [],
    "customfield1": "",
    "customfield2": ""
  }
}
Search all 118 endpoints Try “join room”, “moderate”, or “POST”.
Request environment

Connect your application

These values fill request examples and the API console. They stay in this browser tab and are never sent to TalkLabs until you run a request.

Credentials are stored in sessionStorage, not in cookies or analytics.