Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 40 Next »

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"
      ]
   },
   "sourcecode": "65301",
   "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_typeStringThis is stored as a code value - for example: ACQUISITION.

status

String

The status of the Campaign. Examples: attempted, active, deleted, past.
start_dateDate/Time (look up the standard for writing date time out)The date the Campaign is starting.

end_date

Date/Time

The date the Campaign is ending.

acquisition_campaign

keywords

Collection

Note: The Keywords (one or more) that you can send in the SMS to activate the Campaign.

Examples: "COUPON", "FASHION", "LOYALTY", "JOINUP".

urlStringUnique resource URL for the Acquisition Campaign.
created_dateDate/TimeThe date this Acquisition Campaign was created.
updated_dateDate/TimeThe date this Acquisition Campaign was last updated.
  • No labels