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

api-keys

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"
}
'

{
  "numberId": "wn_1",
  "keyId": "k_new",
  "keyPrefix": "ps_",
  "keyLast4": "wxyz",
  "key": "ps_...newreal...",
  "createdAt": "2026-06-28T10:00:00.000Z"
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Corpo

application/json

whatsappNumberId

string

obrigatório

Id do número cuja key padrão será regenerada.

Exemplo:

"wn_1"

Resposta

Regenerar key do número

Listar API keys

Rotacionar API key

⌘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"
}
'

{
  "numberId": "wn_1",
  "keyId": "k_new",
  "keyPrefix": "ps_",
  "keyLast4": "wxyz",
  "key": "ps_...newreal...",
  "createdAt": "2026-06-28T10:00:00.000Z"
}