Atualizar instância

cURL

curl --request PUT \
  --url https://api.wabox.me/partner/instances/{instance_id} \
  --header 'Content-Type: application/json' \
  --header 'Partner-Token: <api-key>' \
  --data '
{
  "webhooks": {
    "received_url": "https://kinbox.example/v2/wabox/received"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'Partner-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({webhooks: {received_url: 'https://kinbox.example/v2/wabox/received'}})
};

fetch('https://api.wabox.me/partner/instances/{instance_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.wabox.me/partner/instances/{instance_id}"

payload = { "webhooks": { "received_url": "https://kinbox.example/v2/wabox/received" } }
headers = {
    "Partner-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wabox.me/partner/instances/{instance_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'webhooks' => [
        'received_url' => 'https://kinbox.example/v2/wabox/received'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Partner-Token: <api-key>"
  ],
]);

$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.wabox.me/partner/instances/{instance_id}"

	payload := strings.NewReader("{\n  \"webhooks\": {\n    \"received_url\": \"https://kinbox.example/v2/wabox/received\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Partner-Token", "<api-key>")
	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))

}

{
  "id": "8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b",
  "name": "Loja Centro",
  "token": "3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E",
  "status": "qr",
  "status_reason": null,
  "connected": false,
  "phone": null,
  "profile_name": null,
  "platform": null,
  "connected_at": null,
  "disconnected_at": null,
  "subscription_status": "partner",
  "trial_ends_at": "2026-09-15T12:00:00.000Z",
  "due_at": null,
  "settings": {
    "auto_read_message": false,
    "auto_read_status": false,
    "call_reject_auto": false,
    "call_reject_message": null,
    "disable_enqueue_when_disconnected": false,
    "queue_max_age_hours": 12,
    "delay_message_min_ms": 1000,
    "delay_message_max_ms": 3000,
    "proxy_url": null
  },
  "webhooks": {
    "received_url": "https://kinbox.example/wabox/received",
    "delivery_url": "https://kinbox.example/wabox/delivery",
    "message_status_url": "https://kinbox.example/wabox/status",
    "connected_url": "https://kinbox.example/wabox/connected",
    "disconnected_url": "https://kinbox.example/wabox/disconnected",
    "chat_presence_url": null,
    "notify_sent_by_me": true,
    "ignore_groups": false,
    "ignore_private": false,
    "ignore_text": false,
    "ignore_image": false,
    "ignore_video": false,
    "ignore_audio": false,
    "ignore_document": false,
    "ignore_received_callback": false,
    "ignore_delivery_callback": false,
    "ignore_message_status_callback": false,
    "ignore_connected_callback": false,
    "ignore_disconnected_callback": false,
    "ignore_chat_presence_callback": false,
    "secret": "whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0"
  },
  "api_url": "https://api.wabox.me/instances/8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b/token/3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E",
  "created_at": "2026-09-15T12:00:00.000Z",
  "updated_at": "2026-09-15T12:00:00.000Z"
}

{
  "error": {
    "code": "partner_token_required",
    "message": "Invalid Partner-Token"
  }
}

PUT

partner

instances

{instance_id}

cURL

curl --request PUT \
  --url https://api.wabox.me/partner/instances/{instance_id} \
  --header 'Content-Type: application/json' \
  --header 'Partner-Token: <api-key>' \
  --data '
{
  "webhooks": {
    "received_url": "https://kinbox.example/v2/wabox/received"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'Partner-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({webhooks: {received_url: 'https://kinbox.example/v2/wabox/received'}})
};

fetch('https://api.wabox.me/partner/instances/{instance_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.wabox.me/partner/instances/{instance_id}"

payload = { "webhooks": { "received_url": "https://kinbox.example/v2/wabox/received" } }
headers = {
    "Partner-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wabox.me/partner/instances/{instance_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'webhooks' => [
        'received_url' => 'https://kinbox.example/v2/wabox/received'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Partner-Token: <api-key>"
  ],
]);

$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.wabox.me/partner/instances/{instance_id}"

	payload := strings.NewReader("{\n  \"webhooks\": {\n    \"received_url\": \"https://kinbox.example/v2/wabox/received\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Partner-Token", "<api-key>")
	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))

}

{
  "id": "8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b",
  "name": "Loja Centro",
  "token": "3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E",
  "status": "qr",
  "status_reason": null,
  "connected": false,
  "phone": null,
  "profile_name": null,
  "platform": null,
  "connected_at": null,
  "disconnected_at": null,
  "subscription_status": "partner",
  "trial_ends_at": "2026-09-15T12:00:00.000Z",
  "due_at": null,
  "settings": {
    "auto_read_message": false,
    "auto_read_status": false,
    "call_reject_auto": false,
    "call_reject_message": null,
    "disable_enqueue_when_disconnected": false,
    "queue_max_age_hours": 12,
    "delay_message_min_ms": 1000,
    "delay_message_max_ms": 3000,
    "proxy_url": null
  },
  "webhooks": {
    "received_url": "https://kinbox.example/wabox/received",
    "delivery_url": "https://kinbox.example/wabox/delivery",
    "message_status_url": "https://kinbox.example/wabox/status",
    "connected_url": "https://kinbox.example/wabox/connected",
    "disconnected_url": "https://kinbox.example/wabox/disconnected",
    "chat_presence_url": null,
    "notify_sent_by_me": true,
    "ignore_groups": false,
    "ignore_private": false,
    "ignore_text": false,
    "ignore_image": false,
    "ignore_video": false,
    "ignore_audio": false,
    "ignore_document": false,
    "ignore_received_callback": false,
    "ignore_delivery_callback": false,
    "ignore_message_status_callback": false,
    "ignore_connected_callback": false,
    "ignore_disconnected_callback": false,
    "ignore_chat_presence_callback": false,
    "secret": "whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0"
  },
  "api_url": "https://api.wabox.me/instances/8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b/token/3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E",
  "created_at": "2026-09-15T12:00:00.000Z",
  "updated_at": "2026-09-15T12:00:00.000Z"
}

{
  "error": {
    "code": "partner_token_required",
    "message": "Invalid Partner-Token"
  }
}

Authorizations

Partner-Token

string

header

required

Credencial da Partner API (workspace › Segurança › Partner API). Só nas rotas /partner/*.

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

Show child attributes

settings

object

Show child attributes

Response

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

Available options:

trial,

active,

past_due,

canceled,

expired,

partner

trial_ends_at

string

required

ISO-8601 (UTC).

due_at

string | null

required

ISO-8601 (UTC).

settings

object

required

Show child attributes

webhooks

object

required

Show child attributes

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 Partner API.

Introdução

Endpoints

Webhooks

Instância

Mensagens

Fila

Contatos

Perfil

Grupos

Chats

Interativos

Privacidade

Comunidades

Canais

Business e catálogo

Etiquetas

Partner

Webhooks

Atualizar instância

Authorizations

Path Parameters

Body

Response