Tip: Select any of the images in this article for a closer look.
In this article, we walk through how you can use Postscript's Partner API to add subscribers.
Why Use Postscript Partner API to Add Subscribers
- Build your own custom subscriber form (ex: popups or forms).
- Build your own custom integration with another service and Postscript.
- Add subscribers you’ve collected elsewhere to Postscript.
Create a Keyword
Before you can use Postscript API to add subscribers, you need to create a keyword that will track opt-ins from the source.
- Select Acquisition in the side menu of your Postscript dashboard, then select Keywords.
- Select Create Keyword in the top-right corner of the page.
-
Name your keyword. Aim for something that explains what the keyword is for and any coupon included. For example:
- FLOWER10. A flower store with a 10% off coupon code.
- LABORDAY15. A store running a Labor Day Sale with a 15% off coupon code.
- BIKINI15. A women's swimwear store with a 15% off coupon code.
- POSTSCRIPTSMS. A code that includes the brand name.
- Choose whether to enable Include Coupon in Reply.
- We highly recommend you include a coupon with your keyword.
- To do so, select Yes from the drop-down and then enter the amount of the discount and whether is a percent or dollar value.
- Select Save Keyword.
- You can customize your Reply message and add additional actions via + Add Action if desired.
Use Postscript API to Add Subscribers
The Postscript API has a specific section on keywords and subscribers. To use the API to add a subscriber via your newly created keyword, you'll need to complete the following steps:
1. Use an API call to get the ID for the keyword you created
You can find specific instructions for this call in the Keywords section of our Partner API documentation. Head to Get Keywords.
2. Add subscribers to Postscript using the keyword ID in the API call
You can find specific instructions for this call in the Subscribers section of our Partner API documentation. Head to Create Subscriber.
Compliance Language Requirements
Anywhere you are collecting subscriber information, you’ll want to be sure to add compliant language, like the below example. Learn more about text message compliance here.
Here's an example of compliant language:
*By providing your phone number, you agree to receive recurring automated marketing text messages (e.g. cart reminders) from this shop and third parties acting on its behalf. Consent is not a condition to obtain goods or services. Msg & data rates may apply. Msg frequency varies. Reply HELP for help and STOP to cancel. You also agree to the Terms of Service and Privacy Policy.
Note: In order to collect subscribers compliantly, your shop's Terms of Service and Privacy Policy need to be hyperlinked in the language shown above. If they cannot be hyperlinked, the full URLs of each need to be included so a viewer may search your terms or privacy policy if needed.
For example, "You also agree to the Terms of Service (https:/myshop.com/terms-of-service/) and Privacy Policy (https://myshop.com/privacy-policy/).”
You should now be able to use our API to add subscribers. If you want more information on Postscript's subscriber API, check out our Partner API docs.
Get Support
Have questions? Please feel free to reach out to our wonderful Support team at support@postscript.io or via live chat. You can also submit a support request here!
Need ongoing channel strategy guidance? Please fill out this form and we'll connect you to one of our certified partners.