Skip to main content
POST

Authorizations

Authorization
string
header
required

Authorization: Bearer sk_live_...

Body

application/json
name
string
required
Minimum string length: 2
Example:

"Instagram atendimento"

acceptInstagramTerms
enum<boolean>

Obrigatório no modo UNOFFICIAL. Confirma ciência do risco de restrição pela plataforma.

Available options:
true
mode
enum<string>
default:UNOFFICIAL

Connection type. UNOFFICIAL (default): Instagram login. OFFICIAL: Meta line. OFFICIAL_BYOK: your own Meta token and IDs.

Available options:
UNOFFICIAL,
OFFICIAL,
OFFICIAL_BYOK

Returns a link for someone else to finish Meta connection. Omit when sending credentials in this request.

metaAccessToken
string

Page Access Token (OFFICIAL_BYOK).

facebookPageId
string

Facebook Page ID vinculada à conta IG (OFFICIAL_BYOK).

igBusinessAccountId
string

Instagram Business Account ID (OFFICIAL_BYOK).

metaAppSecret
string

App Secret Meta para validar webhooks (OFFICIAL_BYOK).

metaEmbeddedCode
string

Código do Facebook Login (OFFICIAL). Alternativa: generateShareableLink=true.

expectedUsername
string

Optional. Username esperado no login (conexão unofficial). Se o login conectar outra conta, a API responde 409 (INSTAGRAM_ACCOUNT_MISMATCH).

Example:

"seu_usuario"

termsVersion
string
Example:

"v1"

locale
string
Example:

"pt-BR"

timezone
string
Example:

"America/Sao_Paulo"

auth
object

Response

Instance criada (ACTIVE ou PENDING com shareableLink).

success
boolean
Example:

true

data
object