Skip to main content
POST
Log an intro that already happened.

Authorizations

x-api-key
string
header
required

Body

application/json
direction
enum<string>
required

INBOUND: someone outside the firm introduced something to the firm. OUTBOUND: someone at the firm introduced something to someone outside.

Available options:
INBOUND,
OUTBOUND
introduced
IntroParty · object[]
required

What was introduced: 1-5 people, companies or opportunities (inbound: what was brought to the firm; outbound: what the firm put forward).

details
string | null

Free-text background: why or how the intro happened.

intro_date
string | null

Date the intro happened, YYYY-MM-DD. Defaults to today.

introduced_to
IntroParty · object[] | null

Who received the intro, 1-5 parties. Required for OUTBOUND (the outside recipients). Defaults to you for INBOUND.

introducer
IntroParty · object | null

Who made the intro. Required for INBOUND (the outside referrer). Defaults to you for OUTBOUND.

outcome
string | null

Outcome of the intro, as a label (case-insensitive, e.g. Meeting held) or an outcome UUID. Valid values come from GET /v1/intros/options. Omit while pending.

source_type
string | null

How the intro came about, as a label (e.g. Warm intro), Group / Label when a label repeats across groups, or a source type UUID. Valid values come from GET /v1/intros/options.

Response

IntroCreateResponse(uuid: str, direction: Literal['INBOUND', 'OUTBOUND'], intro_date: str, introducer: rcp_api.rest.schemas.intro.IntroPartyResponse | None, introduced: list[rcp_api.rest.schemas.intro.IntroPartyResponse], introduced_to: list[rcp_api.rest.schemas.intro.IntroPartyResponse], outcome: rcp_api.rest.schemas.intro.IntroOutcomeRef | None, source_type: rcp_api.rest.schemas.intro.IntroSourceTypeRef | None, source: Literal['MANUAL', 'EMAIL_EXTRACTION', 'MIGRATED'], details: str | None, details_hidden: bool, source_email_activity_object_id: str | None, confidence: float | None, created_by_user_uuid: str | None, created_at: str | None, updated_at: str | None, duplicate: bool = False)

confidence
number | null
required
created_at
string | null
required
created_by_user_uuid
string | null
required
details
string | null
required

Free-text background. null when details_hidden is true: the intro was found in an email you don't have access to.

details_hidden
boolean
required
direction
enum<string>
required
Available options:
INBOUND,
OUTBOUND
intro_date
string
required
introduced
IntroPartyResponse · object[]
required
introduced_to
IntroPartyResponse · object[]
required
introducer
IntroPartyResponse · object | null
required
outcome
IntroOutcomeRef · object | null
required

null while the outcome is pending.

source
enum<string>
required
Available options:
MANUAL,
EMAIL_EXTRACTION,
MIGRATED
source_email_activity_object_id
string | null
required

For intros found in email you can access: pass to /v1/activities/{activity_object_id}/body to read the email.

source_type
IntroSourceTypeRef · object | null
required
updated_at
string | null
required
uuid
string
required
duplicate
boolean
default:false

True when an intro with the same direction, date and parties already existed; that intro is returned and nothing new is created.