The type of event that you are creating. This is the name of the event that will show in the Postscript application. We accept the follow characters in the value field: lowercase letters, uppercase letters, digits and underscores.

Note: we will automatically prefix your partner/shop name in front of the event. For example, if sending an event called "OrderPlaced", we'll show it in our UI as "[Your Partner/Shop Name] - OrderPlaced" to distinguish it from others of a similar name.

ID of the subscriber the event should be associated with.

An external id to store for this event. This is for your own purposes and is optional. We'll set a default if you do not include it in your calls that's based on the time and date the event was received.

Event properties. These are key/value pairs that can be used by users to filter events or in messages for customization. We will attempt to choose the appropriate data type for the value depending on what you send us. We currently accept strings, booleans, integers, floats, and datetime strings.

The phone number of the subscriber you want to send the message to. Should include country code but no other characters or spaces, include the + character at the beginning.

Full phone number, including country code at the beginning, without special characters. For example 15555555555.

Shopify Customer ID to use to look up the subscriber.

No specific format required.

Note: when collecting subscribers for text message marketing purposes, you need to make sure you do so in a compliant way. Checkout our guide for more information on how to make sure you collect subscribers compliantly.

Keyword you would like this Subscriber to be associated with.

Where the subscriber came from, accepted values are website, social, or other.

Identifier for a Shopify Customer. Include this field if you would like to associate this subscriber with a particular Shopify customer. This much match an existing Shopify Customer ID.

An email address to associate with a subscriber. This email address will also be used to look up a Shopify customer with the same email to associate with the subscriber, if found.

Tags to add to the subscriber.

Custom properties as key/value pairs to add to the subscriber. Values can be: strings, integers, string arrays, or ISO 8601 date(time). Subscribers can have up to 20 custom properties. If properties is unset or null, it will be ignored.

ID of the Subscriber to update.

Email address for the Subscriber. Note: we will only update the email address on a subscriber if they don't already have one or we haven't found an associated Shopify customer for them yet.

A list of tags to add to the Subscriber.

Custom properties as key/value pairs. Values can be: strings, integers, string arrays, or ISO 8601 date(time). Subscribers can have up to 20 custom properties. If properties is unset or null, it will be ignored.