Skip to main content
POST
Criar a custom filter

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

account_id
integer
obrigatório

O ID numérico da conta

Parâmetros de consulta

filter_type
enum<string>

O tipo de filtro personalizado

Opções disponíveis:
conversation,
contact,
report

Corpo

application/json
name
string

O nome do filtro personalizado

Exemplo:

"My Custom Filter"

type
enum<string>

A descrição sobre o filtro personalizado

Opções disponíveis:
conversation,
contact,
report
Exemplo:

"conversation"

query
object

Uma consulta que precisa ser salva como um filtro personalizado

Exemplo:

Resposta

Sucesso

id
number

O ID do filtro personalizado

name
string

O nome do filtro personalizado

type
enum<string>

A descrição sobre o filtro personalizado

Opções disponíveis:
conversation,
contact,
report
query
object

Uma consulta que precisa ser salva como um filtro personalizado

created_at
string<date-time>

O horário em que o filtro personalizado foi criado

updated_at
string<date-time>

O horário em que o filtro personalizado foi atualizado