Introduction
The Update Design Name API allows users to modify the name or title of an existing design within the Artifi platform. This API is particularly useful in scenarios where users want to rename their saved or ordered designs for better identification, organization, or personalization.
Use Cases
- Renaming Saved Designs
Allows users to update the name of previously saved designs for easier identification.
- Updating Design Title in Orders
Enables modification of design names associated with placed orders for better tracking and reference.
- Improving Organization
Helps users categorize and organize multiple designs by assigning meaningful names.
- Post-Creation Customization
Provides flexibility to update design names even after the design has been created or used.
- User Experience Enhancement
Ensures a cleaner and more personalized design management experience in applications.
API Details
Endpoint
curl --location --request POST \
'https://{your-domain}/api/4/Design/UpdateDesignName?designId=5001&name=My+Custom+Jersey' \
--header 'websiteId: 101' \
--header 'webApiClientKey: your_api_key'
Parameters
Header Validation
Header Name | Type | Required | Description |
websiteId | int | Yes | Unique identifier of the website. |
webApiClientKey | string | Yes | API client key used for authentication. |
Query Parameters
Name | Type | Required | Description |
DesignId | Int | Yes | The unique ID of the design whose name you want to update.
|
Name | string | yes | The new display name you want to assign to the design (e.g., "My Birthday Mug"). |
Success Response
{
"response": "Success",
"errorCode": null,
"message": "Design name updated successfully."
}
Error Code List (Click Here)
Q&A
Q1. What does the Update Design Name API do?
It updates the name or title of an existing design in the system without modifying the design content.
Q2. Which parameters are required to update the design name?
You need designId, websiteId, webApiClientKey, and the new name.
Q3. Does updating the design name affect the design itself?
No, it only changes the display name or title of the design. The design data remains unchanged.
Q4. Can I update the design name after placing an order?
Yes, the API supports updating the design name even if it is associated with an order.
Q5. Is there any validation for the design name?
The design name should follow system-defined constraints such as allowed characters and length (if applicable).
Q6. Can multiple designs be updated in a single API call?
No, this API updates one design name per request.
Q7. What happens if an invalid designId is provided?
The API will return an error indicating that the design could not be found or updated.