VIvibes
Acquisition Campaign API

Search for pending participants

get/companies/{company_key}/campaigns/acquisition/{acquisition_id}/participants

Request

  • Base URL
    https://public-api.vibescm.com
  • URL
    https://public-api.vibescm.com/companies/{company_key}/campaigns/acquisition/{acquisition_id}/participants
  • Auth
    HTTP basic

Path parameters

company_keystring required
acquisition_idstring required

Query parameters

mdnstring

Mobile Directory Number. The dialable phone number associated with the phone. Required if searching by mdn.

person_idstring

Vibes-assigned unique indentifier for the person. Required if searching by person_id

external_person_idstring

A unique person identifier assigned by the brand, which can be used to link non-Vibes-assigned identifiers to Vibes person records. Required if searching by external_person_id.

Headers

X-API-Versionstring

Response

This is returned for all valid requests. The array with be empty for entities without pending subscriptions.

participation_datestring

Date the person joined the acquisition campaign.

expire_datestring

Date the person's acquisition request expires.

statusstring

Status of the aquisition request.

Changes

No recorded changes to this operation across all 2 revisions of this API.