API Keys
Regenerar API key de um número
REGENERA a API key padrão de um único número (o produto mantém exatamente uma key padrão por número — não existe “criar outra key”). Apenas tenant-scoped (403 NUMBER_SCOPE_NOT_ALLOWED para key de número). Informe o número em whatsappNumberId: a key anterior dele é rotacionada/invalidada e o novo valor bruto (campo key) é retornado UMA ÚNICA VEZ — guarde-o. Número desconhecido → 404 NUMBER_NOT_FOUND.
Requer uma chave com escopo de tenant.
POST
/
v1
/
api-keys
Regenerar API key de um número
curl --request POST \
--url https://pilotstatus.com.br/v1/api-keys \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"whatsappNumberId": "wn_1"
}
'import requests
url = "https://pilotstatus.com.br/v1/api-keys"
payload = { "whatsappNumberId": "wn_1" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({whatsappNumberId: 'wn_1'})
};
fetch('https://pilotstatus.com.br/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'whatsappNumberId' => 'wn_1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://pilotstatus.com.br/v1/api-keys"
payload := strings.NewReader("{\n \"whatsappNumberId\": \"wn_1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/api-keys")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"whatsappNumberId\": \"wn_1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"whatsappNumberId\": \"wn_1\"\n}"
response = http.request(request)
puts response.read_body{
"numberId": "wn_1",
"keyId": "k_new",
"keyPrefix": "ps_",
"keyLast4": "wxyz",
"key": "ps_...newreal...",
"createdAt": "2026-06-28T10:00:00.000Z"
}{
"error": "Validation error"
}{
"error": "Unauthorized"
}{
"error": "Number-scoped keys cannot call tenant endpoints",
"code": "NUMBER_SCOPE_NOT_ALLOWED"
}{
"error": "Too many requests"
}Esta página foi útil?
⌘I
Regenerar API key de um número
curl --request POST \
--url https://pilotstatus.com.br/v1/api-keys \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"whatsappNumberId": "wn_1"
}
'import requests
url = "https://pilotstatus.com.br/v1/api-keys"
payload = { "whatsappNumberId": "wn_1" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({whatsappNumberId: 'wn_1'})
};
fetch('https://pilotstatus.com.br/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'whatsappNumberId' => 'wn_1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://pilotstatus.com.br/v1/api-keys"
payload := strings.NewReader("{\n \"whatsappNumberId\": \"wn_1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/api-keys")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"whatsappNumberId\": \"wn_1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"whatsappNumberId\": \"wn_1\"\n}"
response = http.request(request)
puts response.read_body{
"numberId": "wn_1",
"keyId": "k_new",
"keyPrefix": "ps_",
"keyLast4": "wxyz",
"key": "ps_...newreal...",
"createdAt": "2026-06-28T10:00:00.000Z"
}{
"error": "Validation error"
}{
"error": "Unauthorized"
}{
"error": "Number-scoped keys cannot call tenant endpoints",
"code": "NUMBER_SCOPE_NOT_ALLOWED"
}{
"error": "Too many requests"
}