Add a participant

post

https://public-api.vibescm.com/companies/{company_key}/campaigns/acquisition/{acquisition_id}/participants

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_key

string

required

acquisition_id

string

required

Important: If you are entering a live acquistion_id, please note that using the "Try It" 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.

Body Params

User details for acquisition

person_id

string

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

external_person_id

string

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.

mobile_phone

object

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

custom_fields

object

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

Headers

X-API-Version

string

Defaults to 1

Content-Type

string

required

Responses

201

Depending on the "status", the following can be returned:

PENDING - The person's subscription is pending. This happens when an opt-in message has been sent, but the participant has not confirmed their subscription.
SUBSCRIBED - The person is subscribed to your list.

400

The supplied mobile number is not in proper mobile number format.

409

Already subscribed. This means the person has tried to subscribe more than once, but is already subscribed to the list.

422

Returned in the following situations:

MDNHASCONFIRMATIONBLOCK: Returned when the MDN has previously replied “No” to the acquisition campaign.
Note: When an MDN has previously replied "No" to an acquisition campaign, they cannot be added via API using that campaign. However, the MDN can still join a subscription list by texting in the appropriate keyword.
The supplied phone number does not map to a provisioned carrier. This is mostly returned for a landline number.
EXTERNALPERSONIDMISMATCH: Returned when trying to subscribe a person with an external_person_id that is already in use.
UNPROCESSABLE ENTITY: Returned when unable to process the request with the contained instructions. Please reach out to Vibes Customer Care or your account manager for troubleshooting support.
An error listing specific elements from the body is returned when trying to populate custom field data for custom fields unknown to the platform.

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