Endpoint responsável por atualizar as configurações de uma chave de API já existente em uma subconta Asaas.
Com este endpoint, a conta-pai pode alterar informações de uma chave de API da subconta, como nome, status de habilitação e data de expiração, sem precisar acessar manualmente a subconta pela interface Web.
Essa funcionalidade faz parte do gerenciamento de chaves de API de subcontas e é indicada para operações que precisam controlar o ciclo de vida das credenciais de forma centralizada e segura.
Quando utilizar este endpoint
Utilize este endpoint quando sua integração precisar:
- renomear uma chave de API de uma subconta;
- habilitar uma chave previamente desabilitada;
- desabilitar temporariamente uma chave sem excluí-la;
- alterar a data de expiração de uma chave existente;
- padronizar nomes de chaves utilizadas por sistemas internos;
- executar rotação ou manutenção de credenciais de subcontas;
- corrigir uma chave criada com nome ou expiração incorreta;
- controlar o acesso de integrações vinculadas a subcontas.
Esse endpoint é especialmente útil para parceiros, plataformas White Label, marketplaces, ERPs e operações BaaS que gerenciam múltiplas subcontas e precisam manter as credenciais organizadas e seguras.
Quando não utilizar
Não utilize este endpoint para:
- criar uma nova chave de API;
- excluir ou revogar definitivamente uma chave;
- listar chaves existentes de uma subconta;
- atualizar dados cadastrais da subconta;
- alterar permissões de uma chave fora dos campos aceitos;
- recuperar o valor da chave de API já criada.
Caso precise criar uma nova chave, utilize o endpoint de criação de chave de API para subconta.
Caso precise remover definitivamente uma chave, utilize o endpoint de exclusão ou revogação de chave de API.
Requisitos de acesso
Por se tratar de uma operação sensível, este endpoint possui requisitos específicos de segurança.
Atenção
- Esse endpoint necessita de liberação via interface Web. Para mais detalhes sobre a liberação, acesse o guia sobre gerenciamento das chaves de API de subcontas.
- Ele só pode ser acessado por seu sistema e caso você tenha a configuração de Whitelist de IPs habilitada.
Antes de chamar este endpoint, verifique se:
- a conta-pai possui subcontas vinculadas;
- o acesso ao gerenciamento de chaves de subcontas foi habilitado na interface Web;
- a chamada está sendo realizada dentro do período de liberação temporária;
- a Whitelist de IPs está habilitada;
- o IP de saída da sua aplicação está autorizado;
- a requisição está autenticada com a chave de API da conta-pai;
- a subconta informada existe e pertence à conta-pai autenticada;
- o
accessTokenIdinformado corresponde a uma chave de API existente da subconta.
Fluxo recomendado
Em uma integração típica, a atualização de chave de API de uma subconta deve seguir o fluxo abaixo:
Habilitar o acesso ao gerenciamento de chaves na interface Web
↓
Garantir que a Whitelist de IPs está habilitada
↓
Listar as chaves de API da subconta
↓
Identificar o accessTokenId da chave que será atualizada
↓
Montar o payload com name, enabled e expirationDate
↓
Enviar a atualização
↓
Validar a resposta da API
↓
Atualizar os controles internos da sua aplicaçãoA atualização depende do accessTokenId. Por isso, antes de chamar este endpoint, liste as chaves da subconta ou utilize o identificador retornado no momento da criação da chave.
Parâmetros de path
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Identificador único da subconta no Asaas. |
accessTokenId | string | Sim | Identificador da chave de API que será atualizada. |
O parâmetro id deve corresponder à subconta vinculada à conta-pai autenticada.
O parâmetro accessTokenId deve corresponder a uma chave de API existente daquela subconta.
Parâmetros do body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da chave de API. |
enabled | boolean | Sim | Indica se a chave de API ficará habilitada. |
expirationDate | date-time | Sim | Data de expiração da chave de API. |
name
nameInforme um nome que facilite a identificação da chave.
Exemplos:
Integração ERP
Integração Checkout
Rotação API - Julho 2026enabled
enabledDefine se a chave ficará habilitada ou desabilitada.
Valores aceitos:
| Valor | Comportamento |
|---|---|
true | A chave permanece habilitada para uso. |
false | A chave fica desabilitada e não deve ser usada em novas requisições. |
Desabilitar uma chave pode interromper integrações que dependem dela. Antes de alterar esse campo para false, confirme se a aplicação já está utilizando outra chave válida.
expirationDate
expirationDateDefine a data e hora de expiração da chave.
Utilize um formato de data e hora compatível com date-time.
Exemplo:
2026-12-31T23:59:59Z
Boa práticaDefina datas de expiração alinhadas à política de segurança da sua operação e monitore a proximidade da expiração para evitar interrupções em integrações críticas.
Exemplo de requisição
curl --request PUT \
--url https://api-sandbox.asaas.com/v3/accounts/acc_000000000001/accessTokens/atk_000000000001 \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'access_token: $ASAAS_PARENT_API_KEY' \
--data '{
"name": "Integração ERP - Subconta",
"enabled": true,
"expirationDate": "2026-12-31T23:59:59Z"
}'
ObservaçãoOs identificadores utilizados no exemplo são ilustrativos.
Utilize o ID real da subconta e o
accessTokenIdretornado pela API.
Exemplo de resposta
{
"id": "atk_000000000001",
"name": "Integração ERP - Subconta",
"enabled": true,
"expirationDate": "2026-12-31T23:59:59Z"
}
ImportanteO exemplo acima é ilustrativo.
Os campos retornados podem variar conforme o formato da resposta da API.
Comportamento da atualização
Ao atualizar uma chave de API de uma subconta:
- a chave permanece associada à mesma subconta;
- o identificador da chave não é alterado;
- o valor secreto da chave não é retornado novamente;
- o endpoint altera apenas os campos enviados no body aceito pela rota;
- alterações no campo
enabledpodem afetar imediatamente integrações que utilizam a chave; - alterações em
expirationDatemodificam o ciclo de vida da chave; - a atualização não cria uma nova chave;
- a atualização não revoga definitivamente a chave.
A chave de API do Asaas é irrecuperável após a criação. Por isso, este endpoint não deve ser usado para tentar consultar o valor secreto da credencial.
Regras de negócio importantes
Ao utilizar este endpoint, considere que:
- a chamada deve ser feita pela conta-pai;
- a subconta deve pertencer à conta-pai autenticada;
- o
accessTokenIddeve pertencer à subconta informada; - o acesso aos endpoints de gerenciamento deve estar habilitado na interface Web;
- a liberação do acesso é temporária;
- a Whitelist de IPs deve estar habilitada;
- o IP de origem da requisição deve estar autorizado;
name,enabledeexpirationDatesão obrigatórios no body;- desabilitar uma chave pode interromper integrações em uso;
- excluir uma chave é diferente de desabilitar uma chave;
- uma chave excluída não pode ser restaurada.
Diferença entre atualizar, desabilitar e excluir
| Ação | O que faz | Quando usar |
|---|---|---|
| Atualizar | Altera nome, status ou data de expiração da chave | Para manutenção e organização da chave |
| Desabilitar | Mantém a chave existente, mas impede seu uso | Para pausas temporárias ou bloqueio preventivo |
| Excluir | Revoga definitivamente a chave | Para remover uma credencial que não deve mais ser utilizada |
AtençãoCaso uma chave seja excluída, ela não poderá ser restaurada.
Se o objetivo for apenas interromper temporariamente o uso da chave, prefira atualizar
enabledparafalse.
Cuidados em operações de rotação de chave
Em cenários de rotação de chave, evite desabilitar a chave antiga antes de confirmar que a nova chave já está em uso pela aplicação.
Fluxo recomendado:
Criar nova chave para a subconta
↓
Armazenar a nova chave com segurança
↓
Atualizar a aplicação para usar a nova chave
↓
Validar chamadas com a nova chave
↓
Desabilitar a chave antiga
↓
Monitorar erros de autenticação
↓
Excluir a chave antiga somente quando não houver mais dependênciaEsse cuidado reduz o risco de indisponibilidade em integrações que dependem da subconta.
Erros comuns
Alguns erros comuns ao utilizar este endpoint incluem:
| Status HTTP | Possível causa | Como corrigir |
|---|---|---|
400 Bad Request | Body inválido, campos obrigatórios ausentes ou data em formato incompatível | Revise name, enabled e expirationDate |
401 Unauthorized | Chave de API inválida, ausente ou pertencente à conta incorreta | Utilize a chave da conta-pai correta |
403 Forbidden | Endpoint sem liberação, Whitelist de IPs ausente ou IP não autorizado | Habilite o acesso pela interface Web e valide a Whitelist |
404 Not found | Subconta ou chave de API não encontrada | Confirme o id da subconta e o accessTokenId |
| Integração parou de autenticar | Chave usada pela aplicação foi desabilitada ou expirou | Reative a chave, ajuste a expiração ou atualize a aplicação para usar outra chave |
| Atualização não refletiu no sistema interno | Base local não foi sincronizada após a chamada | Atualize os controles internos após resposta de sucesso |
Impactos operacionais
A atualização de uma chave de API pode impactar diretamente a disponibilidade da integração da subconta.
Configurações incorretas podem causar:
- interrupção de chamadas autenticadas;
- falhas
401 Unauthorized; - perda temporária de comunicação entre sua aplicação e a subconta;
- expiração inesperada de credenciais;
- dificuldade de rastrear qual sistema utiliza cada chave;
- necessidade de rotação emergencial;
- falhas em fluxos de cobrança, consulta, webhook ou onboarding que dependam da chave atualizada.
Por isso, trate a atualização de chaves como uma operação sensível e registre logs internos de alteração.
Boas práticas
Ao atualizar chaves de API de subcontas, recomenda-se:
- utilizar nomes descritivos para cada chave;
- manter inventário interno de quais sistemas utilizam cada chave;
- evitar desabilitar uma chave sem confirmar que ela não está mais em uso;
- planejar janelas de manutenção para alterações críticas;
- validar a nova configuração em Sandbox antes de aplicar em Produção;
- armazenar chaves em gerenciadores de segredo;
- monitorar erros
401após alterações; - manter a Whitelist de IPs restrita ao menor conjunto possível de endereços;
- evitar intervalos amplos de IPs;
- registrar usuário, sistema, data e motivo da atualização;
- utilizar webhooks de ciclo de vida de chaves, quando aplicável.
Cuidados em Sandbox
Este endpoint pode ser testado em Sandbox.
Recomenda-se validar os seguintes cenários:
- listar chaves de API de uma subconta;
- atualizar o nome de uma chave;
- alterar
enabledparafalse; - tentar utilizar uma chave desabilitada;
- alterar
enabledparatrue; - atualizar a data de expiração;
- testar uma chamada com IP não autorizado;
- testar o comportamento após expiração da liberação temporária.
Esses testes ajudam a definir o comportamento esperado antes da operação em Produção.
Conteúdos relacionados
Consulte também:
- Gerenciamento das chaves de API de subcontas;
- Listar chaves de API de uma subconta;
- Criar chave de API para uma subconta;
- Excluir chave de API de uma subconta;
- Chaves de API;
- Whitelist de IPs;
- Criação de subcontas;
- Autenticação;
- O que pode ser testado em Sandbox.
404Not found
