An Acquisition Campaign defines a keyword or keywords, and/or API methods that you can use to opt into a Mobile Database list.
The Acquisition APIs are used to add or search for Participants and Get Acquisitions Campaigns.
The Callbacks are triggered when a Participant is added, or their status has changed.
Acquisition (Campaign) Entity Example
{ "acquisition_id":"Kwnl5OL3", "description":"Great Acquisition Campaign", "campaign_type":{ "code":"ACQUISITION" }, "status":"Active", "start_date":"2016-04-05T14:30Z", "end_date":"2017-04-05T14:30Z", "acquisition_campaign":{ "keywords":[ "STORE", "STOR", "STORES" ] }, "url":"/companies/:company_key/campaigns/acquisition/Kwnl5OL3", "created_date":"2017-04-05T14:30Z", "updated_date":"2017-04-08T14:30Z" }
Elements
Data Element | Type | Description |
---|---|---|
acquisition_id | String | Vibes alpha-numeric unique identifier for each Acquisition Campaign. |
description | String | The name of the Acquisition Campaign. (identifier description) |
campaign_type | String | All possible values (check with Team A). This is stored as a code value - see example above. |
status | String | List of possible values, speak to team A. |
start_date | Date/Time (look up the standard for writing date time out) | The date Campaign is starting. |
end_date | Date/Time | The date Campaign is ending. |
acquisition_campaign | Collection | Note: The Keywords you can send in the SMS to activated the Campaign (Look up other Acquisition Campaigns to see the best practices for keywords). |
keywords | ||
url | String | Unique resource URL for the Acquisition Campaign. |
created_date | Date/Time | The date this Acquisition Campaign was created. |
updated_date | Date/Time | The date this Acquisition Campaign was last updated. |
Overview
Content Tools