Subscribe User API Endpoint Documentation

This documentation provides details on the POST endpoint for manually subscribing customer into a campaign.

Endpoint

https://console.gotoaisle.com/api/webhooks/manual-input

POST

The public API key will be given to you by one of our team members

"X-Api-Key" : "****************************"

The following parameters can be included in the request body:

customerPhoneNumber: The phone number of the customer.
campaignPhoneNumber: The phone number associated with the campaign.
email (optional): The email address of the customer.
influencerTag (optional): The influencer tag or code to track this campaign.
utmCampaign (optional): The UTM campaign parameter. It can be derived from the utm_campaign.
utmSource (optional): The UTM source parameter. It can be derived from the utm_source.
utmMedium (optional): The UTM medium parameter. It can be derived from the utm_medium.
zipCode (optional): The zip code of the customer.
referrerUrl (optional): The URL from which the customer was referred from.

Based on the status code received, the application will respond as follows:

{
    "message": "response message",
    "code": "ConvoAlreadyExists"
}

If code === 'ConvoAlreadyExists', then the conversation exists already.
If code === 'ConvoStopped', then the conversation is blocked.
If code === 'EmailAlreadyExists', then the user already has an account associated with this email.
If code === 'UserNotEligible', then the user has already redeemed with this number for another campaign.
If code === 'VoipCustomer', then VOIP phone numbers are not permitted.
If code === 'PayoutBlocked', then we are unable to create the user's account at this time.
If code === 'NewConvoCreated', then the user has been subscribed successfully.

If 429, then too many subscriptions have been made from this IP address, please try again in an hour. Failed attempts will increase this timeout.

Ensure that all mandatory fields are provided in the request.
Optional fields can be derived from multiple sources, as mentioned in the request body section.
Phone number must be a valid phone number, we recommend the following regex for your phone number validation /^(\+\d{1,2})?[\s.-]?$?\d{3}$?[\s.-]?\d{3}[\s.-]?\d{4}$/