Send Invitation for a campaign using API

0

Which API call do we use to send out an invitation for an email campaign to one or more contacts?

Dominic Sharpe answered
    1

    The campaign is specified via the campaign ID (bolded in the call below):

    https://restapi.surveygizmo.com/v5/survey/123456/surveycampaign/100000/emailmessage/100000?_method=POST

    This ID would have been returned in the result after creating the campaign. You can also find the campaign ID via the GetList call (pulling a list of all available campaigns for a given survey):

    https://apihelp.surveygizmo.com/help/surveycampaign-sub-object-v5#getlist

    Hope this helps clarify!

    Vahid Mousavi commented
      0

      You will need to use the Email Message Sub Object (specifically the update message call):

      https://apihelp.surveygizmo.com/help/emailmessage-sub-object-v5#updateobject

      In order to send the message, you will need to set the send parameter to ‘true’.

      This is assuming that you have the campaign and message already created. If the campaign and message are not created, the campaign will need to be created using:

      https://apihelp.surveygizmo.com/help/surveycampaign-sub-object-v5#createobject

      and then the message will need to be created using:

      https://apihelp.surveygizmo.com/help/emailmessage-sub-object-v5#createobject

      I hope this helps clarify!

      Vahid Mousavi commented
        • Thanks Dominic! One question: How do we specify the campaign in the UPDATEEMAILMESSAGE call? I don’t see a parameter for this in the API. We will have multiple campaigns, and want to make sure we send the invite for the right campaign to the contact.
          I’m a BA, so I’m not very familiar with this API, but want to document as much as I can for our developers. Thanks again!

        ×

        Login

        Question stats

        • Active
        • Views947 times
        • Answers2 answers
        • Followers1 follower