Create Telegram instance

curl --request POST \ --url https://api.notifique.dev/v1/telegram/instances \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "Support", "mode": "BOT", "botToken": "123456:ABC-DEF" } '

{ "success": true, "data": { "id": "clxx_inst_bot", "name": "Atendimento", "status": "ACTIVE", "mode": "BOT", "botUsername": "@meubot", "webhookUrl": "https://api.notifique.dev/webhooks/telegram/clxx_inst_bot" } }

Authorizations

Authorization

string

header

required

Authorization: Bearer sk_live_xxxxx

Body

application/json

name

string

required

Friendly name for this connection in the dashboard.

Minimum string length: 2

mode

enum<string>

required

BOT: bot with token. USER: personal/pro account with QR login.

Available options:

BOT,

USER

botToken

string

Bot token (required when mode is BOT).

acceptUserTerms

boolean

Required true for USER mode — confirms you understand automation rules.

termsVersion

string

Optional. Rótulo da versão dos termos aceitos no modo USER (ex.: 2026-04 ou v2), usado só para registro e auditoria. Se omitido, o servidor grava um valor padrão (v1). No altera o funcionamento da API.

Maximum string length: 32

generateShareableLink

boolean

default:false

Returns a link for someone else to finish login. Omit to get the QR in the response.

Response

Account registered. Bot is ACTIVE with webhookUrl. User account is usually PENDING until login completes (QR or link).

success

boolean

data

object

Show child attributes