Delete Custom Field
DELETE/custom-field/:id
Delete a Custom Field by Custom Field UUID
Deleting a Custom Field
- This operation will remove the custom field from the system, and it will no longer be available for use in the entity.
- The custom field will be permanently deleted, and all associated data will be lost.
- Ensure that you have backed up any necessary data before proceeding with the deletion.
Example
In the Custom Field definition:
-
Before Deletion:
Custom Field Name Custom Field Key Shipment ID shipment_id Invoice No invoice_no -
After Deleting the
Shipment ID
custom field:Custom Field Name Custom Field Key Invoice No invoice_no
In the Entity using the Custom Field:
- Before Deletion:
{
"custom_fields": {
"shipment_id": "12345",
"invoice_no": "67890"
}
}
- After Deletion:
{
"custom_fields": {
"invoice_no": "67890"
}
}
- The
shipment_id
custom field is no longer available in the entity, and any references to it will be removed. - The
invoice_no
custom field remains available for use in the entity.
Request
Responses
- 200
- 400
- 401
- 403
- 404
OK
Bad Request
Unauthorized
Forbidden
Not Found