POST Api/Account/{accountId}/CustomField
Sets a custom field for a company. The company and the custom field must exist.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
accountId |
Account Id (or Company Id) |
integer |
Required |
Body Parameters
Custom Field data.
AccountCustomFieldRequestViewModelName | Description | Type | Additional information |
---|---|---|---|
CustomField |
Name of the Custom Field. Otherwizse known as the Internal Name. |
string |
None. |
Value |
Depending on the Custom Field Type the value can contain, dates, boolean, numbers, or strings. |
string |
None. |
Values |
For the CustomFieldType.CheckboxList the property contains a list of all selected values. |
Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{ "CustomField": "sample string 1", "Value": "sample string 2", "Values": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<AccountCustomFieldRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePunkt.Api.Server.Requests"> <CustomField>sample string 1</CustomField> <Value>sample string 2</Value> <Values xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Values> </AccountCustomFieldRequestViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.