API Reference

Criar Categoria

Cria uma categoria para ser inserido na criação de um agendamento

Exemplo do Corpo da Requisição

A requisição deve incluir um JSON no corpo (body) com os seguintes campos:

{
    "categoryGroupId": "fe57d34d-9127-4f1e-bf52-f4d0789d9b59",
    "name": "Categoria de entrada subgrupo X",
    "type": "in",
    "subGroupId": "4e067e3f-9601-4a6c-8c2e-1757b96b2398" //opcional
}

Observação:

  • O campo categoryGroupId é obrigatório e deve ser preenchido com o identificador de um grupo de categorias. Para encontrar o valor correto do categoryGroupId, consulte a lista de grupos de categorias.
  • O campo subGroupId é opcional e deve ser preenchido apenas se a categoria que está sendo criada pertencer a um subgrupo. Para encontrar o valor correto do subGroupId, consulte a lista da hierarquia das categorias. Na resposta da consulta, procure por objetos que contenham a propriedade "isSubgroup": true.
  • O valor do campo "id" desse objeto será o identificador que deve ser usado como subGroupId no body da requisição.

Exemplo de resposta da hierarquia das categorias

{
    "id": "4e067e3f-9601-4a6c-8c2e-1757b96b2398",
    "name": "subgrupo",    
    "isSubgroup": true
	   ...
}

Nesse exemplo, o valor 4e067e3f-9601-4a6c-8c2e-1757b96b2398 seria o subGroupId a ser utilizado.

Language
Authorization
Header
Click Try It! to start a request and see the response here!