| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requestsā¦ | |||
You can also add a new participant to an acquisition campaign using the public API.
Adding a new person to your databaseWhen you send this
POST, an existing unsubscribed person record will be searched for. If found, it will be updated with any additional information you provide. If no person record is found, a new record will be created.Note that you do not need to add a person record before making this call.
Request
The request of this call follows the formatting of a person entity. However, it is important to note that a person entity does not have to be created before you make an Add a participant call. If the unique identifier in your Add a participant call does not match any person record, a new person record will be created and added to your mobile database.
Request Notes
- At a minimum, one of the following must be specified:
person_key,external_person_id,person_id, orMDN. - Any fields specified for the person will be updated with the new values.
- Any fields whose values are set to
Nullwill be removed from the person. - Any fields completely omitted will be ignored, and any existing values will remain.
- These changes will only be performed if a 2xx HTTP response is returned by the API call.
- If you are using custom fields, they must first be created in the Vibes Platform prior to sending via API.
Response
The return data will be the acquisition campaign participation object.
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.
The supplied mobile number is not in proper mobile number format.
Already subscribed. This means the person has tried to subscribe more than once, but is already subscribed to the list.
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 anexternal_person_idthat 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.