Skip to main content
PATCH
Update a source contact

Authorizations

Authorization
string
header
required

Personal API key created in the dashboard under Settings > API keys.

Path Parameters

source_id
integer
required

Query Parameters

website_id
integer
required

Target website id

Body

application/json
full_name
string | null
Maximum string length: 120
role_title
string | null
Maximum string length: 160
email
string | null
Maximum string length: 254
linkedin_url
string | null
Maximum string length: 500
use_alternate
boolean
default:false
alternate_contact_id
integer | null

Response

Successful Response

id
integer
required
domain
string
required
status
enum<string>
required
Available options:
eligible,
rejected,
contact_pending,
contact_unresolved,
draft_ready,
awaiting_approval,
contacted,
replied,
needs_human,
in_discussion,
no_reply,
declined,
placed,
stopped,
blacklisted,
snoozed
status_set_by
enum<string>
required
Available options:
agent,
user
status_updated_at
string<date-time> | null
priority
number
default:0
priority_factors
OutreachPriorityFactor · object[]
language
string | null
blocked_reason
Available options:
own_domain,
competitor,
suggested_competitor,
major_platform,
directory,
already_mentioned,
not_actionable,
blacklisted,
recently_contacted,
no_usable_url,
outside_si_window,
not_relevant,
page_gone,
refused_in_workspace,
rival_vendor,
below_citation_floor,
listed_nothing_to_correct,
listed_only_generic_asks,
page_unreachable,
draft_breaks_rules,
not_selected_by_triage,
page_blocked,
page_no_text,
test_based_no_offer,
review_aggregator,
head_to_head_comparison,
single_product_review,
language_unsupported,
category_mismatch,
market_mismatch,
follow_up_limit,
no_answerable_criterion,
stale_page,
vendor_page,
sponsored_page,
agent_not_fit
snooze_until
string<date> | null
next_resolution_at
string<date-time> | null
owner_user_id
integer | null
owner_name
string | null
first_contacted_at
string<date-time> | null
last_activity_at
string<date-time> | null
followup_count
integer
default:0
needs_decision
boolean
default:false
close
Close · object | null
deal_terms
Deal Terms · object | null
exchange
Exchange · object | null
decision
Decision · object | null
follow_up_blocked
string | null
primary_url
string | null
primary_title
string | null
url_count
integer
default:0
citation_count
integer
default:0
platforms
string[]
contact
OutreachContactResponse · object | null
prior_contact_at
string<date-time> | null
prior_contact_email
string | null
prior_contact_replied
boolean
default:false
stage
enum<string>
default:hikoo_working
Available options:
needs_you,
hikoo_working,
waiting,
closed
outcome
enum<string> | null
Available options:
won,
lost,
disqualified
stage_detail
enum<string>
default:qualifying
Available options:
hot_reply_money,
hot_reply,
delivery_refused,
taken_by_you,
approve_pitch,
approve_reply,
approve_follow_up,
decision,
qualifying,
finding_person,
writing_pitch,
waiting_to_search,
waiting_to_write,
contact_quota_reached,
waiting_reply,
follow_up_due,
followed_up,
waiting_to_connect,
in_discussion,
snoozed,
awaiting_publication,
with_you_until,
paused_until,
queued_to_send,
no_person_yet,
no_person_last_look,
mention_online,
they_declined,
lost_paid_only,
do_not_contact,
no_reply,
you_stopped,
disqualified
stage_detail_params
Stage Detail Params · object
waiting_days
integer | null
next_follow_up_at
string<date-time> | null
closed_reason
string | null
with_you_until
string<date> | null
paused_until
string<date> | null
next_step
OutreachNextStep · object | null
close_reason
OutreachCloseReason · object | null
agent
OutreachAgentPlanResponse · object | null
urls
OutreachSourceUrlResponse · object[]
contacts
OutreachContactResponse · object[]
messages
OutreachMessageResponse · object[]
timeline
OutreachTouchResponse · object[]
placements
OutreachPlacementResponse · object[]
measurement_baseline
Measurement Baseline · object | null
placement_watch_until
string<date-time> | null
prior_contact_thread_id
string | null
prior_contact_scanned_at
string<date-time> | null
agent_drafting
boolean
default:false
draft_failed
boolean
default:false
negotiation_ceiling
string | null
negotiation_currency
string | null
negotiation_note
string | null
negotiation_set_at
string<date-time> | null
negotiation_offers
integer
default:0
follow_up_plan
OutreachFollowUpPlanResponse · object | null
handed_from_email
string | null
handed_from
string | null
must_continue
boolean
default:false
contact_research_allowed
boolean
default:false
first_mail_rewrite_allowed
boolean
default:false
first_mail_rewrite_pending
boolean
default:false
first_mail_outdated
boolean
default:false