Start group conversation
curl --request POST \
--url https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"linkedin_account_sid": "<string>",
"attendees": [
{
"ln_id": "<string>",
"sn_id": "<string>"
}
],
"text": "<string>",
"conversation_title": "<string>",
"attachments": [
{
"file_base64": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"file_type": "<string>",
"file_byte_size": 2
}
],
"client_reference": "<string>",
"confirmed_not_sent": "<string>",
"confirmed_sent": "<string>"
}
'import requests
url = "https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group"
payload = {
"linkedin_account_sid": "<string>",
"attendees": [
{
"ln_id": "<string>",
"sn_id": "<string>"
}
],
"text": "<string>",
"conversation_title": "<string>",
"attachments": [
{
"file_base64": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"file_type": "<string>",
"file_byte_size": 2
}
],
"client_reference": "<string>",
"confirmed_not_sent": "<string>",
"confirmed_sent": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
linkedin_account_sid: '<string>',
attendees: [{ln_id: '<string>', sn_id: '<string>'}],
text: '<string>',
conversation_title: '<string>',
attachments: [
{
file_base64: '<string>',
file_url: '<string>',
file_name: '<string>',
file_type: '<string>',
file_byte_size: 2
}
],
client_reference: '<string>',
confirmed_not_sent: '<string>',
confirmed_sent: '<string>'
})
};
fetch('https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'linkedin_account_sid' => '<string>',
'attendees' => [
[
'ln_id' => '<string>',
'sn_id' => '<string>'
]
],
'text' => '<string>',
'conversation_title' => '<string>',
'attachments' => [
[
'file_base64' => '<string>',
'file_url' => '<string>',
'file_name' => '<string>',
'file_type' => '<string>',
'file_byte_size' => 2
]
],
'client_reference' => '<string>',
'confirmed_not_sent' => '<string>',
'confirmed_sent' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group"
payload := strings.NewReader("{\n \"linkedin_account_sid\": \"<string>\",\n \"attendees\": [\n {\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"conversation_title\": \"<string>\",\n \"attachments\": [\n {\n \"file_base64\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"file_type\": \"<string>\",\n \"file_byte_size\": 2\n }\n ],\n \"client_reference\": \"<string>\",\n \"confirmed_not_sent\": \"<string>\",\n \"confirmed_sent\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"linkedin_account_sid\": \"<string>\",\n \"attendees\": [\n {\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"conversation_title\": \"<string>\",\n \"attachments\": [\n {\n \"file_base64\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"file_type\": \"<string>\",\n \"file_byte_size\": 2\n }\n ],\n \"client_reference\": \"<string>\",\n \"confirmed_not_sent\": \"<string>\",\n \"confirmed_sent\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"linkedin_account_sid\": \"<string>\",\n \"attendees\": [\n {\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"conversation_title\": \"<string>\",\n \"attachments\": [\n {\n \"file_base64\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"file_type\": \"<string>\",\n \"file_byte_size\": 2\n }\n ],\n \"client_reference\": \"<string>\",\n \"confirmed_not_sent\": \"<string>\",\n \"confirmed_sent\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"linkedin_account_sid": "<string>",
"linkedin_conversation_sid": "<string>",
"messenger_type": "linkedin",
"linkedin_type": "message",
"type": "inbox",
"automation": "auto",
"ln_member_id": "<string>",
"ln_id": "<string>",
"sn_id": "<string>",
"recruiter_id": "<string>",
"nickname": "<string>",
"subject": "<string>",
"text": "<string>",
"client_reference": "<string>",
"attachments": [
{
"id": "<string>",
"urn": "<string>",
"name": "<string>",
"content_type": "<string>",
"content_url": "<string>",
"file_byte_size": 123,
"path": "<string>",
"size": 123
}
],
"reactions": [
{
"emoji": "<string>",
"count": 123,
"is_viewer_reacted": true,
"first_reacted_at": "<string>"
}
],
"is_deleted": true,
"message_hash": "<string>",
"sent_at": "<string>",
"custom_content": {},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"result": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"pacing": {
"linkedin_account_sid": "<string>",
"limit_type": "<string>",
"next_call_after": "<string>",
"remaining_today": 1
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}linkedin_messages
Start group conversation
Start a new multi-attendee (group) chat on the basic messenger and send an opening message (outward action). Provide the executor account, 2..20 attendee URNs and the opening body (1..8000 chars, optional attachments, optional conversation_title to name the group); mints the group thread and dispatches the first message. Spends the send_messages bucket. Sends once per client_reference and attendee set: a repeat is answered, never sent twice; on a 409 read error.context.send_outcome, never resend under a new key. A group has no place check_linkedin_message_sent takes: ask it by the key alone or by activity_log_sid.
Contract:
- MCP tool
start_linkedin_group_conversation, registry packagemcp.linkedin/linkedin_messages, mountlinkedin.messaging. - Operation
action, response envelopeaction. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API; paced: a call spends the
send_messagessmart-limit bucket of the account it runs on, and calls of one bucket are spaced per account. A short wait is slept by the server; a longer one answers 429rate_limitedwithcontext.retry_after, and the same call succeeds from that moment. Parallel calls on one account queue behind each other.
POST
/
api
/
linkedin-messages
/
start-group
Start group conversation
curl --request POST \
--url https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"linkedin_account_sid": "<string>",
"attendees": [
{
"ln_id": "<string>",
"sn_id": "<string>"
}
],
"text": "<string>",
"conversation_title": "<string>",
"attachments": [
{
"file_base64": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"file_type": "<string>",
"file_byte_size": 2
}
],
"client_reference": "<string>",
"confirmed_not_sent": "<string>",
"confirmed_sent": "<string>"
}
'import requests
url = "https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group"
payload = {
"linkedin_account_sid": "<string>",
"attendees": [
{
"ln_id": "<string>",
"sn_id": "<string>"
}
],
"text": "<string>",
"conversation_title": "<string>",
"attachments": [
{
"file_base64": "<string>",
"file_url": "<string>",
"file_name": "<string>",
"file_type": "<string>",
"file_byte_size": 2
}
],
"client_reference": "<string>",
"confirmed_not_sent": "<string>",
"confirmed_sent": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
linkedin_account_sid: '<string>',
attendees: [{ln_id: '<string>', sn_id: '<string>'}],
text: '<string>',
conversation_title: '<string>',
attachments: [
{
file_base64: '<string>',
file_url: '<string>',
file_name: '<string>',
file_type: '<string>',
file_byte_size: 2
}
],
client_reference: '<string>',
confirmed_not_sent: '<string>',
confirmed_sent: '<string>'
})
};
fetch('https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'linkedin_account_sid' => '<string>',
'attendees' => [
[
'ln_id' => '<string>',
'sn_id' => '<string>'
]
],
'text' => '<string>',
'conversation_title' => '<string>',
'attachments' => [
[
'file_base64' => '<string>',
'file_url' => '<string>',
'file_name' => '<string>',
'file_type' => '<string>',
'file_byte_size' => 2
]
],
'client_reference' => '<string>',
'confirmed_not_sent' => '<string>',
'confirmed_sent' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group"
payload := strings.NewReader("{\n \"linkedin_account_sid\": \"<string>\",\n \"attendees\": [\n {\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"conversation_title\": \"<string>\",\n \"attachments\": [\n {\n \"file_base64\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"file_type\": \"<string>\",\n \"file_byte_size\": 2\n }\n ],\n \"client_reference\": \"<string>\",\n \"confirmed_not_sent\": \"<string>\",\n \"confirmed_sent\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"linkedin_account_sid\": \"<string>\",\n \"attendees\": [\n {\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"conversation_title\": \"<string>\",\n \"attachments\": [\n {\n \"file_base64\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"file_type\": \"<string>\",\n \"file_byte_size\": 2\n }\n ],\n \"client_reference\": \"<string>\",\n \"confirmed_not_sent\": \"<string>\",\n \"confirmed_sent\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/linkedin/v4/api/linkedin-messages/start-group")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"linkedin_account_sid\": \"<string>\",\n \"attendees\": [\n {\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"conversation_title\": \"<string>\",\n \"attachments\": [\n {\n \"file_base64\": \"<string>\",\n \"file_url\": \"<string>\",\n \"file_name\": \"<string>\",\n \"file_type\": \"<string>\",\n \"file_byte_size\": 2\n }\n ],\n \"client_reference\": \"<string>\",\n \"confirmed_not_sent\": \"<string>\",\n \"confirmed_sent\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"linkedin_account_sid": "<string>",
"linkedin_conversation_sid": "<string>",
"messenger_type": "linkedin",
"linkedin_type": "message",
"type": "inbox",
"automation": "auto",
"ln_member_id": "<string>",
"ln_id": "<string>",
"sn_id": "<string>",
"recruiter_id": "<string>",
"nickname": "<string>",
"subject": "<string>",
"text": "<string>",
"client_reference": "<string>",
"attachments": [
{
"id": "<string>",
"urn": "<string>",
"name": "<string>",
"content_type": "<string>",
"content_url": "<string>",
"file_byte_size": 123,
"path": "<string>",
"size": 123
}
],
"reactions": [
{
"emoji": "<string>",
"count": 123,
"is_viewer_reacted": true,
"first_reacted_at": "<string>"
}
],
"is_deleted": true,
"message_hash": "<string>",
"sent_at": "<string>",
"custom_content": {},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"result": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"pacing": {
"linkedin_account_sid": "<string>",
"limit_type": "<string>",
"next_call_after": "<string>",
"remaining_today": 1
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of start_linkedin_group_conversation.
LinkedIn account sid (ln_ac_…).
Required string length:
18Pattern:
^ln_ac_2..20 other participants; each needs a URN.
Required array length:
2 - 20 elementsShow child attributes
Show child attributes
Opening message; 1..8000 chars. Sent verbatim: the platform renders no merge fields, a {{first_name}} goes out as those braces.
Required string length:
1 - 8000Optional group name, max 100 chars; omitted leaves the thread unnamed.
Maximum string length:
100Exactly one of file_base64 / file_url per item; 35 MB decoded total per send.
Show child attributes
Show child attributes
Your key for this ONE message (max 255, byte for byte): one key per message, the same key on every repeat of it. The key and its place (the attendee set) are one message whatever it says, and a repeat never goes out twice: it answers 200 with the row the first send stored (result.idempotent_replay, result.content_differs when this request says something else) or 409 naming error.context.send_outcome (in_flight, unknown with retry_after and send_decisive_at, or sent; not_sent with blocking_activity_log_sid when another message holds the place). The same key at another place is another message. Without a key the same words to the same place count as a repeat for an hour after they went out. Stored on the row and searchable; check_linkedin_message_sent asks by it.
Maximum string length:
255A person's word that an earlier attempt of THIS message is not on LinkedIn: its activity_log_sid (ln_al_...), from the 409 or check_linkedin_message_sent, given only after someone looked at the conversation. Taken once the attempt can no longer land (before that: 409 send_outcome_unknown, waiting_for may_still_land, retry_after and send_decisive_at that moment): it settles that attempt not_sent and this request goes out. Moot when the attempt is no longer in doubt; another message's sid is 422 not_this_message.
Required string length:
18Pattern:
^ln_al_A person's word that an earlier attempt of THIS message IS on LinkedIn: its activity_log_sid, as for confirmed_not_sent (never both). Taken at once; it settles the attempt sent and sends nothing: the answer is 409 concurrent_send_in_flight with send_outcome sent, or 200 with the row once it is stored. Another message's sid is 422 not_this_message; an attempt already proved not sent is 409 confirmed_sent_contradicts.
Required string length:
18Pattern:
^ln_al_Response
action success envelope.
Available options:
true Available options:
action kebab-case verb; matches the route segment.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes