v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Acquisition Campaign API

Add a participant

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

Path parameters

company_keystring required

acquisition_idstring required

<div style="color:#dd1e2e; background:url(https://d2xs7zaan7w9gl.cloudfront.net/data/pages/64014/widgets/48027d01-e827-45e0-b96d-227c1099eedc/image/1680214872.png?icon-24x24-warning.png) no-repeat 10px center; background-color:#FCEAEC; padding:10px; font-size:13px;"><div style="padding-left:35px"><b>Important:</b> If you are entering a live acquistion_id, please note that using the <b>"Try It"</b> feature on the righthand console will send an actual API call to our system. This may result in a person being added to the live campaign.</div></div>

Headers

X-API-Versionstring

Content-Typestring required

Request body

person_idstring

Vibes-assigned unique indentifier for the person. Required if adding participant 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 adding participant by external_person_id.

custom_fieldsobject

A list of custom field key/value pairs to poulate when creating Acquisition request.

Response

This means the person has a pending acquisition and has not yet confirmed.

participation_datestring

Date the person entered the Acquisition Campaign.

expire_datestring

Date the person's acquisition request expires.

statusstring

Status of the aquisition request.