Attributes
Delete Custom Attribute
This endpoint allows the deletion of a custom attribute.
DELETE
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
/
{attributeId}
Authorization
Path
curl --request DELETE \
--url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId} \
--header 'Authorization: <authorization>'
{
"status": true,
"message": "Attribute deleted successfully."
}
Description
This API endpoint facilitates the removal of a specific custom attribute by providing the necessary identifiers based on the target, whether it’s a collection or a list.
Path
target
string
requiredSpecifies the target entity as either “collection” or “list.”
targetId
string
requiredThe unique identifier for the target entity (collection or list), allowing for precise referencing. (e.g Collection Id / List Id)
attributeId
string
requiredThe unique identifier for the attribute to be deleted.
Response
status
boolean
Indicates the success or failure of the attribute deletion. In this case, true signifies a successful operation.
message
string
Provides a human-readable message accompanying the response. In this instance, it confirms the successful deletion of the attribute with the message “Attribute deleted successfully.”
curl --request DELETE \
--url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId} \
--header 'Authorization: <authorization>'
{
"status": true,
"message": "Attribute deleted successfully."
}