API Reference/Endpoints

Start a new chat

POST/api/linkedin/gateway/chats

Opens a conversation with one or more attendees, optionally sending the opening message in the same call.

Authentication

Send your personal API key as a bearer token. A missing, malformed or revoked key returns 401.

Body parameters

FieldTypeDescription

account_id *stringThe account starting the chat. Must belong to this key.

attendees_ids *string[]Provider ids of the recipients — at least one.

textstringThe opening message. A handful of basic HTML tags (<strong>, <em>, <a>, <ul>/<li>) are honored for LinkedIn.

subjectstringA subject line, for the channels that support one.

Response fields

FieldTypeDescription

chat_idstring | nullThe new chat's id, once created.

message_idstring | nullThe opening message's id, if text was sent.

Warmably's gateway only forwards JSON request bodies, so attachments, voice_message and video_message — all binary uploads on this endpoint upstream — aren't usable here yet. Send text only.

Errors

·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. account_id doesn't belong to this key.·422 Unprocessable Entity. The recipient can't currently be messaged (not connected, or outside messaging permissions).