Skip to main content
POST

Autorizações

Authorization
string
header
obrigatório

Authorization: Bearer sk_live_...

Corpo

application/json
name
string
obrigatório
Minimum string length: 2
Exemplo:

"Instagram atendimento"

acceptInstagramTerms
enum<boolean>

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

Opções disponíveis:
true
mode
enum<string>
padrão:UNOFFICIAL

Tipo de conexão. UNOFFICIAL (padrão): login Instagram. OFFICIAL: linha Meta. OFFICIAL_BYOK: token e IDs Meta próprios.

Opções disponíveis:
UNOFFICIAL,
OFFICIAL,
OFFICIAL_BYOK

Gera um link para outra pessoa concluir a conexão Meta. Omita quando você envia credenciais na hora.

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

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

Exemplo:

"seu_usuario"

termsVersion
string
Exemplo:

"v1"

locale
string
Exemplo:

"pt-BR"

timezone
string
Exemplo:

"America/Sao_Paulo"

auth
object

Resposta

Instância criada (ACTIVE ou PENDING com shareableLink).

success
boolean
Exemplo:

true

data
object