Skip to content

Cria um novo assunto

Request

Cria um novo assunto associado à cidade do tenant identificado pela API Key. Para keys com permissionLevel support, o campo cityId deve ser informado no body.

Opcionalmente semeia conteúdo já na criação com config, form e/ou step — sem eles, um formulário grande só tinha o caminho cria vazio + edita, e o type/edit é REPLACE total da raiz.

  • config faz MERGE sobre o template do modelo: mande só o que quer definir (title, sigla, templates, …). O cidade dentro do config é ignorado — quem decide é o cidade do topo do body.
  • form (área externa) substitui o stepper vazio do template.
  • step define o fluxo de etapas do assunto.
Security
InternalAuth
Bodyapplication/jsonrequired
modelonumberrequired

Modelo do assunto

Example:0
cidadestring^[a-zA-Z]required

Slug da cidade (ex. saopaulosp). Deve começar com letra

Example:"saopaulosp"
cityIdnumber

ID numérico da cidade. Obrigatório para keys support; ignorado para tenant (extraído automaticamente da API Key).

Example:138
configobject

Config do assunto. Faz MERGE sobre o template do modelo — mande só o que quer definir. O cidade daqui é ignorado

formArray of objects

Formulário (área externa) completo. Substitui o stepper vazio do template

stepobject

Fluxo de etapas do assunto

POST
/hub-api/type/create
curl -i -X POST \
  https://api.producao.aprova.com.br/hub-api/type/create \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "modelo": 0,
    "cidade": "saopaulosp",
    "config": {
      "title": "Alvará de Construção",
      "sigla": "ALV"
    },
    "form": [],
    "step": {
      "config": []
    }
  }'

Responses

Assunto criado com sucesso

Bodyapplication/json
_idstring
Example:"69aae29b8f070e4432a63036"
configobject
formArray of objects
stepobject

Fluxo de etapas do assunto, como ficou após a criação

createdAtstring
Example:"2026-01-15T10:30:00.000Z"
property name*anyadditional property
Response
{
  "_id": "69aae29b8f070e4432a63036",
  "config": {
    "title": "Titulo novo assunto",
    "descricao": "Descrição",
    "cidade": "saopaulosp",
    "approveActionText": "Deferir",
    "markdown": "Acesse a aba Resumo para verificar o andamento do seu processo",
    "sigla": "NEW",
    "templates": [],
    "form_tramites": [],
    "fluxograma": { … },
    "tenance": "Geral",
    "devolverAoUltimo": true
  },
  "form": [
    { … }
  ],
  "createdAt": "2026-03-06T00:00:00.000Z"
}