An acquisition campaign is a way for you to add new subscribers to your lists. Setting up the campaign is done in our platform, but you can use our public Acquisition Campaign API to retrieve information about your current acquisition campaigns and participants.

Available Methods

Available Callbacks

Elements & Attributes

Data Element	Type	Description
`acquisition_id`	String	Vibes alphanumeric unique identifier for each acquisition campaign.
`description`	String	The name of the acquisition campaign (identifier description).
`campaign_type`	String	This is stored as a code value - for example: ACQUISITION.
`status`	String	The status of the campaign. Examples (always lowercase): scheduled active deleted past
`start_date`	Timestamp	The date the campaign is starting. It should be in the ISO 8601 format - for example: 2016-04-05T14:30Z.
`end_date`	Timestamp	The date the campaign is ending. It should be in the ISO 8601 format - for example: 2017-04-05T14:30Z.
`acquisition_campaign` `keywords`	Collection	The keywords (one or more) that a user can send in via SMS to join the campaign and begin the subscription process. Examples*: "COUPON", "FASHION", "LOYALTY", "JOINUP".
`sourcecode`	String	The short or long code the acquisition campaign is on.
`url`	String	Unique resource URL for the acquisition campaign.
`created_date`	Timestamp	The date this acquisition campaign was created. It should be in the ISO 8601 format - for example: 2016-04-05T14:30Z. This field is system-generated and cannot be updated via the API.
`updated_date`	Timestamp	The date this acquisition campaign was last updated. It should be in the ISO 8601 format - for example: 2017-04-05T14:30Z. This field is system-generated and cannot be updated via the API.

Example Entity

{
   "acquisition_id":"Kwnl5OL3",
   "description":"Great Acquisition Campaign",
   "campaign_type":{
      "code":"ACQUISITION"
   },
   "status":"active",
   "start_date":"2021-04-05T14:30Z",
   "end_date":"2031-04-05T14:30Z",
   "acquisition_campaign":{
      "keywords":[
         "STORE",
         "STOR",
         "STORES"
      ]
   },
   "sourcecode": "65301",
   "url":"/companies/:company_key/campaigns/acquisition/Kwnl5OL3",
   "created_date":"2022-04-05T14:30Z",
   "updated_date":"2022-04-08T14:30Z"
}