O método Participant/Post permite enviar um participant para ser registrado na beeviral



1) Autenticação:


Para realizar suas chamadas à API da beeviral, é necessário antes identificar e autenticar a sua empresa. Para isso, informe o API Token no Header das suas chamadas. Assim: x-token-beeviral=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX


Importante: O token sempre deve ser enviado via Header

Substitua XXXXXXXXXXXXXXXXXXXXXX pelo API Token da sua empresa. Essa informação está disponível em "Configurações / Integrações"conforme a imagem abaixo:






2) Parâmetros:


Parâmetros da URL: 

  • Este médodo não pussui parametros 


3) Body:


O método deve ser utilizado com o Body. Exemplo:

{

  "CAMPAIGN_TOKEN": "string", //Token da campanha (pode ser obtido na aba integrações da campanha, entre na campanha desejada "Integrações>campaign token") 

  "PARTICIPANT": {

    "NAME": "string", //Nome da pessoa indicada 

    "EMAIL": "string",//Email da pessoa indicada 

    "PHONE": "string",//Telefone da pessoa indicada 

    "COMPANY": "string",//Empresa da pessoa indicada

    "EXTERNAL_ID": "string",//Identificador externo do participant

    "TYPESENDEMAIL": "string",

    "ADDITIONAL_FIELDS": [ //Campos adicionais

      {

        "FIELD": "string",

        "VALUE": "string"

      }

    ],

    "ADDITIONAL_INFO": [//Informações adicionais

      {

        "FIELD": "string",

        "VALUE": "string"

      }

    ]

  }

}


4) Retorno:


Ao submeter os dados à API e retornar o status de HTTP 200, significa que a indicação foi registrada corretamente na beeviral.

O retorno do médoto será a informação que o registro entrou na fila de processamento com sucesso.


{

  "ID": "string",

  "MESSAGE": "string"

}


5) Testes:


Para realizar uma chamada teste ao método acesse:


URL:  https://account.beeviral.app/api/swagger/ui/index 

Versão: V2

Método: Participant/Post