PUT
/
api
/
v1
/
schools
/
{schoolId}
Editar unidades
curl --request PUT \
  --url https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "contractNumber": "<string>",
  "tags": [
    {}
  ],
  "taxId": "<string>",
  "groups": [
    123
  ],
  "subgroups": [
    123
  ],
  "specialties": [
    123
  ],
  "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

schoolId
string
required
O identificador da unidade a ser editada.
name
string
O nome da unidade a ser editada. Deve ter no máximo 255 caracteres.
contractNumber
string
Número do contrato da unidade. 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, contendo as tags relacionadas à escola.
taxId
string
O CNPJ da unidade. Deve ser um CNPJ válido.
groups
number[]
Array contendo os identificadores dos grupos (Nível 1 de filtros) da instituição.
subgroups
number[]
Array contendo os identificadores dos subgrupos (Nível 2 de filtros) da instituição.
specialties
number[]
Array contendo os identificadores das especialidades (Nível 3 de filtros) da instituição.
colorScheme
object
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
Objeto opcional contendo as configurações da unidade.
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.
Antes de utilizar este endpoint, certifique-se de possuir o ID da unidade a ser editada.

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 é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.