Start a new conversation (direct or group)

POST /messaging/conversations/start

Start a new conversation (direct or group)

cURL

curl --request POST \
  --url https://open.beatpass.ca/api/v1/messaging/conversations/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message_text": "<string>",
  "user_id": 123,
  "user_ids": [
    123
  ],
  "title": "<string>"
}
'

import requests

url = "https://open.beatpass.ca/api/v1/messaging/conversations/start"

payload = {
    "message_text": "<string>",
    "user_id": 123,
    "user_ids": [123],
    "title": "<string>"
}
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({message_text: '<string>', user_id: 123, user_ids: [123], title: '<string>'})
};

fetch('https://open.beatpass.ca/api/v1/messaging/conversations/start', 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://open.beatpass.ca/api/v1/messaging/conversations/start",
  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([
    'message_text' => '<string>',
    'user_id' => 123,
    'user_ids' => [
        123
    ],
    'title' => '<string>'
  ]),
  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://open.beatpass.ca/api/v1/messaging/conversations/start"

	payload := strings.NewReader("{\n  \"message_text\": \"<string>\",\n  \"user_id\": 123,\n  \"user_ids\": [\n    123\n  ],\n  \"title\": \"<string>\"\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://open.beatpass.ca/api/v1/messaging/conversations/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message_text\": \"<string>\",\n  \"user_id\": 123,\n  \"user_ids\": [\n    123\n  ],\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://open.beatpass.ca/api/v1/messaging/conversations/start")

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  \"message_text\": \"<string>\",\n  \"user_id\": 123,\n  \"user_ids\": [\n    123\n  ],\n  \"title\": \"<string>\"\n}"

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

Authorizations

Authorization · string · header · required

API access is invite-only. Contact [e-mail] to request access. Once approved, generate tokens from Account Settings → Developers. Include as: Authorization: Bearer {token}. Tokens expire after 90 days.

Body

application/json

message_text · string · required

Initial message text

Maximum string length: 2000

user_id · integer

Recipient user ID for direct message

user_ids · integer[]

User IDs for group conversation (min 2)

title · string

Optional group conversation title

Maximum string length: 255

Response

201

Conversation created with initial message