API docs by Redocly

Leads API (1.10.2)

Download OpenAPI specification:Download

Responsible for managing leads.

Leads

Create a lead

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Example: application\json
Request Body schema: application/json
required
email
required
string
name
string
surname
string
address1
string
address2
string
city
string
state
string
postalCode
string
phone
string
isMobilePhone
boolean or null
birthdate
string or null
gender
string
carryFrequency
string
preferredContact
string
tID
string
giveawayCampaignId
string
giveawayEntryOnly
boolean

Required with giveawayCampaignId

required
object
object

Responses

Request samples

Content type
application/json
{
  • "email": "none@uscca.com",
  • "name": "Jane",
  • "surname": "Doe",
  • "address1": "123 Main St",
  • "address2": "string",
  • "city": "West Bend",
  • "state": "Wisconsin",
  • "postalCode": "53095",
  • "phone": "111-222-3333",
  • "isMobilePhone": true,
  • "birthdate": "1970-01-01",
  • "gender": "female",
  • "carryFrequency": "string",
  • "preferredContact": "string",
  • "tID": "abcdef1e1f14g1",
  • "giveawayCampaignId": "11e1f111-1af2-11ec-bef6-12421a1111aa",
  • "giveawayEntryOnly": true,
  • "tracking": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}