Skip to end of metadata
Go to start of metadata

Last Updated: Tuesday, September 29, 2020



Acquisition Participant Added

This callback event is triggered when a new Participant has been added to the Acquisition Campaign.

StatusDescription
PENDINGAcquisition flow has begun and is waiting for confirmation from participant

Callback Body

The event includes the information on the Participant and the Acquisition Campaign.

{
   "event_id":"AB234SDFD234",
   "event_type":"ack_participant_added",
   "event_date":"2017-03-15T15:42:23Z",
   "delivery_attempt":"1",
   "participant":{
      "person":{
         "id":"AB3423",
         "external_id":"ex123",
         "mobile_phone":{
            "mdn":"+12995551234"
          },
         "url":"/companies/:company_key/mobiledb/persons/AB3423"
      },
      "acquisition_campaign":{
         "id":"C1323542",
         "description":"Great Acquisition Campaign",
         "url":"/companies/:company_key/campaigns/acquisition/ACQ1234",
         "keyword":"SUBSCRIBED"
      },
      "participation_date":"2017-01-14T14:30Z",
      "expire_date":"2017-01-15T14:30Z",
      "status":"PENDING"
   }
}

Acquisition Participant Changed

This callback event is triggered whenever a Participant's status has changed due to either confirming or declining an opt-in. Participation timeouts and automatically-confirmed opt-ins will not trigger this event (only the initial Add event).

StatusDescription
CONFIRMEDParticipant confirmed opt-in by replying Y, or with zip code, and is now subscribed
REJECTED

Participant declined confirmation by replying NNo, or any STOP phrase or keyword and the acquisition flow is terminated

Callback Body

{
   "event_id":"AB234SDFD234",
   "event_type":"ack_participant_changed",
   "event_date":"2017-03-15T15:42:23Z",
   "delivery_attempt":"1",
   "participant":{
      "person":{
         "id":"AB3423",
         "external_id":"ex123",
         "mobile_phone":{
            "mdn":"+12995551234"
          },
         "url":"/companies/:company_key/mobiledb/persons/AB3423"
      },
      "acquisition_campaign":{
         "id":"C1323542",
         "description":"Great Acquisition Campaign",
         "url":"/companies/:company_key/campaigns/acquisition/ACQ1234",
         "keyword":"SUBSCRIBED"
      },
      "participation_date":"",
      "expire_date":"",
      "status":"CONFIRMED"
   }
}

Additional Resources

  • No labels

1 Comment

  1. Acquisition Campaign Added

    Description here - Alden to fill in.

     
    {
    	"event_id":"AB234SDFD234",
      	"event_type":"acquisition_campaign_added",
      	"event_date":"2013-08-01T15:42:23Z",
      	"delivery_attempt":"1",
    	"acquisition_campaign" :{
     		"_id":"C1323542",
         	"description":"Great Acquisition Campaign",
         	"campaign_type":{
            "code":"ACQUISITION"
         	},
         	"status":"Active",
         	"start_date":"2013-04-05T14:30Z",
    	     "end_date":"2014-04-05T14:30Z",
        	 "created_date":"2012-04-05T14:30Z",
    	     "updated_date":"2012-04-08T14:30Z",
        	 "acquisition_campaign":{
            	"keywords":[
               	"STORE",
               	"STOR",
               	"STORES"
            	]	
        	},
         	"url":"/companies/:company_id/campaigns/acquisition/C1323542" 	
    	}
    }