curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/conversations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"participantId": "<string>",
"groupName": "<string>",
"participantIds": [
"<string>"
],
"isProgramGroupChat": true
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/conversations"
payload = {
"participantId": "<string>",
"groupName": "<string>",
"participantIds": ["<string>"],
"isProgramGroupChat": True
}
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({
participantId: '<string>',
groupName: '<string>',
participantIds: ['<string>'],
isProgramGroupChat: true
})
};
fetch('https://app.sideshift.app/api/oauth/v1/conversations', 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.sideshift.app/api/oauth/v1/conversations",
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([
'participantId' => '<string>',
'groupName' => '<string>',
'participantIds' => [
'<string>'
],
'isProgramGroupChat' => true
]),
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.sideshift.app/api/oauth/v1/conversations"
payload := strings.NewReader("{\n \"participantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"participantIds\": [\n \"<string>\"\n ],\n \"isProgramGroupChat\": true\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.sideshift.app/api/oauth/v1/conversations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"participantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"participantIds\": [\n \"<string>\"\n ],\n \"isProgramGroupChat\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/conversations")
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 \"participantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"participantIds\": [\n \"<string>\"\n ],\n \"isProgramGroupChat\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"conversationId": "<string>",
"channelId": "<string>",
"lane": "native"
}
}{
"error": {
"code": "invalid_request",
"message": "name is required",
"requestId": "req_..."
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "conflict",
"message": "This company's messaging is moving to SideShift's own inbox. Retry in a minute.",
"meta": {
"reason": "messaging_migrating",
"retryAfterSeconds": 60
},
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Create a conversation
create a new conversation as the token tenant — a 1:1 creator DM (participantId) or a group conversation (groupName + participantIds). Creates a real conversation (a native room on a company on SideShift’s own messaging; an existing 1:1 room is reused), so sandbox/test grants are rejected. Requires the messages:write scope.
curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/conversations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"participantId": "<string>",
"groupName": "<string>",
"participantIds": [
"<string>"
],
"isProgramGroupChat": true
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/conversations"
payload = {
"participantId": "<string>",
"groupName": "<string>",
"participantIds": ["<string>"],
"isProgramGroupChat": True
}
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({
participantId: '<string>',
groupName: '<string>',
participantIds: ['<string>'],
isProgramGroupChat: true
})
};
fetch('https://app.sideshift.app/api/oauth/v1/conversations', 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.sideshift.app/api/oauth/v1/conversations",
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([
'participantId' => '<string>',
'groupName' => '<string>',
'participantIds' => [
'<string>'
],
'isProgramGroupChat' => true
]),
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.sideshift.app/api/oauth/v1/conversations"
payload := strings.NewReader("{\n \"participantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"participantIds\": [\n \"<string>\"\n ],\n \"isProgramGroupChat\": true\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.sideshift.app/api/oauth/v1/conversations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"participantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"participantIds\": [\n \"<string>\"\n ],\n \"isProgramGroupChat\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/conversations")
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 \"participantId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"participantIds\": [\n \"<string>\"\n ],\n \"isProgramGroupChat\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"conversationId": "<string>",
"channelId": "<string>",
"lane": "native"
}
}{
"error": {
"code": "invalid_request",
"message": "name is required",
"requestId": "req_..."
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "conflict",
"message": "This company's messaging is moving to SideShift's own inbox. Retry in a minute.",
"meta": {
"reason": "messaging_migrating",
"retryAfterSeconds": 60
},
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Authorizations
OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.
Body
Create a conversation as the token tenant (companyId injected from the token). Choose EXACTLY ONE mode: 1:1 DM — pass participantId (the creator id) and leave group fields unset; or group — pass groupName (plus optional participantIds and isProgramGroupChat) and leave participantId unset. Passing neither, or both, returns 400.
1:1 mode: the other participant (creator) id. Mutually exclusive with groupName.
Group mode: the group conversation name. Creates a real group channel. Mutually exclusive with participantId.
Group mode: additional member Firebase user ids (may be empty). Each id must resolve to an existing user (404 'Creator not found' otherwise).
Group mode: true if this group chat belongs to a campaign/program. Defaults to false when omitted.
Response
The conversation id, plus lane: 'native' on a native room.
Result of creating a conversation: its id (a uuid on a native room; an existing 1:1 room is reused) plus the channel id on the connected provider, when one exists.
Show child attributes
Show child attributes