4. Envio de um assinante para uma Campanha de envios por meio da API

O método é destinado ao envio por gatilho de um Assinante existente para uma Campanha de envios existente. Os dados são transmitidos no formato application/json.

Requisição HTTP
  • URL: https://sender-solutions.com/api/subscribers/send-subscriber-into-campaign/
  • Método HTTP: POST
  • Content-Type: application/json
Corpo da requisição (JSON)
{
    "SendIntoCampaign": {
        "SubscriberId": 21,
        "CampaignId": 5,
        "Variables": {
            "myVar1": "myVar1 value",
            "myVar2": {
                "option1": "myVar2 option value"
            }
        }
    }
}
Exemplo de requisição usando cURL

curl --location 'https://sender-solutions.com/api/subscribers/send-subscriber-into-campaign/' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{api-token}}' \
--data '{
    "SendIntoCampaign": {
        "SubscriberId": 21,
        "CampaignId": 5,
        "Variables": {
            "myVar1": "myVar1 value",
            "myVar2": {
                "option1": "myVar2 option value"
            }
        }
    }
}'
Descrição dos campos
Campo Tipo Obrigatório Descrição
SendIntoCampaign.SubscriberId number Identificador do assinante
SendIntoCampaign.CampaignId number Identificador da campanha de envios
SendIntoCampaign.Variables array Variáveis adicionais para transmitir ao modelo do e-mail. É um objeto com estrutura arbitrária, onde as chaves (nomes das propriedades) do primeiro nível são variáveis que estarão disponíveis no modelo. Os nomes das variáveis não devem coincidir com os que estão disponíveis no modelo no nível do sistema, por exemplo subscriber
Exemplo de resposta bem-sucedida
{
    "success": true,
    "SendIntoCampaign": {
        "SendMessageRequestId": 41,
        "SubscriberId": 21,
        "CampaignId": 5,
        "MessageId": "kidabt3j31mo6vp611gx2yfpo4zr1a5c@sender-solutions.com"
    }
}

No corpo da resposta, o campo SendIntoCampaign.SendMessageRequestId corresponde ao identificador único da tarefa de envio de um e-mail. O campo SendIntoCampaign.MessageId corresponde ao valor único do cabeçalho Message-ID no e-mail.
Esses dados podem ser úteis para a execução de outras requisições à nossa API ou durante o contato com o serviço de suporte técnico.