POST
/
api
/
v1
/
schools
curl --request POST \
  --url https://trialprod.app.toolzz.com.br/api/v1/schools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "urlSlug": "<string>",
  "contractNumber": "<string>",
  "tags": [
    {}
  ],
  "groups": [
    {}
  ],
  "subgroups": [
    {}
  ],
  "specialties": [
    {}
  ],
  "taxid": "<string>",
  "colorScheme": {},
  "location": {},
  "features": {}
}'
{
  "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.

​
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.

​
groups
array
required

Array contendo os identificadores de grupos (Nível 1 de filtros) da instituição.

​
subgroups
array

Array contendo os identificadores de subgrupos (Nível 2 de filtros) da instituição.

​
specialties
array

Array contendo os identificadores de especialidades (Nível 3 de filtros) da instituição.

​
taxid
string

O CNPJ da unidade. Deve ser um CNPJ válido.

​
colorScheme
object
required

Objeto contendo os valores das cores a serem utilizadas na unidade.

​
location
object

Objeto opcional contendo os dados de localização da unidade.

​
features
object
required

[Inconsistência] Objeto contendo as configurações da unidade em formato boolean. “enableTeacherRegistration” “enableStudentRegistration” “enableGoogleLogin” “enableLoginByDocument” “enableLoginByEmail” “isPartOfProgram” “enableForum” “enableViewCount” “enableRating” “enableReviews” “showSchoolIconInMenu” “showIconDetails” “replicateInstitutionMenuLinks” “displaySchoolAccessButton”

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.

​
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.