Introduction
The Delete Clipart By ClipartCode API is used to remove a specific clipart from the system by providing its unique clipartCode. This API is particularly useful for managing and maintaining the clipart library by eliminating outdated, irrelevant, or unwanted assets.
By passing the required parameters such as clipartCode, and userEmailAddress, the API securely identifies and deletes the specified clipart from the Artifi platform. The operation ensures that only authorized users can perform deletion actions, maintaining data integrity and control.
If the deletion process is successful, the API returns a response indicating the status of the operation. In case of failure, it provides an appropriate error message for troubleshooting.
Use Cases
- Removing Outdated Cliparts
When certain cliparts are no longer relevant (e.g., old designs, expired campaigns), this API can be used to remove them from the system.
- Maintaining Clean Asset Library
Helps administrators keep the clipart repository organized by deleting unused or duplicate cliparts.
- Content Moderation
If any clipart violates guidelines or contains inappropriate content, it can be quickly removed using this API.
API Details
Endpoint
DELETE /api/4/Cliparts/DeleteClipartByClipartCode
curl --location --request DELETE 'https://api.artifi.net/api/4/Cliparts/DeleteClipartByClipartCode?clipartCode=2276542&userEmailAddress=demo%40artifilabs.com' \
--header 'webApiClientKey: c961461a-b287-448c-b9ea-e1162bd80b8e' \
--header 'websiteId: 241'
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 |
clipartCode | string | Yes | This parameter is a code that is associated with cliparts. Passing the Clipart Code in the API will delete the details of the associated clipart. |
userEmailAddress | string | Yes
| This parameter value contains the artifi admin login users' email address, who is making the request. |
Success Responses
{
"Response": "Success",
"Message": "Clipart has been deleted successfully.",
"Data": null,
"ErrorCode": ""
}
Error Code List (Click Here)
Q&A
Q1. What does the Delete Clipart By ClipartCode API do?
This API deletes a specific clipart from the system using its unique clipartCode. It permanently removes the associated clipart data from the Artifi platform.
Q2. What parameters are required to call this API?
The required parameters are:
- clipartCode (Query Parameter)
- userEmailAddress (Query Parameter)
- websiteId (Header)
- webApiClientKey (Header)
All these parameters are mandatory for successful execution.
Q5. Can a deleted clipart be restored?
No, once a clipart is deleted using this API, the action is permanent and cannot be reversed. It is recommended to validate the clipart before deletion.
Q6. Who is authorized to delete cliparts?
Only authorized users with valid credentials (webApiClientKey) and a valid userEmailAddress associated with an Artifi admin account can perform deletion.
Q7. What happens if an invalid clipartCode is passed?
If the provided clipartCode does not exist, the API will return an error response indicating that the clipart was not found or could not be deleted.
Q8. What response is returned on successful deletion?
On success, the API returns a response like:
{
"Response": "Success",
"Message": "Clipart has been deleted successfully.",
"Data": null,
"ErrorCode": ""
}
Q9. What kind of errors can occur while using this API?
Common errors include:
- Invalid or missing parameters
- Unauthorized access (invalid webApiClientKey key)
- Internal server errors
Refer to the Error Code (Click Here) documentation for detailed information.
Q10. Is this API secure?
Yes, the API requires authentication using webApiClientKey and validates the requesting user via userEmailAddress, ensuring only authorized deletions.
Q11. When should this API be used?
This API should be used when:
- Removing outdated or unused cliparts
- Cleaning up duplicate assets
- Enforcing content moderation policies