AI agents for Postscript

List keywords

Lists the shop's active opt-in keywords, each with id, keyword (like YOUROCK), triggered_count, created_at and updated_at.

Get a keyword

Reads one keyword by its ID (like kw_31afjew824892ks) with its trigger count.

Find subscribers

Lists the shop's SMS subscribers, promotional by default, filtered by exact or partial email, phone number or Shopify customer ID, or by when they were created or updated.

Get a subscriber

Reads one subscriber by Postscript ID: phone_number, email, shopify_customer_id, tags, properties and subscriptions.

Add a subscriber

Starts an SMS opt-in for a phone number through one of the shop's keywords.

Update a subscriber

Adds tags, sets custom properties or fills in the email of a subscriber.

Send a custom event

Records an event for a subscriber (found by subscriber ID, phone or email) that can trigger Postscript flows and fill merge tags, like an appointment booked or a loyalty tier reached.

Unsubscribe a subscriberDeletes data

Opts a subscriber out of the shop's Postscript messages, by subscriber ID or phone number, as if they had texted STOP.

Redact a subscriber's dataDeletes data

Erases a person's personal data from Postscript (a privacy or GDPR request), found by subscriber ID, Shopify customer ID, email or phone number; an active subscriber is unsubscribed too.