Site da NuvidioAntiga documentação
Referência de API

Editar departamento

Permite atualizar os dados de um departamento existente com base nas informações fornecidas na requisição enviada.

📌 Por que editar um departamento?


Essencial para manter os dados atualizados de um departamento.

  • Ajuste de dados.
  • Melhoria de organização dos departamentos.

🔗 Endpoint:


Método: PUT

URL: https://api.nuvidio.com/v1/api/department/:id

🔎 Parâmetros da URL:


ParâmetroTipoObrigatórioDescrição
:idstring✅ID do departamento a ser editado

📦 Corpo da Requisição:


{
  "id": "6112a89e34a436171f05be96",
  "name": "Novo departamento",
  "identifier": "novo-departamento",
  "disabled": false,
  "disabledContent": {
    "title": "titulo",
    "message": "mensagem",
    "action": {
      "type": {
        "link": "https://nuvidio.com.br/contato",
        "text": "Clique aqui para enviar uma mensagem"
      }
    }
  },
  "businessTime": {
    "timezone": -3,
    "monday": [
      {
        "opening": 540,
        "closing": 1080
      }
    ],
    "tuesday": [
      {
        "opening": 540,
        "closing": 1080
      }
    ],
    "wednesday": [
      {
        "opening": 540,
        "closing": 1080
      }
    ],
    "thursday": [
      {
        "opening": 540,
        "closing": 1080
      }
    ],
    "friday": [
      {
        "opening": 540,
        "closing": 1080
      }
    ]
  },
  "address": {
    "line1": "Av. Amazonas - 200",
    "line2": "Apt. 500",
    "district": "Centro",
    "city": "Belo Horizonte",
    "state": "MG",
    "countryCode": "BR",
    "postalCode": "30120050",
    "location": {
      "type": "Point",
      "coordinates": [-1947875241, 208715658]
    }
  },
  "settings": {
    "allowMissedCalls": true,
    "blockDirectLink": false,
    "record": "full",
    "showAccessLink": false,
    "blockWorkOvertime": false,
    "scheduleConfigs": {
      "behindScheduleText": ""
    }
  },
  "style": {
    "logo": "https://www.nuvidio.com.br/wp-content/uploads/2020/06/nuvidio_horizontal_positivo-768x324.png",
    "colors": {
      "primary": "#bcb3b3",
      "secondary": "#ff9500",
      "background": "#ff9500"
    },
    "videos": {
      "intro": "https://youtube.com/watch?v=ase231S12df",
      "queue": "https://youtube.com/watch?v=ase231S12df"
    },
    "font": "Segoe UI",
    "fontSize": 10,
    "borderRadius": 10,
    "textColor": "#ff9500"
  }
}

🔎 Parâmetros da Requisição:


ParâmetroTipoObrigatórioDescrição
namestring✅Nome do departamento
identifierstring✅Identificador único usado na integração
disabledboolean❌Ativa ou desativa o departamento
disabledContentobjeto❌Conteúdo exibido quando o departamento estiver desativado
businessTimeobjeto❌Horário de funcionamento por dia da semana
addressobjeto❌Endereço do departamento (linha, cidade, coordenadas etc.)
settings.allowMissedCallsboolean❌Permite visualização de chamadas perdidas
settings.blockDirectLinkboolean❌Bloqueia acesso via link direto (apenas via integração)
settings.recordstring❌Gravação de chamadas (full, partial, disabled)
settings.showAccessLinkboolean❌Exibe link de acesso ao departamento
settings.blockWorkOvertimeboolean❌Bloqueia funcionamento fora do expediente
styleobjeto❌Personalização visual (logo, cores, vídeos etc.)

⚠️

O campo identifier deve ser único. Caso já exista um departamento com o mesmo identificador, a requisição será rejeitada.

🎥 Valores para settings.record:


ValorDescrição
fullTodas as chamadas são gravadas
partialAtendente escolhe quando iniciar a gravação e pausar durante a chamada
disabledGravação desativada

✅ Exemplo de Resposta:


{
  "id": "6112a89e34a436171f05be96",
  "name": "Novo departamento",
  "identifier": "novo-departamento",
  "disabled": true,
  "disabledContent": {
    "title": "titulo",
    "message": "mensagem",
    "action": {
      "link": "https://nuvidio.com.br/contato",
      "text": "Clique aqui para enviar uma mensagem"
    }
  },
  "businessTime": {
    "timezone": -3,
    "monday": [{ "opening": 540, "closing": 1080 }],
    "tuesday": [{ "opening": 540, "closing": 1080 }],
    "wednesday": [{ "opening": 540, "closing": 1080 }],
    "thursday": [{ "opening": 540, "closing": 1080 }],
    "friday": [{ "opening": 540, "closing": 1080 }]
  },
  "address": {
    "line1": "Av. Amazonas - 200",
    "line2": "Apt. 500",
    "district": "Centro",
    "city": "Belo Horizonte",
    "state": "MG",
    "countryCode": "BR",
    "postalCode": "30120050",
    "location": {
      "type": "Point",
      "coordenates": [-19.9197907, -43.939615]
    }
  },
  "settings": {
    "allowMissedCalls": true,
    "blockDirectLink": false,
    "record": "full",
    "showAccessLink": false,
    "blockWorkOvertime": false,
    "scheduleConfigs": {
      "behindScheduleText": ""
    }
  },
  "style": {
    "logo": "https://www.nuvidio.com.br/wp-content/uploads/2020/06/nuvidio_horizontal_positivo-768x324.png",
    "colors": {
      "primary": "#bcb3b3",
      "secondary": "#ff9500",
      "background": "#ff9500"
    },
    "videos": {
      "intro": "https://youtube.com/watch?v=ase231S12df",
      "queue": "https://youtube.com/watch?v=ase231S12df"
    },
    "font": "Segoe UI",
    "fontSize": 10,
    "borderRadius": 10,
    "textColor": "#ff9500"
  },
}

❌ Respostas de Erro:


CódigoMensagem
404Departamento não encontrado
409Identificador já em uso
500Erro interno

💡

Ainda não criou um departamento? Clique aqui para informações de como criá-lo.