Update Subscriber

patch

https://api.postscript.io/api/v2/subscribers/{id}

Updates data for a given subscriber.

Path Params

id

string

required

ID of the subscriber you'd like to update.

Body Params

email

string

Email address for the subscriber. Note: when updating an email address, we will only update it if none previously existed on the subscriber or we haven't linked a Shopify customer to them yet. We also can only link a Shopify customer if they already exist, not retrospectively.

tags

array of strings

Tags you would like to add to the subscriber. Note: tags are additive, so whatever you include here will be added to the existing tags on a subscriber.

tags

properties

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 50 custom properties. If properties is unset or null, it will be ignored.

Headers

X-Postscript-Shop-Token

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

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json