Create or update subscriber

post

https://api.yotpo.com/messaging/v3/stores/store_id/subscribers

Create or update a subscriber in your Yotpo store. You can sync subscribers from any subscription collection tool, for example, a third-party subscription popup.

Path Params

store_id

string

required

The store ID (app_key).

Body Params

phone

string

required

The phone number of the customer in E.164 format. Max length: 15 characters

string

The customer's email address

list_id

int32

required

The ID of the list the customers will be added to. If a list ID isn’t provided, the customer will be assigned to the default list of the account. See below for instructions on how to find the List ID.

consent

string

required

This is the state of the customer consent for SMS and/or email messages. The possible values are ‘subscribed’ or ‘unsubscribed’. If the field is left blank, the consent will be marked as ‘never subscribed’

first_name

string

The customer's first name

last_name

string

The customer's last name

source

string

This is the source of the SMS and/or email consent, for example, ‘welcome_popup’. The field is optional. Min length: 3 characters; Max length: 40 characters

suppress_email

string

The status of the suppression of the email. The possible values are ‘true’ or ‘false’. If left blank, the value of the field will default to ‘false’. The field is optional

suppression_reason

string

The reason for suppressing the email. The possible values are ‘soft_bounce’, ‘hard_bounce’, and ‘manual_suppression’. If left blank, it defaults to ‘manual_suppression’.

timestamp

date

The timestamp of the suppression. The format of this date field is Y-m-d\TH:i:s.u\Z (example - 2014-06-24T22:37:13.151Z). If left blank, it defaults to the time and date when the endpoint is hit. The field is optional.

suppress_welcome_messages

string

This field’s value defines whether the subscriber will receive welcome flow messages for the channel(s) they’re subscribed to using the endpoint. The possible values are: ‘true’ - No welcome message will be sent ‘false’ - A welcome message will be sent If left blank, the value defaults to ‘false’. The field is optional

trigger_double_opt_in

string

Defaults to false

This field’s value defines whether the subscriber will receive a double opt-in message to confirm their subscription for SMS.

Responses

200200

400400

409409

422422