Send a template into a conversation

curl --request POST \
  --url https://social.linkiasoft.com/api/v1/conversations/{id}/template \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant-Id: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "templateName": "<string>",
  "templateLanguage": "<string>",
  "templateParams": [
    "<string>"
  ]
}
'

import requests

url = "https://social.linkiasoft.com/api/v1/conversations/{id}/template"

payload = {
    "templateName": "<string>",
    "templateLanguage": "<string>",
    "templateParams": ["<string>"]
}
headers = {
    "x-api-key": "<api-key>",
    "X-Tenant-Id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'X-Tenant-Id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    templateName: '<string>',
    templateLanguage: '<string>',
    templateParams: ['<string>']
  })
};

fetch('https://social.linkiasoft.com/api/v1/conversations/{id}/template', 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://social.linkiasoft.com/api/v1/conversations/{id}/template",
  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([
    'templateName' => '<string>',
    'templateLanguage' => '<string>',
    'templateParams' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Tenant-Id: <api-key>",
    "x-api-key: <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://social.linkiasoft.com/api/v1/conversations/{id}/template"

	payload := strings.NewReader("{\n  \"templateName\": \"<string>\",\n  \"templateLanguage\": \"<string>\",\n  \"templateParams\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("X-Tenant-Id", "<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://social.linkiasoft.com/api/v1/conversations/{id}/template")
  .header("x-api-key", "<api-key>")
  .header("X-Tenant-Id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"templateName\": \"<string>\",\n  \"templateLanguage\": \"<string>\",\n  \"templateParams\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://social.linkiasoft.com/api/v1/conversations/{id}/template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["X-Tenant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"templateName\": \"<string>\",\n  \"templateLanguage\": \"<string>\",\n  \"templateParams\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "text": "<string>",
  "media": {},
  "error_reason": "<string>",
  "sender_name": "<string>",
  "from_me": true,
  "platform_message_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

POST

conversations

{id}

template

Send a template into a conversation

curl --request POST \
  --url https://social.linkiasoft.com/api/v1/conversations/{id}/template \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant-Id: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "templateName": "<string>",
  "templateLanguage": "<string>",
  "templateParams": [
    "<string>"
  ]
}
'

import requests

url = "https://social.linkiasoft.com/api/v1/conversations/{id}/template"

payload = {
    "templateName": "<string>",
    "templateLanguage": "<string>",
    "templateParams": ["<string>"]
}
headers = {
    "x-api-key": "<api-key>",
    "X-Tenant-Id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'X-Tenant-Id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    templateName: '<string>',
    templateLanguage: '<string>',
    templateParams: ['<string>']
  })
};

fetch('https://social.linkiasoft.com/api/v1/conversations/{id}/template', 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://social.linkiasoft.com/api/v1/conversations/{id}/template",
  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([
    'templateName' => '<string>',
    'templateLanguage' => '<string>',
    'templateParams' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Tenant-Id: <api-key>",
    "x-api-key: <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://social.linkiasoft.com/api/v1/conversations/{id}/template"

	payload := strings.NewReader("{\n  \"templateName\": \"<string>\",\n  \"templateLanguage\": \"<string>\",\n  \"templateParams\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("X-Tenant-Id", "<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://social.linkiasoft.com/api/v1/conversations/{id}/template")
  .header("x-api-key", "<api-key>")
  .header("X-Tenant-Id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"templateName\": \"<string>\",\n  \"templateLanguage\": \"<string>\",\n  \"templateParams\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://social.linkiasoft.com/api/v1/conversations/{id}/template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["X-Tenant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"templateName\": \"<string>\",\n  \"templateLanguage\": \"<string>\",\n  \"templateParams\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "text": "<string>",
  "media": {},
  "error_reason": "<string>",
  "sender_name": "<string>",
  "from_me": true,
  "platform_message_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

Your workspace API key. Create one in Settings → API Keys; the plaintext value is shown once and never again.

Keys are scoped. A key needs conversations:send to send, conversations:read to read threads and messages, templates:read to list templates, and channels:read to list channels. A key missing the scope for an endpoint gets 403.

The CRM endpoints use the same resource:action form: leads:read, leads:create, leads:update, leads:delete, customers:read, customers:create, customers:update, customers:delete, customers:manage.

Several resources have no scope of their own and borrow one:

Resource	Governed by
Contacts	`customers:*`
Activities	`customers:` for customer activities, `leads:` for lead activities
Tags	`customers:read` to list, `customers:manage` to change
Pipeline stages	`leads:*`
Quick replies	`quick-replies:read` / `quick-replies:write`
WhatsApp groups	`wa-groups:manage`

Grant only what the integration needs — a key that only sends notifications should hold conversations:send and nothing else.

X-Tenant-Id

string

header

required

Your workspace UUID. Required on every request in addition to x-api-key.

It does not select the workspace — data access is always scoped to the workspace that owns the API key, and a mismatched value cannot read anyone else's data.

Path Parameters

string<uuid>

required

Body

application/json

templateName

string

required

An APPROVED template name from GET /v1/templates.

templateLanguage

string

required

Language code the template was approved under, e.g. en, en_US, ar.

templateParams

string[]

Values for the body placeholders {{1}}, {{2}}, … in order. The count must match the template exactly or the send is rejected.

Response

Queued for delivery.

string<uuid>

conversation_id

string<uuid>

direction

enum<string>

Available options:

inbound,

outbound

type

enum<string>

Drives how text and media are interpreted.

Available options:

text,

image,

video,

audio,

document,

sticker,

location,

contact,

poll,

reaction,

template

text

string | null

The body for text; the caption for image/video/document; the emoji for a reaction; the place name for a location; null for audio and stickers.

media

object | null

Type-specific metadata. Null for plain text.

status

enum<string>

Delivery state. failed is terminal and error_reason explains it. Read status only appears when the contact has read receipts enabled.

Available options:

pending,

sent,

delivered,

read,

failed

error_reason

string | null

sender_name

string | null

from_me

boolean

True when we sent it.

platform_message_id

string

The platform's own id. Empty until the send is acknowledged.

created_at

string<date-time>

Send media into a conversation React to a message

Conversations

Templates

Channels

Leads

Pipeline

Contacts

Activities

Customers

Tags

Quick replies

WhatsApp groups

Send a template into a conversation

Authorizations

Path Parameters

Body

Response