younifyd
Menu

Retrieve A List Of Unsubscribers

Retrieve a list of unsubscribers

GET/apps/{app_key}/unsubscribers

Use it in a workflow

  1. Add a step and choose the Yotpo connector.
  2. Pick the Retrieve A List Of Unsubscribers action (under Reviews & Ratings).
  3. Fill in the fields below, then reference the result from later steps as {{retrieveAListOfUnsubscribers.response.data}}.

Request

Path parameters

app_keystringrequired

The store ID

Query parameters

utokenstringrequired

Your Yotpo account access token. See [Yotpo Authentication](https://apidocs.yotpo.com/reference#yotpo-authentication) to learn how to generate your utoken.

countstring

Number of unsubscribers to return

pagestring

Page number to return unsubscribers for

Response

Returns 200 with an object. Read it in later steps with {{retrieveAListOfUnsubscribers.response.data.<field>}}.

statusobject
codeinteger

Default 0

messagestring
responseobject
unsubscribersarray<object>4 fields
json
{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "response": {
    "unsubscribers": [
      {
        "id": 2038,
        "user_email": "test@gmail.com",
        "email_type_id": 1,
        "unsubscribed_by_name": "USER"
      }
    ]
  }
}

Need more? See the Yotpo guide for connection setup and behaviour shared by every action.