Skip to main content
PATCH
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

Path Parameters

lead_id
string
required

The lead's id: the id from List or get leads. It is also the last part of that page's address in the app.

Body

application/json
add_tags
string[] | null

Add tags returned by the Sendora API.

Maximum array length: 50
company
string | null

Company returned by the Sendora API.

Maximum string length: 255
context
LeadContextUpdate · object | null

Turn the AI reply or outreach on or off for this lead on one channel: {ai_state, outreach_state}.

custom_fields
Custom Fields · object | null

Full replacement for the lead's custom_fields object. Send an empty object to clear it.

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
last_name
string | null

Last name returned by the Sendora API.

Maximum string length: 100
lead_list_id
string | null

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

Maximum string length: 128
linkedin_url
string | null

Linkedin url returned by the Sendora API.

Maximum string length: 500
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
remove_tags
string[] | null

Remove tags returned by the Sendora API.

Maximum array length: 50
status
enum<string> | null

Status returned by the Sendora API.

Available options:
active,
unsubscribed,
dnc,
bounced
title
string | null

Title returned by the Sendora API.

Maximum string length: 255
traffic_light
string | null

Conversation signal for this lead: green, yellow, red or unknown, in any case.

traffic_light_status
enum<string> | null

Traffic light status returned by the Sendora API.

Available options:
GREEN,
YELLOW,
RED

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
activities
Activities · object[] | null

Newest first. Present with include=activities.

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.

tags
string[]

The lead's tags.

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.