TechNote (Archived)

Deleting custom fields in Breeze 5 using the XML API

Issue

---

In Breeze 5, a new required parameter to delete a custom field from Breeze was added. If you are using the same XML API calls created in Breeze 4.x, the custom field will not be deleted.

Reason

---

In Breeze 5.x, a new required parameter object-type was added to the customer-fields-delete action, which is used to specify the type of the data you are updating.

Solution

---

For Breeze 4.x applications, simply addobject-type=object-type-principal to thecustomer-fields-delete action.

For Breeze 5.x applications, use the following:

Action	Description - XML API Action
customer-fields-delete	Deletes the specified custom field.
Parameters	Type	Description - Parameters
	account-id	Integer	OPTIONAL: The account-id to which the field belongs (FOR HOSTED ONLY)
	object-type	String	REQUIRED: The type of ACL that this field applies to. The following type is supported: object-type-principal
	field-id	Integer	REQUIRED: The ID of the field to be deleted , this ID was created randomly by Breeze (call the custom-fields XML API to obtain the field-id).

Below is an example using the browser to call thecustomer-fields-delete action:

http://breezecentral.com/api/xml?action=custom-fields-delete&account-id=12808252&object-type=object-type-principal&field-id=x-41909301

Search Support

---