AVB LINQ Public API

CustomFieldDefinitionRequest

Custom Fields

The following routes are available for this service:
PUT	/customfields/config	Creates or updates Custom Field definitions for your account.

**CustomFieldDefinitionRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CustomFieldDefinitionValues	body	List<CustomFieldDefinitionValueRequest>	No

**CustomFieldDefinitionValueRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CustomFieldId	body	int?	No
DisplayName	body	string	Yes
FieldDataType	body	string	Yes	Allowed values: Text Integer Date Decimal Checkbox Currency Dropdown
ShowOnWebsite	body	bool	No
WebsiteTitle	body	string	No
WebsiteSortOrder	body	int?	No
CategoryId	body	int?	No	Optional category ID, typically with a value of 1. Only applies for Create.
ClearOverride	body	bool?	No	Optional flag to request the clearning of an overridden global custom field for a dealer
BrandIds	body	List<int>	No	Associated BrandIDs

**CustomFieldDefinitionResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /customfields/config HTTP/1.1 
Host: avb-pos.avbportal.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"customFieldDefinitionValues":[{"customFieldId":0,"displayName":"String","fieldDataType":"String","showOnWebsite":false,"websiteTitle":"String","websiteSortOrder":0,"categoryId":0,"clearOverride":false,"brandIds":[0]}]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}