API docs by Redocly

Notificacoes Inteligentes (0.1.0)

Download OpenAPI specification:Download

Email para contato: [email protected]

Email para suporte: suporte@notificacoesinteligentes.com

API do Notificações Inteligentes para controle das integrações.

Autorização & Autenticação

A autenticação é realizada através do método Bearer Token, utilizando a chave de API do usuário. Para mais detalhes sobre a chave de API acesse nossa documentação

Toda requisição precisa ter o header Accept:

Accept: application/json

Para mais detalhes sobre os eventos da API, assista o video abaixo ou clique aqui

Como sei que deu certo?

Acompanhe a tela de estatísticas da sua integração. Nela, temos todos os envios diários.

Caso não saiba onde fica essa tela, acesse este artigo para saber como verificar as estatísticas.

Já fiz tudo, e agora?

Se não houver nenhum envio depois de um tempo, verifique se a sua integração está conectada a uma instância.

Recomendamos que você:

  1. NÃO tente testar manualmente os webhooks da integração. A operação pode causar grandes problemas caso passe algum telefone incorreto ou com falta de dados;
  2. NÃO tente enviar uma notificação para o mesmo número de telefone que faz os envios. A operação não dá certo, ok?

Teste de endpoint

Sempre que for fazer algum teste utilizando nossos endpoints, recomendamos que altere os valores do Request Body em cada requisição para evitar problemas, pois, não repetimos os payloads.

Too Many Requests

As rotas de eventos das integrações podem receber, no máximo, 60 requisições por minuto.

Padrões de datas da API

Em nossa API existem duas formas de nos fornecer datas:

A primeira forma consiste em nos informar apenas a data Ano-mês-dia, esta forma deve ser usada nos eventos relacionados a Rastreio e Boletos, lembrando que mesmo sem nos fornecer dados como Hora:minuto:segundos, esta data deve estar em Timezone UTC +0

"created_at": "2020-03-10"

A segunda forma consiste em nos informar a data e o horário Ano-mês-dia Hora:minuto:segundo, esta forma deve ser usada nos demais eventos que utilizam datas, lembrando que esta data e horário devem estar em Timezone UTC +0

"created_at": "2020-03-10 13:26:57"

Opt-out

Ao criar um Opt-Out, o sistema buscará todas as instâncias em comum com as lojas conectadas na instância atual e aplicará o bloqueio do contato em todas elas.

Gerenciamento da conta

Busca endereço

Busca os dados do endereço através do CEP fornecido

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
arrays

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
[ ]

Gerenciamento de Integrações

Lista integrações

Lista todas as integrações

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Cria integração

Cria uma nova integração com os dados fornecidos

Authorizations:
bearer_token
header Parameters
Content-Type
required
string
Value: "application/json"
Accept
required
string
Value: "application/json"
Request Body schema: application/json
name
required
string <= 100 characters

Nome da integração para identificação no painel

platform
required
string (Platform)
Enum: "abmex" "active-campaign" "api-next" "app-max" "asaas" "astronmembers" "azcend" "bagy-checkout-abandoned" "beeviral" "bling-orders-2" "blitzpay" "braavo" "braip" "brasil-na-web" "brevo" "builder-all" "cakto" "calendly" "cartpanda" "climba" "cloudfox" "compra-rapida" "convertize" "convvert" "digital-manager-guru" "dinamize" "dooca" "doppus" "doppus-v3" "ead-plataforma" "eduzz-2" "elementor" "evermart" "e-com-plus" "e-goi" "fidelimax" "fidelizar" "find-my-pack-next" "flexy" "forms-app" "funnel-kit" "galax-pay" "greenn" "growth-machine" "hero-spark" "hopy" "hotmart" "hotmart-v2" "hubla" "hubspot" "infusionsoft" "inter" "irroba" "iset-2" "istpay" "iugu" "jet" "kapsula" "kirvano" "kiwify-2" "lastlink" "lead-lovers" "lpqv" "loja-integrada" "macro" "magazord" "mailchimp" "manychat" "mautic" "member-kit" "monetizze-2" "moovin" "notazz" "nuvem-shop" "omie" "pagali" "pagali-2" "pagar-me-1" "pagar-me-2" "pag-hiper" "paypal" "payt" "pepper" "perfect-pay" "pluga" "prestashop" "rd-station" "saiu-pra-entrega" "shopify-next" "shoppub" "simplo-7" "spedy" "stripe" "thrivecart" "ticto-3" "tiny" "track-co" "tray" "tray-corp" "troquecommerce" "typeform" "via-shop-moda" "vindi" "vnda" "voomp" "vtex" "wapstore" "wbuy" "we-help" "webstore" "wide-pay" "witure" "woocommerce" "woocommerce-cart-abandonment-recovery" "yampi" "yapay" "yever" "zoppy"

Plataforma da integração

Responses

Request samples

Content type
application/json
{
  • "name": "Loja de Doces",
  • "platform": "abmex"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Atualiza integração

Permite a atualização de informações da integração

Authorizations:
bearer_token
path Parameters
store
required
integer
header Parameters
Content-Type
required
string
Value: "application/json"
Accept
required
string
Value: "application/json"
Request Body schema: application/json
name
string <= 100 characters

Nome da integração para identificação no painel

Responses

Request samples

Content type
application/json
{
  • "name": "Loja de Doces"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Mostra integração

Mostra detalhes de uma integração específica

Authorizations:
bearer_token
path Parameters
store
required
integer
query Parameters
append
string
Enum: "setup_fields" "available_events" "checklist"

Usado para anexar atributos à resposta

header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Eventos API

Evento de carrinho abandonado

Cria um novo evento de carrinho abandonado na integração

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object

Dados sobre o checkout

required
object (Customer)

Dados sobre um cliente

required
object

Dados sobre o pedido não concluído

Responses

Request samples

Content type
application/json
{
  • "checkout": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de boleto impresso

Cria um novo evento de boleto impresso na integração

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (BilletOrder)

Dados sobre um pedido com método de pagamento por boleto

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de pedido cancelado

Cria um novo evento de pedido cancelado na integração

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (Order)

Dados básicos necessários para um pedido

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de pedido pago

Cria um novo evento de pedido pago na integração

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (Order)

Dados básicos necessários para um pedido

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de pedido estornado

Cria um novo evento de pedido estornado na integração

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (Order)

Dados básicos necessários para um pedido

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de pedido entregue

Cria um novo evento de pedido entregue

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (ShippingOrder)

Dados básicos necessários para um pedido

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de pedido despachado

Cria um novo evento de pedido que foi despachado para a transportadora

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (ShippingOrder)

Dados básicos necessários para um pedido

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de pedido processando

Cria um novo evento de pedido que está sendo processado (em separação, em processo de embalagem, etc)

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (Order)

Dados básicos necessários para um pedido

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de pacote saiu para entrega

Cria um novo evento de pacote saiu para entrega

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (ShippingOrder)

Dados básicos necessários para um pedido

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de pacote com progresso atualizado

Cria um novo evento de pacote com progresso atualizado

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (ShippingOrder)

Dados básicos necessários para um pedido

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de pacote aguardando retirada

Cria um novo evento de pacote aguardando retirada

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (ShippingOrder)

Dados básicos necessários para um pedido

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de aguardando pagamento

Cria um novo evento de pedido que está aguardando o pagamento ser efetuado

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
object (Address)

Dados sobre o endereço cliente

required
object (Customer)

Dados sobre um cliente

required
object (Order)

Dados básicos necessários para um pedido

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "customer": {
    },
  • "order": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de acesso criado

Cria um novo evento de acesso criado para membros

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
object (Access)

Dados sobre acesso à area de membros dos clientes

required
object (Customer)

Dados sobre um cliente

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento de redefinição de senha

Cria um novo evento de redefinição de senha

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
object (ResetPassword)

Dados sobre à redefinição de senha

required
object (Customer)

Dados sobre um cliente

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento relacionado a nota de recomendação do cliente

Cria um novo evento com a nota referente a disposição do cliente em recomendar algo a terceiros

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
object (Customer)

Dados sobre um cliente

required
object

Dados sobre o Note promoter score

Responses

Request samples

Content type
application/json
{
  • "customer": {
    },
  • "nps": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Evento relacionado a pesquisa de recomendação ao cliente

Cria um novo evento com o link para pesquisa

Authorizations:
bearer_token
header Parameters
Accept
required
string
Value: "application/json"
Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required
object (Customer)

Dados sobre um cliente

required
object

Dados sobre o Note promoter score

Responses

Request samples

Content type
application/json
{
  • "customer": {
    },
  • "nps": {}
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Contatos

Cria um novo contato

Cria um novo contato a conta do usuário

Authorizations:
bearer_token
Request Body schema: application/json
name
required
string or null

Nome do contato

phone
required
string

Número de telefone do contato

email
required
string or null

Email do contato

notes
string or null

Observações atribuídas ao lead

tags
Array of strings

Lista com os nomes das tags

Array of objects

Lista com as variáveis customizadas

Responses

Request samples

Content type
application/json
{
  • "name": "João",
  • "phone": "+5531992284862",
  • "email": "[email protected]",
  • "notes": "Captado via campanhas",
  • "tags": [
    ],
  • "custom_variables": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Lista contatos

Lista os contatos da conta

Authorizations:
bearer_token
query Parameters
limit
integer

Limita a quantidade de itens por página

page
integer

Usado para manipular a paginação da coleção

include
string
Enum: "lists" "lists.source" "tags" "users"

Relacionamentos que podem ser inclusos na requisição

filter[name]
string
Example: filter[name]=João

Filtra por contatos que possuam o nome

filter[phone]
string
Example: filter[phone]=5531912341234

Filtra por contatos que possuam o telefone

filter[email]
string
Example: filter[email][email protected]

Filtra por contatos que possuam o email

filter[tags]
Array of strings
Example: filter[tags]=1

Filtra por contatos que possuam as tags

header Parameters
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Mostra contato

Mostra os dados de um contato da conta

Authorizations:
bearer_token
path Parameters
lead
required
integer

ID do contato

query Parameters
include
string
Enum: "lists" "lists.source" "tags" "users"

Relacionamentos que podem ser inclusos na requisição

header Parameters
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Atualiza um contato

Edita um contato já existente associado ao usuário

Authorizations:
bearer_token
path Parameters
lead
required
integer

ID do contato

header Parameters
Accept
required
string
Value: "application/json"
Request Body schema: application/json
name
string or null

Nome do contato

email
string or null

Email do contato

notes
string or null

Observações atribuídas ao lead

Array of objects

Lista com as variáveis customizadas

Responses

Request samples

Content type
application/json
{
  • "name": "João",
  • "email": "[email protected]",
  • "notes": "Captado via campanhas",
  • "custom_variables": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Exclui contato

Exclui os dados de um contato da conta

Authorizations:
bearer_token
path Parameters
lead
required
integer

ID do contato

header Parameters
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "error": "unauthorized"
}

Adiciona listas à um contato

Adiciona as listas informadas à um contato específico

Authorizations:
bearer_token
path Parameters
lead
required
integer

ID do contato

header Parameters
Accept
required
string
Value: "application/json"
Request Body schema: application/json
lists
required
Array of integers

Lista com os identificadores das listas

Responses

Request samples

Content type
application/json
{
  • "lists": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Remove listas de um contato

Remove as lista informadas de um contato específico

Authorizations:
bearer_token
path Parameters
lead
required
integer

ID do contato

header Parameters
Accept
required
string
Value: "application/json"
Request Body schema: application/json
lists
required
Array of integers

Lista com os identificadores das listas

Responses

Request samples

Content type
application/json
{
  • "lists": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Listas de Contatos

Lista listas de contatos

Lista as listas de contatos da conta

Authorizations:
bearer_token
query Parameters
include
string
Enum: "source" "leadsCount"

Relacionamentos que podem ser inclusos na requisição

append
string
Value: "has_leads"

Propriedades que podem ser inclusas na resposta

filter[name]
string
Example: filter[name]=lista de contatos do whatsapp

Filtra por listas que possuam o nome

filter[type]
string
Example: filter[type]=stream

Filtra pelo tipo da lista

header Parameters
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Mostra lista de contatos

Mostra os dados de uma lista de contatos da conta

Authorizations:
bearer_token
path Parameters
list
required
integer

ID da lista

query Parameters
include
string
Value: "source"

Relacionamentos que podem ser inclusos na requisição

header Parameters
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Atualiza uma lista de leads

Atualiza o nome de uma lista de leads

Authorizations:
bearer_token
path Parameters
list
required
integer

ID da lista

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Lista contatos da lista

Lista os contatos de uma lista específica

Authorizations:
bearer_token
path Parameters
list
required
integer

ID da lista

query Parameters
limit
integer

Limita a quantidade de itens por página

page
integer

Usado para manipular a paginação da coleção

include
string
Enum: "lists" "lists.source"

Relacionamentos que podem ser inclusos na requisição

filter[name]
string
Example: filter[name]=João

Filtra por contatos que possuam o nome

filter[phone]
string
Example: filter[phone]=5531912341234

Filtra por contatos que possuam o telefone

filter[email]
string
Example: filter[email][email protected]

Filtra por contatos que possuam o email

header Parameters
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Adiciona contatos à lista

Adiciona os contato informados para uma lista de contatos específica

Authorizations:
bearer_token
path Parameters
list
required
integer

ID da lista

header Parameters
Accept
required
string
Value: "application/json"
Request Body schema: application/json
leads
required
Array of integers

Lista com os identificadores dos contatos

Responses

Request samples

Content type
application/json
{
  • "leads": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Remove contatos da lista

Remove os contatos informados de uma lista específica

Authorizations:
bearer_token
path Parameters
list
required
integer

ID da lista

header Parameters
Accept
required
string
Value: "application/json"
Request Body schema: application/json
leads
required
Array of integers

Lista com os identificadores dos contatos

Responses

Request samples

Content type
application/json
{
  • "leads": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Variáveis Customizadas

Lista variáveis customizadas

Lista as variáveis customizadas da organização

Authorizations:
bearer_token
query Parameters
filter[slug]
string

Filtra pelo slug da variável customizada

filter[type]
string

Filtra pelo tipo da variável customizada

filter[variable_group_name]
string

Filtra pelo nome do grupo da variável customizada

include
string
Enum: "organization" "author" "lastEditedBy" "variableGroup"

Relacionamentos que podem ser inclusos na requisição

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Cria variável customizada

Cria as variáveis customizadas da organização

Authorizations:
bearer_token
Request Body schema: application/json
name
string
description
required
string
type
required
string
Enum: "email" "text" "cnpj" "cpf" "integer" "numeric" "date" "checkbox" "multi_select" "option_list"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "email"
}

Response samples

Content type
application/json
null

Mostra variável customizada

Mostra a variável customizada da organização

Authorizations:
bearer_token
query Parameters
include
string
Enum: "organization" "author" "lastEditedBy" "variableGroup"

Relacionamentos que podem ser inclusos na requisição

Responses

Response samples

Content type
application/json
null

Atualiza variável customizada

Atualiza as variáveis customizadas

Authorizations:
bearer_token
path Parameters
customVariable
required
string

ID da CustomVariable

Request Body schema: application/json
description
string
options
Array of arrays
group_id
integer

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "options": [ ],
  • "group_id": 0
}

Response samples

Content type
application/json
null

Deleta variável customizada

Deleta as variáveis customizadas

Authorizations:
bearer_token
path Parameters
customVariable
required
string

ID da CustomVariable

Responses

Response samples

Content type
application/json
{
  • "error": "unauthenticated"
}

Grupos de Variáveis Customizadas

Lista grupos

Lista os grupos da organização

Authorizations:
bearer_token
query Parameters
filter[name]
string

Filtra pelo nome do grupo

include
string
Enum: "organization" "author" "lastEditedBy"

Relacionamentos que podem ser inclusos na requisição

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Cria grupo

Cria um grupo para a organização

Authorizations:
bearer_token
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
null

Motra grupo

Mostra um grupo

Authorizations:
bearer_token
query Parameters
include
string
Enum: "organization" "author" "lastEditedBy"

Relacionamentos que podem ser inclusos na requisição

Responses

Response samples

Content type
application/json
null

Atualiza grupo

Atualiza o grupo

Authorizations:
bearer_token
path Parameters
group
required
string

ID do Group

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "organization_id": 2024,
  • "last_edited_by_id": 2024,
  • "author_id": 2024,
  • "name": "Idade",
  • "created_at": "2023-05-0T09:37:00+00:00",
  • "updated_at": "2023-05-0T09:37:00+00:00",
  • "last_edited_by": { },
  • "author": { },
  • "organization": { }
}

Deleta grupo

Deleta um grupo

Authorizations:
bearer_token
path Parameters
group
required
string

ID do Grupo

Responses

Response samples

Content type
application/json
{
  • "error": "unauthenticated"
}