Obter um Salesbot pelo ID

Este método permite obter um Salesbot pelo seu ID.

Limitações
O método está disponível para todos os usuários da conta.

Parâmetros "with"

ParâmetroDescrição
favoriteAdiciona a propriedade is_favorite á resposta, que define se o Salesbot foi adicionado aos favoritos do usuário atual.

Cabeçalho do tipo de dado para quando a requisição é bem-sucedida
Content-Type: application/hal+json

Cabeçalho do tipo de dado em casos de erro
Content-Type: application/problem+json

Parâmetros de resposta

ParâmetroTipo de dadoDescrição
idintID do Salesbot
namestringNome do Salesbot
is_visual_editorboolDefine o tipo de editor do Salesbot. true indica que o Salesbot está no modo de edição visual; false indica que o Salesbot está no modo de edição em código/texto.
type_functionalitystringTipo de funcionalidade do Salesbot: regular – Salesbot de fluxo de trabalho básico, greeting – Bot de mensagem de boas-vindas, marketing – Transmissão de mensagens, nps – Bot de pesquisa de NPS.
settingsobjConfigurações do Salesbot.
settings[active]boolDefine se o Salesbot está ativo.
is_favoriteboolNecessária definição no parâmetro with. Define se o Salesbot foi adicionado aos favoritos.

Path Params
integer
required

ID do Salesbot

Query Params
string

Este parâmetro aceita uma string que pode consistir de vários valores separados por vírgulas.

Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
text/html
application/problem+json