custom-fields-delete

Availability

Breeze 4

Description

Deletes a custom field.

The value of is-primary for a custom field must be false before the field can be deleted. If is-primary is true and you want to change its value, call custom-field-update.

Request URL

 http://server_name/api/xml 
     ?action=custom-fields-delete 
     &field-id=string 
     &object-type=allowedValue 
     &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
field-id	String	Y	The ID of the field to be deleted. Call custom-fields-delete to obtain the ID, which is returned in the field-id attribute of the field element.
object-type	String	Y	The type of SCO for which the field is defined (for values, see type).
session	String	N	The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

 <?xml version="1.0" encoding="utf-8" ?>  
 <results>  
     <status code=allowedValue />  
 </results>

Response values

Element	Attribute	Type	Description
results		Container	All results the action returns.
status		Empty, with attributes	The status of the response.
	code	Allowed value	A code indicating the response status (see status).

Sample request

 https://example.com/api/xml?action=custom-fields-delete&field-id=2006338719&object-type=object-type-principal

Sample response

 <?xml version="1.0" encoding="utf-8" ?> 
 <results> 
     <status code="ok" />  
 </results>

Sign in to your account

custom-fields-delete

Ask the Community

Contact Us