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>"
}
'

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