Upload a screenshot for an experience variation

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/variations/{variation_id}/screenshot

Allows uploading a custom screenshot image for a specific variation. This can be useful if automatic screenshot generation fails or if a specific view needs to be captured. The uploaded image will be displayed in the Convert UI for this variation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to which save/retrieved data is connected

experience_id

integer

required

The ID of the experience to which the variation belongs

variation_id

integer

required

The ID of the variation to be deleted

Query Params

size

string

enum

The size of the returned image, if omitted will return full size

Allowed:

force_download

boolean

Flag used to force download instead of inline response

Body Params

Request body for uploading an image where the filename might be derived from the uploaded file or generated by the system. Uses multipart/form-data. Typically used for quick uploads like variation screenshots. Constraints are the same as for UploadCdnImageRequestData.

image

file

required

Responses

Language

Credentials

URL

Loading…

Response

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

application/json

200A JSON object containing the data field, which holds the base64 encoded string of an image. Useful for transferring image data within JSON payloads.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.