{"info":{"_postman_id":"3f353eef-39fb-4d2d-a764-75c286038928","name":"API Beeviral V2","description":"

Para começar a usar a API da Beeviral, você precisa ter um API Token válido

Você pode obtê-lo em sua conta na plataforma da Beeviral acessando o menu Configurações > Integrações.
\n
A API responde apenas a comunicações seguras HTTPS. Quaisquer solicitações enviadas via HTTP retornam um HTTP 301 Redirect para os recursos HTTPS correspondentes.
\n
A API retorna respostas de solicitação no formato JSON. Quando uma solicitação de API retorna um erro, ela é enviada na resposta JSON como uma chave de erro.
\n

{{baseURL}} : https://account.beeviral.app/api/v2\n\n

Endpoints:

Participant (Participante): POST | GET | PUT | DELETE
\n
Queue (Fila): GET
\n
Recommendation (Indicação): POST | GET | PUT | DELETE
\n
Reward (recompensas): POST | GET
\n

Autenticação

Header

\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
x-token-beeviral	{{token}}

Você precisa incluir o API Token no header de todas as requisições.

Erro de Autenticação

Se o API Token estiver ausente ou inválido, você recebéra um código HTTP 401 Unathorized.

Precisa de ajuda?

Caso você tenha dúvidas, siga nossos tutoriais (Documentação).

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"37977574","collectionId":"3f353eef-39fb-4d2d-a764-75c286038928","publishedId":"2sAXjJ6t5A","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-08-28T15:13:17.000Z"},"item":[{"name":"Participant","item":[{"name":"/Participant","id":"dd3125f7-9ae5-4663-8bc2-a3f5b9b9ef77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"x-token-beeviral","value":"{{token}}","type":"text"}],"url":"{{baseURL}}/Participant","description":"

Retorna os participantes de acordo com o filtro especificado.

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
ID	String	Chave única do participante na beeviral.
CODE	String	Código do participante.
NAME	String	Nome do participante.
EMAIL	String	Email do participante.
PHONE	String	Telefone do participante.
ACTIVE	String	Se o participante está ativo (\"Y\") ou não (\"N\").
COMPANY_SYSTEM	Objeto	ID: id da empresa. CODE: código da empresa. NAME: nome da empresa. Ex: { \"ID\" : \"123\", \"CODE\" : \"abc0101\"`,` `\"NAME\" : \"Empresa X\"` `}`
CREATION	String	Data de criação do participante.
MODIFICATION	String	Data de modificação do participante.
CAMPAIGN	Objeto	ID: id da campanha. CODE: código da campanha. NAME: nome da campanha . SHARE_LINK: link de compartilhamento da campanha. HOME_LINK: home da campanha. Ex: { \"ID\" : \"123\", \"CODE\" : \"abc123\"`,` `\"NAME\" : \"Campanha Teste\",` `\"SHARE_LINK\" : \"www.site.com/campanha\",` `\"HOME_LINK\" : \"aaa.site.com/home\"` `}`
EXTERNAL_ID	String	ID externo do indicado.
ADDITIONAL_FIELD	Objeto * Conforme Tabela 1.1.3 do Recommendation/POST	Objeto contendo os campos adicionais do participante. Ex: { \"FIELD\": \"\", \"VALUE\": \"\" },
ADDITIONAL_INFO	Objeto * Conforme Tabela 1.1.4 do Recommendation/POST	Objeto contendo informações adicionais do participante. Ex: { \"FIELD\": \"\", \"VALUE\": \"\" },
IP	String	Endereço IP da pessoa indicada no momento em que a indicação foi capturada.
REWARD	Objeto	Objeto com as informações da recompensa. Clique aqui para saber mais.
PAGING	Objeto	TOTAL: total de páginas. PAGE: página atual. LIMIT: limite de indicados nessa chamada. RECORDS: quantos indicados foram chamados. Ex: { \"TOTAL\": \"10\", \"PAGE\": \"5\", \"LIMIT\" : \"2\", \"RECORDS\" : \"30\" }
SORT	Objeto	SORT: desc = decrescente. asc = crescente. Ex: { \"SORT\": \"asc\", }

Filter

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
id	String	Chave única do participante na beeviral.
campaign_token	String	Token da campanha (pode ser obtido na aba integrações da campanha)
name	String	Nome do participante
email	String	Email do participante
phone	String	Telefone do participante
ip	String	Endereço IP do participante no momento do cadastro
external_id	String	Identificador externo
bv_id	String	Código identificador único do link de compartilhamento
additional_fields	Objeto * Conforme Tabela 1.1.3 do Recommendation/POST	Objeto contendo os campos adicionais do participante. Ex: { \"FIELD\": \"\", \"VALUE\": \"\" },
include	String	Informações adiconais do participante: Valores possíveis: - REWARD (Recompensas)

Exemplo de chamada:

{{baseURL}}/Participant?limit=3&page=1&sort=desc&include=REWARD&filter={\"email\":\"teste@beeviral.com\",\"additional_fields\":{\"cpf\": \"12345678900\", \"chavePix\":\"chave@pix.com.br\"}}

\n","urlObject":{"path":["Participant"],"host":["{{baseURL}}"],"query":[{"disabled":true,"description":{"content":"

Limite de resultados

\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"

Paginação

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Ordenação:\nCrescente: asc\nDecrescente: desc

\n","type":"text/plain"},"key":"sort","value":""},{"disabled":true,"description":{"content":"

Traz informações adicionais sobre recompensas do participante

\n","type":"text/plain"},"key":"include","value":""},{"disabled":true,"description":{"content":"

Filtro a ser aplicado

\n","type":"text/plain"},"key":"filter","value":""}],"variable":[]}},"response":[{"id":"edd07326-0998-47df-8429-f11d2f423fa2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseURL}}/Participant?filter=&page=0&limit=1&sort=desc","host":["{{baseURL}}"],"path":["Participant"],"query":[{"key":"filter","value":"","description":"Clique aqui para ver a documentação"},{"key":"page","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Result\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"EMAIL\": \"\",\n \"PHONE\": \"\",\n \"ACTIVE\": \"\",\n \"COMPANY_SYSTEM\": {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\"\n },\n \"CREATION\": \"\",\n \"MODIFICATION\": \"\",\n \"COMPANY\": \"\",\n \"CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ],\n \"EXTERNAL_ID\": \"\",\n \"ADDITIONAL_FIELD\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADDITIONAL_INFO\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"IP\": \"\"\n }\n ],\n \"Paging\": {\n \"TOTAL\": \"\",\n \"PAGE\": \"\",\n \"LIMIT\": \"\",\n \"RECORDS\": \"\"\n },\n \"Sort\": {\n \"SORT\": \"\"\n }\n }\n]"},{"id":"e051506b-ef18-4d17-b2c9-95fafc658271","name":"Redirect","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseURL}}/Participant?filter=&page=0&limit=1&sort=desc","host":["{{baseURL}}"],"path":["Participant"],"query":[{"key":"filter","value":"","description":"Clique aqui para ver a documentação"},{"key":"page","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":"desc"}]}},"status":"Found","code":302,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {},\n \"Message\": \"\",\n \"Data\": {\n \"labore_\": {},\n \"Excepteur_12\": {}\n },\n \"InnerException\": {},\n \"StackTrace\": \"\",\n \"HelpLink\": \"\",\n \"Source\": \"\",\n \"HResult\": \"\"\n}"},{"id":"5ebd6206-f41b-4a3a-83a9-62d0ac605da3","name":"BadRequest","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseURL}}/Participant?filter=&page=0&limit=1&sort=desc","host":["{{baseURL}}"],"path":["Participant"],"query":[{"key":"filter","value":"","description":"Clique aqui para ver a documentação"},{"key":"page","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {},\n \"Message\": \"\",\n \"Data\": {\n \"labore_\": {},\n \"Excepteur_12\": {}\n },\n \"InnerException\": {},\n \"StackTrace\": \"\",\n \"HelpLink\": \"\",\n \"Source\": \"\",\n \"HResult\": \"\"\n}"},{"id":"a8207817-9d3d-46be-ad67-c96de205a3b3","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseURL}}/Participant?filter=&page=0&limit=1&sort=desc","host":["{{baseURL}}"],"path":["Participant"],"query":[{"key":"filter","value":"","description":"Clique aqui para ver a documentação"},{"key":"page","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":"desc"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {},\n \"Message\": \"\",\n \"Data\": {\n \"labore_\": {},\n \"Excepteur_12\": {}\n },\n \"InnerException\": {},\n \"StackTrace\": \"\",\n \"HelpLink\": \"\",\n \"Source\": \"\",\n \"HResult\": \"\"\n}"},{"id":"3cc5ad80-0ef3-485b-aa79-6b80390ae14e","name":"NotFound","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseURL}}/Participant?filter=&page=0&limit=1&sort=desc","host":["{{baseURL}}"],"path":["Participant"],"query":[{"key":"filter","value":"","description":"Clique aqui para ver a documentação"},{"key":"page","value":"0"},{"key":"limit","value":"1"},{"key":"sort","value":"desc"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {},\n \"Message\": \"\",\n \"Data\": {\n \"labore_\": {},\n \"Excepteur_12\": {}\n },\n \"InnerException\": {},\n \"StackTrace\": \"\",\n \"HelpLink\": \"\",\n \"Source\": \"\",\n \"HResult\": \"\"\n}"}],"_postman_id":"dd3125f7-9ae5-4663-8bc2-a3f5b9b9ef77"},{"name":"/Participant","id":"278377ff-cf7b-434c-b8c6-f656722bfcc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"x-token-beeviral","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseURL}}/Participant","description":"

Este endpoint é utilizado para criar um participante com as informações fornecidas no body da requisição.

Request Body (tabela 1.0)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
CAMPAIGN_TOKEN	string [required	Token da campanha
PARTICIPANT	Objeto [required] * Conforme Tabela 1.1 desta página	Objeto com as informações do participante.

PARTICIPANT (tabela 1.1)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
NAME	string [required]	Nome do participante.
EMAIL	string [required]	Email do participante.
PHONE	string	Telefone do participante.
COMPANY	string	ID da empresa.
EXTERNAL_ID	string	ID externo do participante.
TYPESENDEMAIL	string	Tipo de e-mail a ser enviado ao participante.
BV_ID	string	BV_ID do participante
ADDITIONAL_FIELDS	Objeto * Conforme Tabela 1.1.3 do Recommendation/POST	Objeto contendo os campos adicionais do participante. Ex: { \"FIELD\": \"\", \"VALUE\": \"\" },
ADDITIONAL_INFO	Objeto * Conforme Tabela 1.1.4 do Recommendation/POST	Objeto contendo as informações adicionais do participante. Ex: { \"FIELD\": \"\", \"VALUE\": \"\" },
ADD_CAMPAIGN	Objeto * Conforme Tabela 1.2 desta página	Objeto contendo as informações das campanhas em que o participante será adicionado.
REMOVE_CAMPAIGN	Objeto * Conforme Tabela 1.3 desta página	Objeto contendo as informações das campanhas em que o participante será removido.

ADD_CAMPAIGN (tabela 1.2)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
ID	String	ID da campanha a ser incluído
CODE	String	Código da campanha
NAME	String	Nome da campanha
SHARE_LINK	String	Link de compartilhamento da campanha
HOME_LINK	String	Página inicial do participante na campanha
BV_ID	String	BV_ID da campanha

Observação:
Ao menos uma destas chaves deve ser inserida: ID ou CODE

REMOVE_CAMPAIGN (tabela 1.3)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
ID	String	ID da campanha a ser removido
CODE	String	Código da campanha
NAME	String	Nome da campanha
SHARE_LINK	String	Link de compartilhamento da campanha
HOME_LINK	String	Página inicial do participante na campanha
BV_ID	String	BV_ID da campanha

Observação:
Ao menos uma destas chaves deve ser inserida: ID ou CODE

Response

A resposta estará no formato JSON com estrutura a seguir:

{\n  \"ID\": \"string\",\n  \"MESSAGE\": \"string\"\n}\n\n

\n","urlObject":{"path":["Participant"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"fd709a6d-0e8f-41bd-994b-27e586b5c84b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CAMPAIGN_TOKEN\": \"\",\n \"PARTICIPANT\": {\n \"NAME\": \"\",\n \"EMAIL\": \"\",\n \"PHONE\": \"\",\n \"COMPANY\": \"\",\n \"EXTERNAL_ID\": \"\",\n \"TYPESENDEMAIL\": \"\",\n \"BV_ID\": \"\",\n \"ADDITIONAL_FIELDS\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADDITIONAL_INFO\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADD_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ],\n \"REMOVE_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseURL}}/Participant"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ID\": \"\",\n \"MESSAGE\": \"\"\n}"},{"id":"df0eb443-2d8d-49c6-ac9b-962d58fc7904","name":"Redirect","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CAMPAIGN_TOKEN\": \"\",\n \"PARTICIPANT\": {\n \"NAME\": \"\",\n \"EMAIL\": \"\",\n \"PHONE\": \"\",\n \"COMPANY\": \"\",\n \"EXTERNAL_ID\": \"\",\n \"TYPESENDEMAIL\": \"\",\n \"BV_ID\": \"\",\n \"ADDITIONAL_FIELDS\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADDITIONAL_INFO\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADD_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ],\n \"REMOVE_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseURL}}/Participant"},"status":"Found","code":302,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {},\n \"Message\": \"\",\n \"Data\": {\n \"labore_\": {},\n \"Excepteur_12\": {}\n },\n \"InnerException\": {},\n \"StackTrace\": \"\",\n \"HelpLink\": \"\",\n \"Source\": \"\",\n \"HResult\": \"\"\n}"},{"id":"73dd6d6e-1923-473e-8ecf-0ed6de448673","name":"BadRequest","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CAMPAIGN_TOKEN\": \"\",\n \"PARTICIPANT\": {\n \"NAME\": \"\",\n \"EMAIL\": \"\",\n \"PHONE\": \"\",\n \"COMPANY\": \"\",\n \"EXTERNAL_ID\": \"\",\n \"TYPESENDEMAIL\": \"\",\n \"BV_ID\": \"\",\n \"ADDITIONAL_FIELDS\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADDITIONAL_INFO\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADD_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ],\n \"REMOVE_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseURL}}/Participant"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {},\n \"Message\": \"\",\n \"Data\": {\n \"labore_\": {},\n \"Excepteur_12\": {}\n },\n \"InnerException\": {},\n \"StackTrace\": \"\",\n \"HelpLink\": \"\",\n \"Source\": \"\",\n \"HResult\": \"\"\n}"},{"id":"9bf3a913-eb2b-4f29-8846-637bf296d52b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CAMPAIGN_TOKEN\": \"\",\n \"PARTICIPANT\": {\n \"NAME\": \"\",\n \"EMAIL\": \"\",\n \"PHONE\": \"\",\n \"COMPANY\": \"\",\n \"EXTERNAL_ID\": \"\",\n \"TYPESENDEMAIL\": \"\",\n \"BV_ID\": \"\",\n \"ADDITIONAL_FIELDS\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADDITIONAL_INFO\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADD_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ],\n \"REMOVE_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseURL}}/Participant"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {},\n \"Message\": \"\",\n \"Data\": {\n \"labore_\": {},\n \"Excepteur_12\": {}\n },\n \"InnerException\": {},\n \"StackTrace\": \"\",\n \"HelpLink\": \"\",\n \"Source\": \"\",\n \"HResult\": \"\"\n}"},{"id":"d82f31e3-e5c3-4816-9c5b-84b928784990","name":"NotFound","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CAMPAIGN_TOKEN\": \"\",\n \"PARTICIPANT\": {\n \"NAME\": \"\",\n \"EMAIL\": \"\",\n \"PHONE\": \"\",\n \"COMPANY\": \"\",\n \"EXTERNAL_ID\": \"\",\n \"TYPESENDEMAIL\": \"\",\n \"BV_ID\": \"\",\n \"ADDITIONAL_FIELDS\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADDITIONAL_INFO\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADD_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ],\n \"REMOVE_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseURL}}/Participant"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {},\n \"Message\": \"\",\n \"Data\": {\n \"labore_\": {},\n \"Excepteur_12\": {}\n },\n \"InnerException\": {},\n \"StackTrace\": \"\",\n \"HelpLink\": \"\",\n \"Source\": \"\",\n \"HResult\": \"\"\n}"}],"_postman_id":"278377ff-cf7b-434c-b8c6-f656722bfcc6"},{"name":"/Participant/:id","id":"81a692e3-4ffc-4062-a2d3-6bbc2da99bca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"x-token-beeviral","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseURL}}/Participant/:id","description":"

PUT /v2/Participant

Este endpoint é utilizado para atualizar um participante com as informações fornecidas no body da requisição.

Request Body (Tabela 1.0)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
CAMPAIGN_TOKEN	string [required]	Token da campanha
PARTICIPANT	Objeto [Required] * Conforme Tabela 1.1 desta página	Objeto com as informações do participante.

PARTICIPANT (Tabela 1.1)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
NAME	String [required]	Nome do participante.
EMAIL	String [required]	Email do participante.
PHONE	String	Telefone do participante.
COMPANY	String	ID da empresa.
EXTERNAL_ID	String	ID externo do participante.
TYPESENDEMAIL	String	Tipo de e-mail a ser enviado ao participante.
BV_ID	String	BV_ID do participante
ADDITIONAL_FIELDS	Objeto * Conforme Tabela 1.1.3 do Recommendation/POST	Objeto contendo os campos adicionais do participante. Ex: { \"FIELD\": \"\", \"VALUE\": \"\" },
ADDITIONAL_INFO	Objeto * Conforme Tabela 1.1.4 do Recommendation/POST	Objeto contendo informações adicionais do participante. Ex: { \"FIELD\": \"\", \"VALUE\": \"\" },
ADD_CAMPAIGN	Objeto * Conforme Tabela 1.2 desta página	Objeto contendo as informações das campanhas em que o participante será adicionado.
REMOVE_CAMPAIGN	Objeto * Conforme Tabela 1.3 desta página	Objeto contendo as informações das campanhas em que o participante será removido.

ADD_CAMPAIGN (Tabela 1.2)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
ID	String	ID da campanha a ser incluído
CODE	String	Código da campanha
NAME	String	Nome da campanha
SHARE_LINK	String	Link de compartilhamento da campanha
HOME_LINK	String	Página inicial do participante na campanha
BV_ID	String	BV_ID da campanha

Observação:
Ao menos uma destas chaves deve ser inserida: ID ou CODE

REMOVE_CAMPAIGN (Tabela 1.3)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
ID	String	ID da campanha a ser removido
CODE	String	Código da campanha
NAME	String	Nome da campanha
SHARE_LINK	String	Link de compartilhamento da campanha
HOME_LINK	String	Página inicial do participante na campanha
BV_ID	String	BV_ID da campanha

Observação:
Ao menos uma destas chaves deve ser inserida: ID ou CODE

Response

A resposta estará no formato JSON com estrutura a seguir:

{\n  \"ID\": \"string\",\n  \"MESSAGE\": \"string\"\n}\n\n

\n","urlObject":{"path":["Participant",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"3b6b5213-98fe-474b-a44c-3b159d349b64","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CAMPAIGN_TOKEN\": \"\",\n \"PARTICIPANT\": {\n \"NAME\": \"\",\n \"EMAIL\": \"\",\n \"PHONE\": \"\",\n \"COMPANY\": \"\",\n \"EXTERNAL_ID\": \"\",\n \"TYPESENDEMAIL\": \"\",\n \"BV_ID\": \"\",\n \"ADDITIONAL_FIELDS\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADDITIONAL_INFO\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADD_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ],\n \"REMOVE_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseURL}}/Participant/:id","host":["{{baseURL}}"],"path":["Participant",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ID\": \"\",\n \"MESSAGE\": \"\"\n}"},{"id":"dac12c31-990d-4858-a3cd-921ccacda49d","name":"Redirect","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CAMPAIGN_TOKEN\": \"\",\n \"PARTICIPANT\": {\n \"NAME\": \"\",\n \"EMAIL\": \"\",\n \"PHONE\": \"\",\n \"COMPANY\": \"\",\n \"EXTERNAL_ID\": \"\",\n \"TYPESENDEMAIL\": \"\",\n \"BV_ID\": \"\",\n \"ADDITIONAL_FIELDS\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADDITIONAL_INFO\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADD_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ],\n \"REMOVE_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseURL}}/Participant/:id","host":["{{baseURL}}"],"path":["Participant",":id"],"variable":[{"key":"id","value":""}]}},"status":"Found","code":302,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {},\n \"Message\": \"\",\n \"Data\": {\n \"labore_\": {},\n \"Excepteur_12\": {}\n },\n \"InnerException\": {},\n \"StackTrace\": \"\",\n \"HelpLink\": \"\",\n \"Source\": \"\",\n \"HResult\": \"\"\n}"},{"id":"9bffef9d-b730-4887-bda6-d2934fe065de","name":"BadRequest","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CAMPAIGN_TOKEN\": \"\",\n \"PARTICIPANT\": {\n \"NAME\": \"\",\n \"EMAIL\": \"\",\n \"PHONE\": \"\",\n \"COMPANY\": \"\",\n \"EXTERNAL_ID\": \"\",\n \"TYPESENDEMAIL\": \"\",\n \"BV_ID\": \"\",\n \"ADDITIONAL_FIELDS\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADDITIONAL_INFO\": [\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n },\n {\n \"FIELD\": \"\",\n \"VALUE\": \"\"\n }\n ],\n \"ADD_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ],\n \"REMOVE_CAMPAIGN\": [\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n },\n {\n \"ID\": \"\",\n \"CODE\": \"\",\n \"NAME\": \"\",\n \"SHARE_LINK\": \"\",\n \"HOME_LINK\": \"\",\n \"BV_ID\": \"\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseURL}}/Participant/:id","host":["{{baseURL}}"],"path":["Participant",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {},\n \"Message\": \"\",\n \"Data\": {\n \"labore_\": {},\n \"Excepteur_12\": {}\n },\n \"InnerException\": {},\n \"StackTrace\": \"

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
NAME	String [Required]	Nome da indicação.
EMAIL	String [Required]	E-mail da indicação.
PHONE	String	Telefone da indicação.
EXTERNAL_ID	String	Identificação externa da indicação.
STATUS	String	Status da indicação. Valores possíveis: \"Indicado\", \"EmNegociacao\", \"Convertido\", \"Perdido\",\"Inativo\"
VALUE	String	Valor associado à indicação.
MESSAGE	String	Mensagem adicional.
ISSAVEPARTICIPANT	String	Indica se o indicado será salvo como participante.
ASSOCIATE_PARTICIPANT	Objeto [Required] * Conforme Tabela 1.1.2 desta página	Objeto contendo os dados do participante associado
ADDITIONAL_FIELDS	Objeto * Conforme Tabela 1.1.3 desta página	Lista de campos adicionais
ADDITIONAL_INFO	Objeto * Conforme Tabela 1.1.4 desta página	Lista de informações adicionais

Key	Type	Description
ID	String	ID da recompensa.
PEOPLE	String	ID do participante.
CAMPAIGN	String	ID da campanha.
REWARD_AVAILABLE	String	Disponibilidade de recompensa.
OCCURRENCE	integer	Número de ocorrências.
CREATION	dateTime	Data de criação. (Formato: YYYY-MM-DD HH:MM:SS)
MODIFICATION	dateTime	Data de modificação. (Formato: YYYY-MM-DD HH:MM:SS)
STATUS	String	Status atual.
NAME_CAMPAIGN	String	Nome da campanha.
NAME_INDICATOR	String	Nome do indicador.
CAMPAIGN_REWARD	String	ID da recompensa da campanha.
CAMPAIGN_REWARD_NAME	String	Nome da recompensa da campanha.
ISACTIVE	String	Indica se está ativo (\"Y\") ou não (\"N\").
ISREWARD_PAID	String	Indica se a recompensa foi paga (\"Y\") ou não (\"N\").
VALUE	double	Valor associado.
KEYS	String	Chaves associadas.
URL_REWARD	String	URL da recompensa.
CONTENT	String	Conteúdo associado.
MORE_INFO	String	Informações adicionais.
EMAILS_INDICATOR	String	E-mails do indicador.
TELEPHONES_INDICATOR	String	Telefones do indicador.
MOREFIELDS	String	Campos adicionais.
COUPON	String	Cupom associado.
TYPE	String	Tipo da recomendação.
SUBTYPE	String	Subtipo da recomendação.
TYPE_VALUE	String	Tipo de valor associado.
STATUS_RECOMMENDATION	String	Status da recomendação.
TYPE_BENEFICIARY	String	Tipo de beneficiário.
REWARD_AVAILABLE_ITEMS	Array de Objetos	Itens de recompensa disponíveis.
REWARD_AVAILABLE_ITEMS[].ITEM_AVAILABLE	String	Item disponível.
REWARD_AVAILABLE_ITEMS[].REWARD_ITEM	String	Item de recompensa associado.

Key	Type	Description
ID	string	Código da Fila de processamento.
VERSION	string	Versão da API.
ORIGIN	string	Origem do método.
METHOD	string	Método chamado.
STATUS	string	Status na fila de processamento: CONCLUIDO - registro processado com sucesso. FALHA - registro processado com falha. PROCESSANDO - registro na fila, aguardando o processamento.
DESCRIPTION	string	Descrição do processamento.

Endpoints:

Autenticação

Erro de Autenticação

Precisa de ajuda?

Response

Filter

Exemplo de chamada:

Request Body (tabela 1.0)

Response

PUT /v2/Participant

Request Body (Tabela 1.0)

Response

Response

Response

Filter

Exemplo de chamada:

Request Body (Tabela 1.0)

Objetos:

Response

Request Body (Tabela 1.0)

Response

Response

Response

Filter

Exemplo de chamada:

Request Body (Tabela 1.0)

Objetos:

Response

Response

Key	Type	Description
ID	String	Chave única da indicação na beeviral.
CODE	String	Código do indicador.
NAME	String	Nome da pessoa indicada.
EMAIL	String	Email da pessoa indicada.
PHONE	String	Telefone da pessoa indicada.
MESSAGE	String	Mensagem da indicação.
ACTIVE	String	Se a pessoa indicada está ativa (\"Y\") ou não (\"N\").
CONVERT	String	Se a pindicação foi convertida (\"Y\") ou não (\"N\").
VALUE	String	Valor da compra ou negócio relizado.
COMPANY_SYSTEM	Objeto	ID: id da empresa. CODE: código da empresa. NAME: nome da empresa. Ex: { \"ID\" : \"123\", \"CODE\" : \"abc0101\"`,` `\"NAME\" : \"Empresa X\"` `}`
PARTICIPANT	Objeto	ID: id do indicador. CODE: código do indicador. NAME: nome do indicador.
CREATION	String	Data de criação desta indicação.
MODIFICATION	String	Data de modificação desta indicação.
CHANNEL	String	Canal de indicação.
ORDER_ID	String	ID do pedido.
CAMPAIGN	Objeto	ID: id da empresa. CODE: código da empresa. NAME: nome da empresa. Ex: { \"ID\" : \"123\", \"CODE\" : \"abc0101\"`,` `\"NAME\" : \"Campanha Teste\"` `}`
EXTERNAL_ID	String	ID externo do indicado.
STATUS	String	Status da indicação.
SIGLA_STATUS	String	Sigla dos Status da indicação. Valores possíveis: \"Indicado\", \"EmNegociacao\", \"Convertido\", \"Perdido\",\"Inativo\"
ADDITIONAL_FIELD	Objeto	Objeto contendo os campos adicionais do participante. Ex: { \"FIELD\": \"\", \"VALUE\": \"\" },
ADDITIONAL_INFO	Objeto	Objeto contendo informações adicionais do participante. Ex: { \"FIELD\": \"\", \"VALUE\": \"\" },
IP	String	Endereço IP da pessoa indicada no momento em que a indicação foi capturada.
PAGING	Objeto	TOTAL: total de páginas. PAGE: página atual. LIMIT: limite de indicados nessa chamada. RECORDS: quantos indicados foram chamados. Ex: { \"TOTAL\": \"10\", \"PAGE\": \"5\", \"LIMIT\" : \"2\", \"RECORDS\" : \"30\" }
SORT	Objeto	SORT: desc = decrescente. asc = crescente. Ex: { \"SORT\": \"asc\", }

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
ID	String	Identificação do participante associado
EMAIL	String	E-mail do participante associado
EXTERNAL_ID	String	Identificação externa do participante associado
BV_ID	String	ID do BV do participante associado

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
id	String	Chave única da recompensa na beeviral.
campaign_token	String	Token da campanha (pode ser obtido na aba integrações da campanha)
id_participant	String	Chave única do participante na BeeViral
dtstart	String	Data do início da recompensa (Formato: YYYY-MM-DD HH:MM:SS) (Obrigatório também a especificação do dtend)
dtend	String	Data do fim da recompensa (Formato: YYYY-MM-DD HH:MM:SS) (Obrigatório também a especificação do dtstart)
status	String	Status da recompensa (Recompensado, NaoRecompensado, Processando, Liberado ou NaoLiberado)

Key	Type (apenas os marcados com [required] são obrigatórios)	Description
ID	String	ID do participante
EMAIL	String	Email do participante
EXTERNAL_ID	String	Identificação externa do participante
BV_ID	String	BV_ID do participante