younifyd
Menu

Update Account With Seo And Minisite Parameters

Update Your Account with SEO and Minisite Parameters

PUT/apps/{app_key}

Use it in a workflow

  1. Add a step and choose the Yotpo connector.
  2. Pick the Update Account With Seo And Minisite Parameters action (under Reviews & Ratings).
  3. Fill in the fields below, then reference the result from later steps as {{updateAccountWithSeoAndMinisiteParameters.response.data}}.

Request

Path parameters

app_keystringrequired

Your Yotpo account API key. Also known as client_id.

Request body

Enter the body as JSON in the step's Body field.

accountobject
minisite_website_namestringrequired

The desired name for your Minisite page, for example "MySite Reviews Page". This is used for the SEO.

minisite_websitestringrequired

The main page for your ecommerce site, for example www.MySite.com.

minisite_subdomainstringrequired

This should be a name unique to your store, for example MySite will become MySite.yotpo.me.

minisite_cnamestringrequired

The name of the page in your site that will use the Minisite, for example reviews.MySite.com.

minisite_subdomain_activebooleanrequired

Activate or deactivate Minisite for your reviews.

utokenstringrequired

Your Yotpo account access token. See [Yotpo Authentication](doc:yotpo-authentication) for instructions on generating a utoken.

json
{
  "utoken": "string",
  "account": {
    "minisite_website_name": "string",
    "minisite_website": "string",
    "minisite_subdomain": "string",
    "minisite_cname": "string",
    "minisite_subdomain_active": false
  }
}

Response

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

statusobject
codeinteger

Default 0

messagestring
responseobject
appobject20 fields
json
{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "response": {
    "app": {
      "app_key": "sDBpcW5WKlQqS2Vr3hsWei4koSlFw6fg1y9floP7",
      "domain": "http://omricohen.me",
      "minisite_subdomain": "MySite",
      "minisite_cname": "reviews.MySite.com",
      "minisite_website": "http://www.MySite.com",
      "minisite_website_name": "MySite Reviews Page",
      "referal": "",
      "active": true,
      "auto_publish": true,
      "minisite_subdomain_active": false,
      "account_type": {
        "id": 1,
        "name": "small",
        "description": "dummy description",
        "price": 14.9
      },
      "account_socials": [
        null
      ]
    }
  }
}

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