companies.sendMessage
Reply to a company-inbox conversation, AS THE PAGE.
Prerequisites
- A Curviate API key, passed as
apiKeywhen you construct the client. Authentication and accounts shows how to create one. - A connected LinkedIn account. This resource is account-scoped: the
account_idis injected automatically by the account-scoped accessor, so you pass it once tocurviate.account(...)and every call below inherits it. Authentication and accounts covers connecting one, and accounts.list returns theaccount_idof each account already connected.
Signature
sendMessage(identifier: string, chatId: string, body: CompanySendMessageBody): Promise<CompanySendMessageResult>Example
import { Curviate } from "@curviate/sdk";
const curviate = new Curviate({
apiKey: "cvt_live_...",
baseUrl: "https://api.curviate.com",
});
const acc = curviate.account("acc_YOUR_ACCOUNT_ID");
const { items: chats } = await acc.companies.chats("112013061");
const result = await acc.companies.sendMessage("112013061", chats[0]!.id, {
text: "Thanks for reaching out, happy to help!",
});
console.log(result.sent_as); // { kind: "company", company_id: "112013061", name: "RedHire" }Parameters
| Name | Type | Required | Description |
|---|---|---|---|
identifier | string | Yes | The company's numeric id (e.g. 112013061), the id field of GET /v1/{account_id}/companies/{identifier} or a POST /v1/{account_id}/search/companies result. A public handle or URN is not accepted here; pass the numeric id. |
chatId | string | Yes | The conversation id in the "2-..." form, the id field of a chats list or search result. Pass it verbatim. |
text | string | No | Message text (1-8000 chars). Optional when at least one attachment is supplied. |
quote_id | string | No | Optional message ID to quote or reply to. |
attachments | array | No | Optional file attachments (base64-encoded). |
Returns
Resolves to CompanySendMessageResult. Top-level fields: object, message_id, sent_as.
Error codes
| Code | What it means, and what to do |
|---|---|
UNAUTHORIZED | The API key is missing, malformed, or revoked. Check the key you passed to the client. |
INVALID_REQUEST | A parameter failed validation. The message names the offending field; fix the request rather than retrying it. |
RATE_LIMIT_ACCOUNT | This account's own quota is exhausted. Wait for the window in the Retry-After header, then retry. |
RATE_LIMIT_TENANT | The tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call. |
PLATFORM_RATE_LIMIT | LinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account. |
PLATFORM_ERROR | A transient upstream failure. Retry once with backoff before treating it as a real error. |
ACCOUNT_NOT_FOUND | No connected account with that id belongs to this tenant. List your accounts to get a current id. |
PAYLOAD_TOO_LARGE | The body exceeds the size cap. Base64 encoding inflates a file by about a third, so budget for that. |
RESOURCE_NOT_FOUND | The id in the path does not exist, or is not visible to this account. Re-read it from the list endpoint that produced it. |
TIER_NOT_ACTIVE | The seat does not have the add-on this endpoint needs. Enable it on the seat, then retry. |
UNSUPPORTED_MEDIA_TYPE | The request was not sent as JSON. Every endpoint takes application/json, including file attachments, which travel base64-encoded. |
Every code above is a stable CurviateError.code you can branch on. The full list, the response envelope, and retry semantics are in the Error codes reference.
Next steps
companies.searchChats: Search or filter a company page's admin inbox.companies.get: Retrieve a company's full LinkedIn profile.companies.chat: Retrieve one conversation from a company page's admin inbox.- SDK Quick Start: installation, the client, account scoping, and pagination.