Import Images

Import images

POST/v1/widget/{app_key}/images/create_batch

Use it in a workflow

Add a step and choose the Yotpo connector.
Pick the Import Images action (under Reviews & Ratings).
Fill in the fields below, then reference the result from later steps as {{importImages.response.data}}.

Request

Path parameters

app_keystringrequired

The store ID

Request body

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

imagesarray<any>required

The array of images to create as a batch. This array cannot be empty and may contain a maximum of 8 entries (images).

user_namestringrequired

The name of the user who provided the image

user_emailstring

The email address of the reviewer who provided the image

tagged_productsarray<string>

The unique product ID of the products to tag in this photo. Each image can accept a maximum of three product tags.

image_urlstringrequired

The URL of the image you want to create

captionstring

The image caption text

creation_datestring (date)

The date of album creation in ISO8601 format. **This cannot be a future date**

json

{
  "images": [
    null
  ],
  "user_name": "string",
  "image_url": "string",
  "user_email": "string",
  "tagged_products": [
    "string"
  ],
  "caption": "string",
  "creation_date": "2025-01-01"
}

Response

Returns 200 with a any. Read it in later steps with {{importImages.response.data.<field>}}.

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

Was this page helpful?