Skip to main content
POST
/
api
/
v1
/
schools
Criar Unidades
curl --request POST \
  --url https://endtest.app.toolzz.com.br/api/v1/schools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "urlSlug": "<string>",
  "groups": [
    123
  ],
  "subgroups": [
    123
  ],
  "specialties": [
    123
  ],
  "colorScheme": {
    "primary": "<string>",
    "secondary": "<string>",
    "buttonText": "<string>"
  },
  "location": {
    "street": "<string>",
    "number": "<string>",
    "district": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>"
  },
  "features": {
    "enableTeacherRegistration": true,
    "enableStudentRegistration": true,
    "enableGoogleLogin": true,
    "enableLoginByDocument": true,
    "enableLoginByEmail": true,
    "isPartOfProgram": true,
    "enableForum": true,
    "enableViewCount": true,
    "enableRating": true,
    "enableReviews": true,
    "showSchoolIconInMenu": true,
    "showIconDetails": true,
    "replicateInstitutionMenuLinks": true,
    "displaySchoolAccessButton": true
  },
  "contractNumber": "<string>",
  "tags": [
    {}
  ],
  "taxid": "<string>"
}'
{
  "success": true,
  "data": {
    "id": 123,
    "name": "<string>",
    "urlSlug": "<string>",
    "contractNumber": "<string>",
    "tags": [
      {}
    ],
    "taxId": "<string>",
    "groups": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "subgroups": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "specialties": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "colorScheme": {
      "primary": "<string>",
      "secondary": "<string>",
      "buttonText": "<string>"
    },
    "social": {
      "facebook": "<string>",
      "youtube": "<string>",
      "instagram": "<string>"
    },
    "location": {
      "street": "<string>",
      "number": "<string>",
      "additionalDetails": "<string>",
      "district": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>"
    },
    "features": {
      "enableTeacherRegistration": true,
      "enableStudentRegistration": true,
      "enableGoogleLogin": true,
      "enableLoginByDocument": true,
      "enableLoginByEmail": true,
      "enableForum": true,
      "enableViewCounter": true,
      "enableRating": true,
      "isPartOfProgram": true,
      "enableReviews": true,
      "showSchoolIconInMenu": true,
      "showIconDetails": true,
      "replicateInstitutionMenuLinks": true,
      "displaySchoolAccessButton": true
    },
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

​
Parâmetros

​
name
string
required
O nome da unidade a ser criada. Deve conter no máximo 255 caracteres.
​
urlSlug
string
required
URL da unidade. Deve ser um valor único, em um formato de URL válido, com no máximo 255 caracteres.
​
groups
number[]
required
Array contendo os identificadores de grupos (Nível 1 de filtros) da instituição.
​
subgroups
number[]
Array contendo os identificadores de subgrupos (Nível 2 de filtros) da instituição.
​
specialties
number[]
Array contendo os identificadores de especialidades (Nível 3 de filtros) da instituição.
​
colorScheme
object
required
Objeto contendo os valores das cores a serem utilizadas na unidade.
​
primary
string
required
Cor primária da identidade visual da unidade, geralmente utilizada como cor de destaque.
​
secondary
string
required
Cor secundária complementar da identidade visual da unidade.
​
buttonText
string
required
Cor do texto exibido em botões da interface.
​
location
object
required
Objeto opcional contendo os dados de localização da unidade.
​
street
string
required
Nome da rua onde a unidade está localizada.
​
number
string
required
Número do endereço da unidade.
​
district
string
required
Bairro onde a unidade está localizada.
​
city
string
required
Cidade onde a unidade está localizada.
​
state
string
required
Estado (UF) onde a unidade está localizada.
​
zipCode
string
required
Código postal (CEP) do endereço da unidade.
​
features
object
[Inconsistência] Objeto contendo as configurações da unidade em formato boolean.
​
enableTeacherRegistration
boolean
Ativa ou desativa a opção de cadastro de professores na unidade.
​
enableStudentRegistration
boolean
Ativa ou desativa a opção de cadastro de alunos na unidade.
​
enableGoogleLogin
boolean
Ativa ou desativa o login por conta Google.
​
enableLoginByDocument
boolean
Ativa ou desativa o login utilizando número de documento.
​
enableLoginByEmail
boolean
Ativa ou desativa o login por e-mail.
​
isPartOfProgram
boolean
Indica se a unidade pertence a um programa institucional específico.
​
enableForum
boolean
Ativa ou desativa a funcionalidade de fórum na unidade.
​
enableViewCount
boolean
Ativa ou desativa a contagem de visualizações de conteúdos.
​
enableRating
boolean
Ativa ou desativa a funcionalidade de avaliação (nota) de conteúdos.
​
enableReviews
boolean
Ativa ou desativa a possibilidade de comentários ou resenhas.
​
showSchoolIconInMenu
boolean
Exibe ou oculta o ícone da escola no menu de navegação.
​
showIconDetails
boolean
Exibe ou oculta detalhes visuais dos ícones associados à escola.
​
replicateInstitutionMenuLinks
boolean
Ativa ou desativa a replicação dos links do menu institucional.
​
displaySchoolAccessButton
boolean
Exibe ou oculta o botão de acesso direto à unidade escolar.
​
contractNumber
string
Número do contrato. Deve ser um valor único, com no máximo 50 caracteres.
​
tags
array
Deve ser um array de strings, com no máximo 10 elementos.
​
taxid
string
O CNPJ da unidade. Deve ser um CNPJ válido.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
  • Nome da unidade obrigatório: Defina um nome para a sua unidade.
  • Slug da URL obrigatório: Necessário caso a busca seja realizada pelo slug.
  • Grupos obrigatório: ID do(s) grupo(s) da instituição a serem vinculados a essa unidade.
  • Esquema de cores da unidade obrigatório: Defina os valores em hexadecimal para as cores primária, secundária e da fonte dos botões.
  • Configurações da unidade obrigatório: Defina quais são os parâmetros essenciais para a sua unidade de aprendizado.

​
Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.
​
success
boolean
Indica se a solicitação foi bem-sucedida.
Este endpoint funcionará corretamente apenas se o domínio da sua instituição for informado manualmente na URL, caso contrário, o endpoint poderá falhar ou retornar um erro de validação.
​
data
object
Detalhes da unidade educacional.

​
Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API conta com outras medidas de segurança para proteger os dados dos usuários.