Atualizar área

Este endpoint realiza atualização completa (substituição) de uma área existente, identificada pelo externalCode na URL.


Campos obrigatórios

  • name: Máximo de 300 caracteres.
  • externalCode: Máximo de 50 caracteres. Deve ser único na empresa.
  • similarity: Valor válido de similaridade.

Campos opcionais

  • description: Máximo de 900 caracteres.
  • organizationUnit: Referência ao departamento por uuid e/ou externalCode.
  • costCenter: Referência ao centro de custo por uuid e/ou externalCode.

Validações

  • A área do externalCode na URL deve existir na empresa.
  • Referências aninhadas inválidas retornam 422.

Exemplo de requisição (cURL)

curl --request PUT \
     --url 'https://api.gupy.io/os/v1/areas/external/A-F98' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer bearer_token_value_here' \
     --data '{
       "name": "Produto Digital",
       "externalCode": "A-F98",
       "similarity": "ACCOUNTING",
       "description": "Área de produto",
       "organizationUnit": { "externalCode": "OU-001" },
       "costCenter": { "uuid": "550e8400-e29b-41d4-a716-446655440002" }
     }'

Atenção: Substitua A-F98 pelo código externo da área.

Possíveis erros

Área não encontrada (404)

{ "message": "The area with the provided external code was not found" }

Referência não encontrada (422)

Departamento ou centro de custo informado não existe.