recruiter.startChat

Requires the Recruiter add-on. Calls return TIER_NOT_ACTIVE (403) when the seat does not have this add-on active.

Start a Recruiter chat (InMail).

Signature

startChat(body: RecruiterStartChatBody): Promise<RecruiterStartChatResult>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_…",
  baseUrl: "https://api.curviate.com",
});
 
const result = await curviate.account("acc_YOUR_ACCOUNT_ID").recruiter.startChat({ attendees_ids: ["YOUR_PROFILE_ID"], text: "Hi — saw your recent post and wanted to connect.", subject: "Quick question", signature: "…" });
console.log(`StartChat: ${result.chat_id}`);

Parameters

Name	Type	Required	Description
`attendees_ids`	`array`	Yes	One or more Recruiter member IDs (AE… format) to include in the chat.
`text`	`string`	Yes	Opening message text (1–8000 chars). Passed to the platform and discarded — never stored or logged.
`subject`	`string`	Yes	Subject line — REQUIRED for Recruiter (InMail-based messaging), unlike the classic surface (≤ 200 chars).
`signature`	`string`	Yes	Sender signature — REQUIRED for Recruiter. Not stored or logged.
`visibility`	`string`	No	Visibility of the recruiter chat.
`intent`	`string`	No	Whether this outreach is on behalf of a client or the operator's own company.
`send_as`	`string`	No	Send the opening message as an InMail or as email.
`channel_type`	`string`	No	Sourcing channel for tracking purposes (e.g. CAREER_SITE, MANUAL_IMPORT, INTERNAL_CANDIDATES, RECRUITER_SEARCH, REFERRAL — the vendor's own vocabulary is broader than this illustrative set, so any non-empty value is accepted rather than a closed enum).
`follow_up`	`object`	No	Recruiter PRO only: schedule a follow-up message. subject/text are not stored or logged.
`attachments`	`Array<Buffer \| File>`	No	File field — sent as multipart/form-data.

Returns

Resolves to RecruiterStartChatResult. Top-level fields: object, chat_id, message_id.

Error codes

UNAUTHORIZED
INVALID_REQUEST
RATE_LIMIT_ACCOUNT
RATE_LIMIT_TENANT
PLATFORM_RATE_LIMIT
PLATFORM_ERROR
ACCOUNT_NOT_FOUND
ACCOUNT_RESTRICTED
LINKEDIN_AUTH_FAILED
LINKEDIN_FEATURE_NOT_SUBSCRIBED
PAYLOAD_TOO_LARGE
RESOURCE_NOT_FOUND
TIER_NOT_ACTIVE
UNSUPPORTED_MEDIA_TYPE

All error codes link to Error codes reference.

Notes

Note: The account_id is injected automatically by the account-scoped accessor. Call as curviate.account("acc_YOUR_ACCOUNT_ID").recruiter.startChat(...).

Data	Why
Account identity (name, email, sign-in method)	Create and secure your account
Your LinkedIn credentials	Operate the actions you request
LinkedIn content returned by an API call	Fulfil that specific request, nothing more
API keys and connector (OAuth) authorizations	Authenticate your API, CLI, MCP, or SDK requests
Billing details	Charge you correctly and meet our tax obligations
Usage and security logs	Keep the service reliable and abuse-free
Support messages	Respond to you
Website analytics, only if you opt in	Understand how the site is used

Data	Retention
Account and workspace data	While your account is active
Closed account	Recoverable for 7 days, then deleted on day 8
LinkedIn credentials	Until you disconnect that account
LinkedIn content	Not stored; any transient cache clears within 1 hour, never indexed, never used for training
API keys	Until you revoke or rotate them
Connector (OAuth) authorizations	Access token ~1 hour; refresh token up to ~12 months, or until you revoke it, whichever comes first
Billing records	As required by German tax law, currently up to 10 years
Logs	A short operational window; metadata only, never message content

Name	Purpose	Expiry
`cc_cookie`	Remembers your cookie choice	12 months
`curviate-theme`	Remembers light/dark mode (local storage, not a cookie)	Persistent
`sb-*-auth-token`	Keeps you signed in	While active; cleared on sign-out

Name	Purpose	Expiry
`_ga`	Google Analytics: distinguishes visitors	2 years
`_gid`	Google Analytics: distinguishes visitors	24 hours
`_ga_<container id>`	Google Analytics: persists session state	2 years