Accounts

Start headless account connection

Begin connecting a NEW social account from your own UI (no SmartlyQ dashboard session needed). Returns a one-time connect_url (valid 15 minutes) — open it in a browser so the user can authorize. After they approve, the platform’s OAuth callback completes the connection and (if provided) redirects to return_url with ?connected=<count>&platform=<name>. Supported on all platforms. Platforms that expose multiple targets (YouTube channels, Google Business locations, Tumblr blogs, LinkedIn pages) connect them all automatically. Poll completion with GET /social/connect/{state_token}. Requires scope social:write.

Some platforms connect with credentials instead of a browser round trip, and return the connected account directly rather than a connect_url: Telegram (bot_token + chat), WhatsApp (waba_id + phone_number_id + access_token) and Bluesky (identifier + app_password).

POST

social

connect

{platform}

Start headless account connection

curl --request POST \
  --url https://api.smartlyq.com/v1/social/connect/{platform} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "return_url": "<string>",
  "bot_token": "<string>",
  "chat": "<string>",
  "identifier": "<string>",
  "app_password": "<string>",
  "waba_id": "<string>",
  "phone_number_id": "<string>",
  "access_token": "<string>"
}
'

import requests

url = "https://api.smartlyq.com/v1/social/connect/{platform}"

payload = {
    "return_url": "<string>",
    "bot_token": "<string>",
    "chat": "<string>",
    "identifier": "<string>",
    "app_password": "<string>",
    "waba_id": "<string>",
    "phone_number_id": "<string>",
    "access_token": "<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({
    return_url: '<string>',
    bot_token: '<string>',
    chat: '<string>',
    identifier: '<string>',
    app_password: '<string>',
    waba_id: '<string>',
    phone_number_id: '<string>',
    access_token: '<string>'
  })
};

fetch('https://api.smartlyq.com/v1/social/connect/{platform}', 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://api.smartlyq.com/v1/social/connect/{platform}",
  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([
    'return_url' => '<string>',
    'bot_token' => '<string>',
    'chat' => '<string>',
    'identifier' => '<string>',
    'app_password' => '<string>',
    'waba_id' => '<string>',
    'phone_number_id' => '<string>',
    'access_token' => '<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://api.smartlyq.com/v1/social/connect/{platform}"

	payload := strings.NewReader("{\n  \"return_url\": \"<string>\",\n  \"bot_token\": \"<string>\",\n  \"chat\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"app_password\": \"<string>\",\n  \"waba_id\": \"<string>\",\n  \"phone_number_id\": \"<string>\",\n  \"access_token\": \"<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://api.smartlyq.com/v1/social/connect/{platform}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"return_url\": \"<string>\",\n  \"bot_token\": \"<string>\",\n  \"chat\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"app_password\": \"<string>\",\n  \"waba_id\": \"<string>\",\n  \"phone_number_id\": \"<string>\",\n  \"access_token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smartlyq.com/v1/social/connect/{platform}")

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  \"return_url\": \"<string>\",\n  \"bot_token\": \"<string>\",\n  \"chat\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"app_password\": \"<string>\",\n  \"waba_id\": \"<string>\",\n  \"phone_number_id\": \"<string>\",\n  \"access_token\": \"<string>\"\n}"

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

{
  "success": true,
  "data": {
    "platform": "twitter",
    "connect_url": "https://example.com/launch",
    "expires_at": "2026-07-26T09:41:22Z"
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Missing or malformed Authorization header",
    "details": {}
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "API key lacks required scope: social:write",
    "details": {
      "required_scope": "social:write"
    }
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Post not found.",
    "details": {}
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Missing required fields: content, platforms.",
    "details": {
      "fields": [
        "content",
        "platforms"
      ]
    }
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "SERVER_ERROR",
    "message": "Something went wrong on our side. Retry with the same request_id - it is safe.",
    "details": {}
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

Authorizations

Authorization

string

header

required

API key from Developer dashboard (Bearer token).

Headers

X-Profile-Id

integer

Act inside a profile (sub-account) you own: data reads and writes target the profile workspace while billing, rate limits and usage stay on your own account. Requires the profiles:manage scope. Returns 404 for profiles you do not own and 409 for paused profiles.

Path Parameters

platform

enum<string>

required

Platform to connect. All 15 platforms are supported (use twitter for X, gmb for Google Business). 14 are OAuth flows returning a connect_url (discord runs the server-webhook authorize flow). telegram is a CREDENTIAL connect instead: pass bot_token + chat in the body and the account connects immediately - no URL to open. whatsapp is a credential connect too: POST body { waba_id, phone_number_id, access_token } (a Meta system-user token) links one WhatsApp Business number.

Available options:

facebook,

instagram,

twitter,

linkedin,

youtube,

tiktok,

threads,

bluesky,

pinterest,

reddit,

snapchat,

tumblr,

gmb,

discord,

telegram,

whatsapp

Body

application/json

return_url

string<uri>

Optional URL to redirect the user to after they finish authorizing.

bot_token

string

Telegram only (required for it): your bot's token from @BotFather (e.g. 123456:AA...). Verified against Telegram (getMe/getChat/getChatMember - the bot must have posting rights in the chat) and stored encrypted.

chat

string

Telegram only (required for it): the target channel/group as @channelusername or a numeric chat id. Private chats are rejected.

identifier

string

Bluesky only: your handle (e.g. yourname.bsky.social), DID, or account email. Send it with app_password to connect without a browser.

app_password

string

Bluesky only: an app password generated in Bluesky settings (format xxxx-xxxx-xxxx-xxxx) - never your account password, which is rejected. Supplying this connects the account immediately instead of returning a connect_url.

waba_id

string

WhatsApp only (required for it): your WhatsApp Business Account id.

phone_number_id

string

WhatsApp only (required for it): the phone number id to connect, from the WABA.

access_token

string

WhatsApp only (required for it): a system-user access token with whatsapp_business_messaging and whatsapp_business_management. Stored encrypted.

Response

Connection link created. For telegram the response has no connect_url - the account is connected immediately and returned as {platform, account}.

success

enum<boolean>

Available options:

true

data

object

Show child attributes

meta

object

Show child attributes

Start headless account connection

curl --request POST \
  --url https://api.smartlyq.com/v1/social/connect/{platform} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "return_url": "<string>",
  "bot_token": "<string>",
  "chat": "<string>",
  "identifier": "<string>",
  "app_password": "<string>",
  "waba_id": "<string>",
  "phone_number_id": "<string>",
  "access_token": "<string>"
}
'

import requests

url = "https://api.smartlyq.com/v1/social/connect/{platform}"

payload = {
    "return_url": "<string>",
    "bot_token": "<string>",
    "chat": "<string>",
    "identifier": "<string>",
    "app_password": "<string>",
    "waba_id": "<string>",
    "phone_number_id": "<string>",
    "access_token": "<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({
    return_url: '<string>',
    bot_token: '<string>',
    chat: '<string>',
    identifier: '<string>',
    app_password: '<string>',
    waba_id: '<string>',
    phone_number_id: '<string>',
    access_token: '<string>'
  })
};

fetch('https://api.smartlyq.com/v1/social/connect/{platform}', 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://api.smartlyq.com/v1/social/connect/{platform}",
  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([
    'return_url' => '<string>',
    'bot_token' => '<string>',
    'chat' => '<string>',
    'identifier' => '<string>',
    'app_password' => '<string>',
    'waba_id' => '<string>',
    'phone_number_id' => '<string>',
    'access_token' => '<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://api.smartlyq.com/v1/social/connect/{platform}"

	payload := strings.NewReader("{\n  \"return_url\": \"<string>\",\n  \"bot_token\": \"<string>\",\n  \"chat\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"app_password\": \"<string>\",\n  \"waba_id\": \"<string>\",\n  \"phone_number_id\": \"<string>\",\n  \"access_token\": \"<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://api.smartlyq.com/v1/social/connect/{platform}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"return_url\": \"<string>\",\n  \"bot_token\": \"<string>\",\n  \"chat\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"app_password\": \"<string>\",\n  \"waba_id\": \"<string>\",\n  \"phone_number_id\": \"<string>\",\n  \"access_token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smartlyq.com/v1/social/connect/{platform}")

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  \"return_url\": \"<string>\",\n  \"bot_token\": \"<string>\",\n  \"chat\": \"<string>\",\n  \"identifier\": \"<string>\",\n  \"app_password\": \"<string>\",\n  \"waba_id\": \"<string>\",\n  \"phone_number_id\": \"<string>\",\n  \"access_token\": \"<string>\"\n}"

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

{
  "success": true,
  "data": {
    "platform": "twitter",
    "connect_url": "https://example.com/launch",
    "expires_at": "2026-07-26T09:41:22Z"
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Missing or malformed Authorization header",
    "details": {}
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "API key lacks required scope: social:write",
    "details": {
      "required_scope": "social:write"
    }
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Post not found.",
    "details": {}
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Missing required fields: content, platforms.",
    "details": {
      "fields": [
        "content",
        "platforms"
      ]
    }
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "SERVER_ERROR",
    "message": "Something went wrong on our side. Retry with the same request_id - it is safe.",
    "details": {}
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

Core

CRM

Profiles

AI Generation

Social

WhatsApp

Inbox

AI Assistants

Start headless account connection

Authorizations

Headers

Path Parameters

Body

Response