Vuemail
Image API#
This API returns product image that satisfies the given query conditions.
Request#
Request Type#
GET
Endpoint#
The base URL will be provided to you at the time of onboarding.
GET <base_url>/mail/v3/imageRequest Parameters#
| Param | Type | Required | Description | |
|---|---|---|---|---|
| api_key | string | yes | Client's api key | |
| module_name | string | yes | Name of the module that has to be invoked. | |
| image_no | integer | yes | Position of the image in the carousel that appears in the email | |
| product_id | string | no | Unique ID of the source product for which we need to return recommendations. | |
| user_id | string | yes | Unique ID associated by the merchant to the user in the site. | |
| ts | string | yes | timestamp at which the request was made. Preferrably an epoch timestamp. |
Response#
The response is a valid image or a blank image if the request is invalid.
Link API#
This API redirects to the configured page when clicking on the product image in the email.
Request#
Request Type#
GET
Endpoint#
The base URL will be provided to you at the time of onboarding.
GET <base_url>/mail/v3/linkRequest Parameters#
| Param | Type | Required | Description | |
|---|---|---|---|---|
| api_key | string | yes | Client's api key | |
| module_name | string | yes | Name of the module that has to be invoked. | |
| image_no | integer | yes | Position of the image in the carousel that appears in the email | |
| product_id | string | no | Unique ID of the source product for which we need to return recommendations. | |
| user_id | string | yes | Unique ID associated by the merchant to the user in the site. | |
| ts | string | yes | timestamp at which the request was made. Preferrably an epoch timestamp. |
Response#
Redirects to the website page as per configuration.