Mainstay API: Create & Intro Contacts

What is the Create & Intro Webhook?

Mainstay’s API can be used to create a contact in our system, and optionally, to send an introduction campaign via text message when the contact is created. 

One of the benefits of the “send intro campaign” element of this feature is that it provides the opportunity to immediately and automatically engage someone after their information has been collected from a source outside of Mainstay. For example, when a prospect uses an online form to sign up to receive more information about a program, this feature enables you to immediately engage them with a welcome message from your bot.

How do I use the Create & Intro Webhook?

This feature requires you to use the API to create contacts in Mainstay’s system. If API integrations are not enabled for your account, please consult your Mainstay Success Manager.

Please review the Contact Create endpoint to understand how it can be used. To initiate a script send alongside contact creation, you will include “send_intro_campaign”: true in the body of your request. The bot will use a default campaign script for its intro, but if you’d like to customize this message, it’s possible to do so by contacting our Support team. 

Please note that the “send intro campaign” option is only available when a contact is created - it can not be used to send any additional scripts to a contact, and it can not be used on a contact that already exists.

To update the introduction script for the API-created contacts you can go to the SMS settings page and select the intro script.

Can I use the Create & Intro Webhook alongside csv imports or another type of integration?

Yes! Once a contact is created, if you wish to update their data, you will need to do so via additional API calls, csv imports, or an established integration. These systems are designed to work alongside one another. 

If you plan to use the API in tandem with an integration, we suggest that you have a clear understanding of when each system is expected to create contacts, in order to avoid unexpected behavior arising from an API call and an integration attempting to create a contact in close succession.

What else can I do via the Mainstay API?

Please see our API Documentation for details on what’s available.