Editar unidades

curl --request PUT \
  --url https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "contractNumber": "<string>",
  "tags": [
    {}
  ],
  "taxId": "<string>",
  "groups": [
    123
  ],
  "subgroups": [
    123
  ],
  "specialties": [
    123
  ],
  "colorScheme": {},
  "location": {},
  "features": {}
}
'

import requests

url = "https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}"

payload = {
    "name": "<string>",
    "contractNumber": "<string>",
    "tags": [{}],
    "taxId": "<string>",
    "groups": [123],
    "subgroups": [123],
    "specialties": [123],
    "colorScheme": {},
    "location": {},
    "features": {}
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    contractNumber: '<string>',
    tags: [{}],
    taxId: '<string>',
    groups: [123],
    subgroups: [123],
    specialties: [123],
    colorScheme: {},
    location: {},
    features: {}
  })
};

fetch('https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'contractNumber' => '<string>',
    'tags' => [
        [
                
        ]
    ],
    'taxId' => '<string>',
    'groups' => [
        123
    ],
    'subgroups' => [
        123
    ],
    'specialties' => [
        123
    ],
    'colorScheme' => [
        
    ],
    'location' => [
        
    ],
    'features' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"contractNumber\": \"<string>\",\n  \"tags\": [\n    {}\n  ],\n  \"taxId\": \"<string>\",\n  \"groups\": [\n    123\n  ],\n  \"subgroups\": [\n    123\n  ],\n  \"specialties\": [\n    123\n  ],\n  \"colorScheme\": {},\n  \"location\": {},\n  \"features\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"contractNumber\": \"<string>\",\n  \"tags\": [\n    {}\n  ],\n  \"taxId\": \"<string>\",\n  \"groups\": [\n    123\n  ],\n  \"subgroups\": [\n    123\n  ],\n  \"specialties\": [\n    123\n  ],\n  \"colorScheme\": {},\n  \"location\": {},\n  \"features\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"contractNumber\": \"<string>\",\n  \"tags\": [\n    {}\n  ],\n  \"taxId\": \"<string>\",\n  \"groups\": [\n    123\n  ],\n  \"subgroups\": [\n    123\n  ],\n  \"specialties\": [\n    123\n  ],\n  \"colorScheme\": {},\n  \"location\": {},\n  \"features\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
  }
}

PUT

api

schools

{schoolId}

Editar unidades

curl --request PUT \
  --url https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "contractNumber": "<string>",
  "tags": [
    {}
  ],
  "taxId": "<string>",
  "groups": [
    123
  ],
  "subgroups": [
    123
  ],
  "specialties": [
    123
  ],
  "colorScheme": {},
  "location": {},
  "features": {}
}
'

import requests

url = "https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}"

payload = {
    "name": "<string>",
    "contractNumber": "<string>",
    "tags": [{}],
    "taxId": "<string>",
    "groups": [123],
    "subgroups": [123],
    "specialties": [123],
    "colorScheme": {},
    "location": {},
    "features": {}
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    contractNumber: '<string>',
    tags: [{}],
    taxId: '<string>',
    groups: [123],
    subgroups: [123],
    specialties: [123],
    colorScheme: {},
    location: {},
    features: {}
  })
};

fetch('https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'contractNumber' => '<string>',
    'tags' => [
        [
                
        ]
    ],
    'taxId' => '<string>',
    'groups' => [
        123
    ],
    'subgroups' => [
        123
    ],
    'specialties' => [
        123
    ],
    'colorScheme' => [
        
    ],
    'location' => [
        
    ],
    'features' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"contractNumber\": \"<string>\",\n  \"tags\": [\n    {}\n  ],\n  \"taxId\": \"<string>\",\n  \"groups\": [\n    123\n  ],\n  \"subgroups\": [\n    123\n  ],\n  \"specialties\": [\n    123\n  ],\n  \"colorScheme\": {},\n  \"location\": {},\n  \"features\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"contractNumber\": \"<string>\",\n  \"tags\": [\n    {}\n  ],\n  \"taxId\": \"<string>\",\n  \"groups\": [\n    123\n  ],\n  \"subgroups\": [\n    123\n  ],\n  \"specialties\": [\n    123\n  ],\n  \"colorScheme\": {},\n  \"location\": {},\n  \"features\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://endtest.app.toolzz.com.br/api/v1/schools/{schoolId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"contractNumber\": \"<string>\",\n  \"tags\": [\n    {}\n  ],\n  \"taxId\": \"<string>\",\n  \"groups\": [\n    123\n  ],\n  \"subgroups\": [\n    123\n  ],\n  \"specialties\": [\n    123\n  ],\n  \"colorScheme\": {},\n  \"location\": {},\n  \"features\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "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

string

required

O identificador da unidade a ser editada.

string

O nome da unidade a ser editada. Deve ter no máximo 255 caracteres.

string

Número do contrato da unidade. Deve ser um valor único, com no máximo 50 caracteres.

array

Deve ser um array de strings com no máximo 10 elementos, contendo as tags relacionadas à escola.

string

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

number[]

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

number[]

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

number[]

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

object

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

object

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

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.

boolean

Indica se a solicitação foi bem-sucedida.

object

Detalhes da unidade educacional.

Show properties

number

Identificador único da unidade.

string

Nome da unidade.

string

Slug da URL da unidade.

string

Número do contrato associado à unidade.

array

Lista de tags associadas à unidade.

string

Número de identificação fiscal (CNPJ).

array

Lista de grupos associados à unidade.

Show items

number

Identificador único do grupo.

string

Nome do grupo.

array

Lista de subgrupos associados à unidade.

Show items

number

Identificador único do subgrupo.

string

Nome do subgrupo.

array

Lista de especialidades associadas à unidade.

Show items

number

Identificador único da especialidade.

string

Nome da especialidade.

object

Configuração do esquema de cores.

Show properties

string

Código da cor primária.

string

Código da cor secundária.

string

Código da cor do texto dos botões.

Informações de redes sociais.

Show properties

string

Identificador do perfil do Facebook.

string

Identificador do canal do YouTube.

string

Identificador do perfil do Instagram.

object

Detalhes de localização da unidade.

Show properties

string

Nome da rua.

string

Número da rua.

string

Detalhes adicionais sobre a localização.

string

Nome do bairro.

string

Nome da cidade.

string

Abreviação do estado.

string

Código postal (CEP).

object

Funcionalidades habilitadas para a unidade.

Show properties

boolean

Indica se o cadastro de professores está habilitado.

boolean

Indica se o cadastro de alunos está habilitado.

Indica se o login via Google está habilitado.

Indica se o login por documento está habilitado.

Indica se o login por e-mail está habilitado.

boolean

Indica se os fóruns estão habilitados.

boolean

Indica se o contador de visualizações está habilitado.

boolean

Indica se a funcionalidade de avaliação está habilitada.

boolean

Indica se a unidade faz parte de um programa.

boolean

Indica se as avaliações estão habilitadas.

Indica se o ícone da escola será exibido no menu.

boolean

Indica se os detalhes do ícone serão exibidos.

Indica se os links do menu da instituição serão replicados.

boolean

Indica se o botão de acesso à escola será exibido.

string

Data e hora de criação da unidade.

string

Data e hora da última atualização da unidade.

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.

Toolzz LMS API reference

Webhooks

Editar unidades

Parâmetros

Descrição da Resposta

Segurança

​Parâmetros

​Descrição da Resposta

​Segurança

Parâmetros

Descrição da Resposta

Segurança