Atualizar subconta
PATCH
/api/subaccounts/{{subaccount_id}}
Autenticação
subaccounts:write. Sem a flag → 404.Atualizar subconta
subaccounts:writename e phone são mutáveis. taxId é imutável (não está no schema — qualquer valor enviado é silenciosamente ignorado). email e correlationId também não são editáveis por esta rota.Body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | não | 2–100 chars. |
phone | string | não | 10–11 dígitos, apenas números. |
Envie ao menos um dos dois. Campos ausentes não são alterados.
Resposta
200 OK com { subaccount: { id, name, phone } }.Erros
| HTTP | Quando |
|---|---|
| 400 | Body inválido (nome curto, telefone fora do padrão). |
| 401 | API key ausente/inválida. |
| 403 | Escopo subaccounts:write ausente. |
| 404 | Sem a flag, subconta inexistente/de outro master/soft-deletada. |
Exemplo cURL
Requisição
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff --request PATCH '/api/subaccounts/{{subaccount_id}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Loja do João Comércio LTDA",
"phone": "11988887777"
}'Response Response Example
200 - Sucesso (200)
{
"subaccount": {
"id": "{{subaccount_id}}",
"name": "Loja do João Comércio LTDA",
"phone": "11988887777"
}
}Modificado em 2026-07-02 06:57:27