Send a message to a contact

Sends a message to a contact. Creates a conversation if one doesn’t exist.

POST /messages

Send a message to a contact

cURL

curl --request POST \
  --url https://app.leonar.app/api/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "channel": "email",
  "subject": "Exciting opportunity at Doctolib",
  "content": "Hi Sophie, I came across your profile and thought you might be interested..."
}
'

import requests

url = "https://app.leonar.app/api/v1/messages"

payload = {
    "contact_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "channel": "email",
    "subject": "Exciting opportunity at Doctolib",
    "content": "Hi Sophie, I came across your profile and thought you might be interested..."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contact_id: 'a1b2c3d4-5678-90ab-cdef-1234567890ab',
    channel: 'email',
    subject: 'Exciting opportunity at Doctolib',
    content: 'Hi Sophie, I came across your profile and thought you might be interested...'
  })
};

fetch('https://app.leonar.app/api/v1/messages', 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.leonar.app/api/v1/messages",
  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([
    'contact_id' => 'a1b2c3d4-5678-90ab-cdef-1234567890ab',
    'channel' => 'email',
    'subject' => 'Exciting opportunity at Doctolib',
    'content' => 'Hi Sophie, I came across your profile and thought you might be interested...'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.leonar.app/api/v1/messages"

	payload := strings.NewReader("{\n  \"contact_id\": \"a1b2c3d4-5678-90ab-cdef-1234567890ab\",\n  \"channel\": \"email\",\n  \"subject\": \"Exciting opportunity at Doctolib\",\n  \"content\": \"Hi Sophie, I came across your profile and thought you might be interested...\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.leonar.app/api/v1/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact_id\": \"a1b2c3d4-5678-90ab-cdef-1234567890ab\",\n  \"channel\": \"email\",\n  \"subject\": \"Exciting opportunity at Doctolib\",\n  \"content\": \"Hi Sophie, I came across your profile and thought you might be interested...\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.leonar.app/api/v1/messages")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contact_id\": \"a1b2c3d4-5678-90ab-cdef-1234567890ab\",\n  \"channel\": \"email\",\n  \"subject\": \"Exciting opportunity at Doctolib\",\n  \"content\": \"Hi Sophie, I came across your profile and thought you might be interested...\"\n}"

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

201

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "direction": "<string>",
    "content": "<string>",
    "sent_at": "2023-11-07T05:31:56Z",
    "channel": "<string>",
    "contact": {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "first_name": "Sophie",
      "last_name": "Martin",
      "title": "Senior Software Engineer",
      "current_company": "Doctolib",
      "location": "Paris, France",
      "linkedin_profile": "https://www.linkedin.com/in/sophie-martin",
      "emails": [
        {
          "email": "[e-mail]",
          "type": "work"
        }
      ],
      "phones": [
        {
          "phone": "[phone]",
          "type": "personal"
        }
      ],
      "tags": [
        "frontend",
        "senior"
      ],
      "global_status": "new",
      "source": "linkedin",
      "summary": null,
      "skills": [
        "React",
        "TypeScript",
        "Node.js"
      ],
      "languages": [
        "French",
        "English"
      ],
      "years_experience": 8,
      "custom_data": {
        "industry_code": "A12",
        "vip": true
      },
      "do_not_contact": false,
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-20T14:00:00Z",
      "last_contacted_at": null,
      "archived_at": null
    }
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "Invalid input"
  }
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key"
  }
}

Authorizations

Authorization · string · header · required

API key starting with leo_

Body

application/json

contact_id · string<uuid> · required

channel · enum<string> · required

Available options: email, linkedin, whatsapp

content · string · required

subject · string

Required for email

sender_account_id · string<uuid>

Connected account to send from. Auto-selected if omitted.

linkedin_message_type · enum<string>

LinkedIn message type (default message)

Available options: message, inmail, invitation

recipient_phone · string

International phone number to use for first-time WhatsApp sends when the contact has no WhatsApp provider ID or existing chat.

Response

201

application/json

Message sent

data · object

Show child attributes