Search docs/

Editar canal de atendimento

{...}

Editar informações do canal de atendimento especificado

PUT https://api.layers.digital/v1/tickets/channels/{channelId}
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota. O app deve estar cadastrado para usar a API com a permissão ticket:manage

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade

Requisição

Especificação

  • nameStringobrigatório

    Nome do canal de atendimento

  • publicBoolean

    Indica se o canal de atendimento aparece para usuários (`true`) ou é interno (`false`)

  • agentsString[ ]

  • subjectsObject[ ]

  • allowAudioBooleanDEFAULTfalse

    Indica se o canal de atendimento aceita receber mensagens de áudio

  • targetsObject

    Quais usuários tem permissão para enviar mensagens para essa canal de atendimento

Exemplo

{
  "name": "Pedagógico",
  "public": true,
  "agents": [
    "5bb2575199d7179dfe85be02"
  ],
  "subjects": [
    {
      "title": "Revisão de provas",
      "description": "Discuta correções e erros de soma de notas"
    }
  ],
  "allowAudio": true,
  "targets": {
    "roles": [
      "guardian"
    ],
    "tags": [
      "5bb2575199d7179dfe85be02"
    ]
  }
}
CopiarCopiado

Resposta

Especificação

  • idString

    Identificador do canal de atendimento

  • nameStringobrigatório

    Nome do canal de atendimento

  • publicBoolean

    Indica se o canal de atendimento aparece para usuários (`true`) ou é interno (`false`)

  • agentsString[ ]

  • subjectsObject[ ]

  • allowAudioBooleanDEFAULTfalse

    Indica se o canal de atendimento aceita receber mensagens de áudio

  • targetsObject

    Quais usuários tem permissão para enviar mensagens para essa canal de atendimento

Exemplo

{
  "id": "5bb2575199d7179dfe85be02",
  "name": "Pedagógico",
  "public": true,
  "agents": [
    "5bb2575199d7179dfe85be02"
  ],
  "subjects": [
    {
      "title": "Revisão de provas",
      "description": "Discuta correções e erros de soma de notas"
    }
  ],
  "allowAudio": true,
  "targets": {
    "roles": [
      "guardian"
    ],
    "tags": [
      "5bb2575199d7179dfe85be02"
    ]
  }
}
CopiarCopiado