Update Subscriber

put

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

Updates a single subscriber.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

ID of the subscriber you'd like to update.

Body Params

phone_number

string

required

A phone number for a subscriber.

origin

string

enum

required

Defaults to other

Where the subscriber originated from.

Allowed:

keyword_id

string

ID of the Keyword that the subscriber should be added to. This or keyword is required.

keyword

string

The Keyword to which the subscriber should be subscribed to. This or keyword_id is required.

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.

shopify_customer_id

int32

A reference to the Shopify Customer record for the 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 20 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

Loading…

Response

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

application/json

200200

400400