HttpPost
/api/3/Design/UpdateDesignName?designId={designId}&websiteId={websiteId}&webApiClientKey={webApiClientKey}&name={name}
The Update design Name API is used for Updating Design Name or Design Title in Artifi Order.
Request Information
Parameters
Parameter Name | Description |
DesignId | Design id is the customized product id. The product which is customized/designed using Artifi (Product customization tool) and saved or Added to the cart is called a customized product. When this customized product id is specified, It will launch the Artifi editor with the specified customized product. This means, when the Artifi editor gets opened in a specified HTML div element, you will get to see/edit the customized product whose id is specified in this parameter. |
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. |
Name(string) | This parameter updates the design Name in Artifi Order. |
Response Information
Response body formats
On Success
On success, this method will call back the JavaScript method in the website which is specified in "successCallback" parameter with success Message.
{
"Response": "Success",
"Message": "Design name has been updated successfully.",
"Data": null,
"ErrorCode": ""
}
On Error
On error, this method will call back the JavaScript method in the website which is specified in "errorCallback" parameter with errorMessage.
{
"Response": "Error",
"Message": "Invalid website id.",
"Data": null,
"ErrorCode": "221"
}
{
"Response": "Error",
"Message": "Invalid webapiclientkey.",
"Data": null,
"ErrorCode": "226"
}
{
"Response": "Error",
"Message": "Invalid design id.",
"Data": null,
"ErrorCode": "225"
}