Get
/api/3/UploadImage/DeleteUserPhoto?websiteId={websiteId}&webApiClientKey={webApiClientKey}&userId={userId}&photoId={photoId}
This API is used to delete a user's uploaded photo (image) from the system.
Once deleted, the photo/image will no longer be accessible to the user to use in their customization process.
Request Information
Parameters
Parameter Name | Description |
WebsiteId (Int) | This param refers to the website associated with customized products. The admin user of Artifi can create one or more websites and assign products to each of them. The ID of the website with which specified customized products are associated should be specified in this parameter. |
WebApiClientKey (String) | When any company registers with Artifi, Artifi will generate a special and unique key for that company, which will be called the client key. This client key can be found in the registered company's profile tab in the Artifi Account. The client key will be used for client (company) authentication and will be referred to as WebApiClientKey. |
userId (String) | This will be the id of your e-commerce website's user. The user can be a registered or guest user. If the user is registered, pass the user id in this parameter, and if the user is not registered with your e-commerce website, create a temporary id for the user and pass that temporary id in this parameter. The non-registered users are called as guest users. This will be the unique user id. |
photoId (Int) | This parameter refers to the unique ID of the photo uploaded by the user. This ID identifies the specific image that is to be deleted from the system. |
Response Information
Response body formats
On Success
On success, this method will call back the JavaScript method in the website which is specified in the "successCallback" parameter with success Message.
{
"Response": "Success",
"Message": "The Image has been successfully deleted.",
"Data": null,
"ErrorCode": ""
}
On Error
On error, this method will call back the JavaScript method in the website which is specified in the "errorCallback" parameter with errorMessage.
{
"Response": "Error",
"Message": "Invalid user id.",
"Data": null,
"ErrorCode": "227"
}