4. Odeslání odběratele do Kampaně rozesílky přes API

Metoda je určena k triggerovému odeslání stávajícího Odběratele do stávající Kampaně rozesílky. Data se předávají ve formátu application/json.

HTTP požadavek
  • URL: https://sender-solutions.com/api/subscribers/send-subscriber-into-campaign/
  • HTTP metoda: POST
  • Content-Type: application/json
Tělo požadavku (JSON)
{
    "SendIntoCampaign": {
        "SubscriberId": 21,
        "CampaignId": 5,
        "Variables": {
            "myVar1": "myVar1 value",
            "myVar2": {
                "option1": "myVar2 option value"
            }
        }
    }
}
Příklad požadavku s použitím 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"
            }
        }
    }
}'
Popis polí
Pole Typ Povinné Popis
SendIntoCampaign.SubscriberId number Identifikátor odběratele
SendIntoCampaign.CampaignId number Identifikátor kampaně rozesílky
SendIntoCampaign.Variables array Doplňkové proměnné pro předání do šablony e-mailu. Je to objekt s libovolnou strukturou, kde klíče (názvy vlastností) první úrovně jsou proměnné, které budou dostupné v šabloně. Názvy proměnných se nesmí shodovat s těmi, které jsou v šabloně dostupné na systémové úrovni, například subscriber
Příklad úspěšné odpovědi
{
    "success": true,
    "SendIntoCampaign": {
        "SendMessageRequestId": 41,
        "SubscriberId": 21,
        "CampaignId": 5,
        "MessageId": "kidabt3j31mo6vp611gx2yfpo4zr1a5c@sender-solutions.com"
    }
}

V těle odpovědi pole SendIntoCampaign.SendMessageRequestId odpovídá za jedinečný identifikátor úlohy pro odeslání jednoho e-mailu. Pole SendIntoCampaign.MessageId odpovídá za jedinečnou hodnotu záhlaví Message-ID v e-mailu.
Tato data se mohou hodit pro provedení dalších požadavků na naše API nebo při kontaktování technické podpory.