Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

API key do workspace (painel › Segurança › API keys): Authorization: Bearer wbx_key_…. Cada key tem permissões: as rotas /account/* pedem a da rota; nas rotas de instância a key só é exigida quando o workspace liga "Exigir API key", e precisa de instances:operate.

Path Parameters

instance_id
string
required

Id da instância (dashboard › instância › Credenciais).

Body

application/json
name
string

Nome da instância (rótulo interno).

Required string length: 1 - 80
webhooks
object
settings
object

Response

id
string
required
name
string
required
status
enum<string>
required
Available options:
created,
starting,
qr,
connecting,
connected,
disconnected,
logged_out,
banned,
stopped
status_reason
string | null
required
connected
boolean
required
phone
string | null
required

Número conectado (só dígitos).

profile_name
string | null
required
platform
string | null
required
connected_at
string | null
required

ISO-8601 (UTC).

disconnected_at
string | null
required

ISO-8601 (UTC).

subscription_status
enum<string>
required

Assinatura da conta (a mesma para todas as instâncias): o plano é por slots, não por instância.

Available options:
trial,
active,
past_due,
canceled,
expired,
partner
trial_ends_at
string | null
required

Fim do trial da conta; null fora do trial.

due_at
string | null
required

Até quando o plano da conta está pago.

settings
object
required
webhooks
object
required
api_url
string
required

Base da API pública desta instância.

created_at
string
required

ISO-8601 (UTC).

updated_at
string
required

ISO-8601 (UTC).

token
string

Token da instância. Presente em GET /me e na Account API.