Criando Instância
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Um apelido opcional para sua instância, usado apenas para sua organização.
64
"Bot SDR"
Um identificador único opcional de pesquisa que permite associar sua instância a uma estrutura de dados específica. A Zapster API não utiliza esse dado internamente; ele serve exclusivamente para facilitar consultas na API, permitindo localizar registros mais rapidamente por meio deste parâmetro de pesquisa.
36
"ins_8j7wlxmpjlixx9mux5"
Um conjunto de informações adicionais armazenadas como chave e valor. Cada chave é um texto e o valor pode ser um número ou um texto. Esse campo é opcional e pode ser usado para guardar detalhes personalizados.
{
"customer_id": "123456",
"customer_name": "Joãozinho"
}
Objeto opcional de configurações da sua instância.
Lista de webhooks serão criados assim que a instância finalizar sua criação. Atente-se para a quantidade de webhooks nesta lista, a mesma é baseada no seu plano contratado.
Response
Estrutura de uma instância registrada na API.
Data e hora de criação da instância no formato ISO 8601.
"2024-10-03T21:56:22.620Z"
Identificador único da instância.
"xy9rexnkwobmgg3tehgvs"
Metadados adicionais armazenados como chave e valor.
{
"customer_id": "123456",
"customer_name": "Joãozinho"
}
Nome da instância.
"MyNewInstance2"
Informações sobre o proprietário da instância.
Objeto opcional de configurações da sua instância.
Status atual da instância
connected
, disconnected
, offline
"disconnected"
Lista de webhooks configurados para esta instância.
Configuração de um webhook associado à instância.
QR Code da instância, caso disponível.
null
Identificador de pesquisa criado anteriormente.
"ins_8j7wlxmpjlixx9mux5"