Get
/api/2/UpdateClipart?websiteId={websiteId}&webApiClientKey={webApiClientKey}&userEmailAddress={userEmailAddress}&clipartCode={clipartCode}&url={url}
The Update Clipart API is used to update an existing clipart item in the system. This API allows you to modify the URL of an existing clipart by specifying the clipart's unique clipartCode and the new image URL.
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. |
userEmailAddress (String) | This parameter value contains the login user's email address, who is making the request. |
clipartCode (Int) | This parameter is a code that is associated with cliparts. Passing the Clipart Code in the API will return the details of the associated clipart. |
Url (String) | This parameter refers to the url of the image the user wants to add into clipart family. |
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.
Success Response:
{
"Response": "Success",
"Message": "Clipart has been updated successfully.",
"Data": null,
"ErrorCode": null
}
On Error
On error, this method will call back the JavaScript method in the website which is specified in the "errorCallback" parameter with errorMessage.
Error Response:
{
"Response": "Error",
"Message": "Invalid clipart code.",
"Data": null,
"ErrorCode": "248"
}