API Reference
BlogHelp CenterAPI Terms of Service

Create Subscriber

post
https://api.postscript.io/api/v2/subscribers

Create a single subscriber.

Body Params
string
required

ID of the Keyword that the subscriber should be added to.

string
required

The Keyword to which the subscriber should be subscribed to.

string
required

The phone number for the subscriber

string
enum
Defaults to other

Where the subscriber originated from.

Allowed:
int32

A reference to the Shopify Customer record for the subscriber

string

In addition to storing an email on a subscriber, an email address is also used to look up a Shopify Customer record if shopify_customer_id isn't provided.

tags
array of strings

An array of string tag values that can be used in user segmentation or filtering.

tags
json
Defaults to {"key": "value"}

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.

Headers
string

Shop API Token. Required for partners. This header should be used only by partners. Shops should include their API token in the Authorization header.

Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago