CategoriasAtualizar nome da categoria

Atualizar nome da categoria

Renomeia uma categoria da empresa autenticada. Apenas o campo name é atualizado; os estabelecimentos vinculados e o tipo da categoria permanecem inalterados. O novo nome deve ser único entre as categorias existentes da empresa.

curl -X PATCH "https://api-sandbox.contasimples.com/categories/v1/categories/1146" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "Eletrônicos"
}'
{
  "id": 1146,
  "createdAt": "2025-03-18T12:11:36.957Z",
  "updatedAt": "2026-06-11T10:00:00.000Z",
  "companyId": "7c61b3f6-7353-46aa-80ef-3e27d95150ab",
  "name": "Eletrônicos",
  "establishments": [],
  "type": {
    "id": 1,
    "createdAt": "2025-03-18T12:11:36.957Z",
    "updatedAt": "2025-03-18T12:11:36.957Z",
    "type": "CUSTOM"
  }
}
PATCH
/categories/v1/categories/{id}
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
path
idinteger
Required

Identificador numérico da categoria.

Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

Novo nome da categoria.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}

Path Parameters

idinteger
Required

Identificador numérico da categoria.

Example:
1146

Body

application/json
namestring
Required

Novo nome da categoria.

Example:
Eletrônicos

Responses

idinteger
Required

Identificador numérico da categoria.

createdAtstring
Required

Data e hora de criação da categoria (ISO 8601).

updatedAtstring
Required

Data e hora da última atualização da categoria (ISO 8601).

companyIdstring
Required

Identificador da empresa proprietária da categoria.

namestring
Required

Nome completo ou código contábil exibido da categoria.

establishmentsarray
Required

Lista de estabelecimentos associados a esta categoria, com vínculo e tipo.

typestring
Required

Metadados do tipo da categoria (por exemplo, CUSTOM ou DEFAULT).