Join additional agency companies

curl --request POST \
  --url https://app.sideshift.app/api/oauth/v1/companies/join \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.sideshift.app/api/oauth/v1/companies/join', 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/companies/join",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sideshift.app/api/oauth/v1/companies/join"

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

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.sideshift.app/api/oauth/v1/companies/join")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "success": true,
    "message": "<string>",
    "joinedCount": 123,
    "autoSyncEnabled": true
  }
}

{
  "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": "rate_limited",
    "message": "Rate limit exceeded",
    "requestId": "req_..."
  }
}

POST

companies

join

Join additional agency companies

curl --request POST \
  --url https://app.sideshift.app/api/oauth/v1/companies/join \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.sideshift.app/api/oauth/v1/companies/join', 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/companies/join",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sideshift.app/api/oauth/v1/companies/join"

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

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.sideshift.app/api/oauth/v1/companies/join")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "success": true,
    "message": "<string>",
    "joinedCount": 123,
    "autoSyncEnabled": true
  }
}

{
  "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": "rate_limited",
    "message": "Rate limit exceeded",
    "requestId": "req_..."
  }
}

Authorizations

Authorization

string

header

required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Response

Confirmation of (re-)joining the token tenant's company; always joins exactly 1 company with auto-sync off.

data

object

required

Result of (re-)affirming membership of the token tenant's company. The OAuth token is single-tenant, so this always joins exactly the token's company and never enables agency auto-sync.

Show child attributes

⌘I

Guides

OAuth 2.1 & MCP

Legacy API (Deprecated)

Join additional agency companies

Authorizations

Response