Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Body

application/json
lead_list_id
string
required

A lead list's id: the id from List or read lead collections (type list).

Maximum string length: 128
auto_enrich
boolean | null

With place_ids: enrich the imported places right away. On by default.

company
string | null

Company returned by the Sendora API.

Maximum string length: 255
custom_fields
Custom Fields · object | null

Up to 50 custom scalar fields; keys are limited to 64 characters and string values to 2,000 characters.

email
string | null

Email returned by the Sendora API.

Maximum string length: 255
first_name
string | null

First name returned by the Sendora API.

Maximum string length: 100
idempotency_key
string | null

Idempotency key returned by the Sendora API.

Maximum string length: 128
import_all
boolean
default:false

With search_id from a people search: import every match as a background job. Send an idempotency_key. Follow it with GET /jobs?id=.

import_count
integer | null

With search_id from a people search: import the first N matches as a background job. Send an idempotency_key. Follow it with GET /jobs?id=.

Required range: 1 <= x <= 500000
import_params
Import Params · object | null

Import params returned by the Sendora API.

last_name
string | null

Last name returned by the Sendora API.

Maximum string length: 100
linkedin_url
string | null

Linkedin url returned by the Sendora API.

Maximum string length: 500
lookup_email
boolean
default:false

With prospect_keys, import_all or import_count: find work emails (costs credits, stops at the daily lookup limit).

lookup_phone
boolean
default:false

With prospect_keys, import_all or import_count: find mobile numbers (costs credits, stops at the daily lookup limit).

notes
string | null

Notes returned by the Sendora API.

Maximum string length: 10000
phone_number
string | null

Phone number returned by the Sendora API.

Maximum string length: 50
pipeline_stage
string | null

Pipeline stage returned by the Sendora API.

Maximum string length: 50
place_ids
string[] | null

The places to import: id values from the results of the preview.

prospect_keys
string[] | null

With search_id: the people to import. More than 100 runs as a background job.

rows
Rows · object[] | null

Import many leads at once instead of one. Large imports return a job to follow.

Maximum array length: 10000
search_id
string | null

The search whose chosen results to import: the id from Run a prospect search.

source_kind
string | null

With rows: csv, json_paste or another import kind. Defaults to json_paste.

title
string | null

Title returned by the Sendora API.

Maximum string length: 255

Response

Successful Response

created_at
string<date-time>
required

Created at returned by the Sendora API.

id
string
required

The lead's id. Pass it to any endpoint that takes lead_id.

status
enum<string>
required

Status returned by the Sendora API.

Available options:
active,
unsubscribed,
dnc,
bounced
automation_paused
boolean
default:false

Automation paused returned by the Sendora API.

avatar_url
string | null

Avatar url returned by the Sendora API.

city
string | null

City returned by the Sendora API.

company
string | null

Company returned by the Sendora API.

company_domain
string | null

Company domain returned by the Sendora API.

company_profile
Company Profile · object | null

Company profile returned by the Sendora API.

country
string | null

Country returned by the Sendora API.

current_campaign_id
string | null

The campaign this lead is currently enrolled in: an id from List or get campaigns.

custom_fields
Custom Fields · object | null

Custom fields returned by the Sendora API.

email
string | null

Email returned by the Sendora API.

email_verification_score
integer | null

Email verification score returned by the Sendora API.

email_verification_status
string | null

Email verification status returned by the Sendora API.

email_verified_at
string<date-time> | null

Email verified at returned by the Sendora API.

enrich_signals
Enrich Signals · object | null

Enrich signals returned by the Sendora API.

first_name
string | null

First name returned by the Sendora API.

industry
string | null

Industry returned by the Sendora API.

last_activity_at
string<date-time> | null

Last activity at returned by the Sendora API.

last_name
string | null

Last name returned by the Sendora API.

lead_list_id
string | null

A lead list's id: the id from List or read lead collections (type list).

linkedin_url
string | null

Linkedin url returned by the Sendora API.

notes
string | null

Notes returned by the Sendora API.

phone_number
string | null

Phone number returned by the Sendora API.

pipeline_stage
string | null

Pipeline stage returned by the Sendora API.

source
string | null

Source returned by the Sendora API.

title
string | null

Title returned by the Sendora API.

traffic_light_status
enum<string> | null

Traffic light status returned by the Sendora API.

Available options:
GREEN,
YELLOW,
RED
website
string | null

Website returned by the Sendora API.