POST api/CustomFields/SaveCustomField
Request Information
URI Parameters
None.
Body Parameters
SaveCustomFieldRequestVMName | Description | Type | Additional information |
---|---|---|---|
ParentAccountId | string |
Required |
|
AccountId | string |
Required |
|
UserId | string |
Required |
|
FieldName | string |
Required |
|
FieldType | CustomFieldType |
Required |
|
Group | CustomFieldGroup |
None. |
|
GroupId | string |
None. |
|
InternalFieldName | string |
None. |
|
Description | string |
None. |
|
Options | Collection of CustomFieldOptionsRequestVM |
None. |
|
AccountIds | Collection of string |
None. |
|
IsReadOnly | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "ParentAccountId": "sample string 1", "AccountId": "sample string 2", "UserId": "sample string 3", "FieldName": "sample string 4", "FieldType": "Text", "Group": "All", "GroupId": "sample string 5", "InternalFieldName": "sample string 6", "Description": "sample string 7", "Options": [ { "Id": "sample string 1", "OptionText": "sample string 2", "Order": 3, "Tags": [ "sample string 1", "sample string 2" ] }, { "Id": "sample string 1", "OptionText": "sample string 2", "Order": 3, "Tags": [ "sample string 1", "sample string 2" ] } ], "AccountIds": [ "sample string 1", "sample string 2" ], "IsReadOnly": true }
application/xml, text/xml
Sample:
<SaveCustomFieldRequestVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.RequestViewModels.CustomFieldsRequestModels"> <AccountId>sample string 2</AccountId> <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </AccountIds> <Description>sample string 7</Description> <FieldName>sample string 4</FieldName> <FieldType>Text</FieldType> <Group>All</Group> <GroupId>sample string 5</GroupId> <InternalFieldName>sample string 6</InternalFieldName> <IsReadOnly>true</IsReadOnly> <Options> <CustomFieldOptionsRequestVM> <Id>sample string 1</Id> <OptionText>sample string 2</OptionText> <Order>3</Order> <Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Tags> </CustomFieldOptionsRequestVM> <CustomFieldOptionsRequestVM> <Id>sample string 1</Id> <OptionText>sample string 2</OptionText> <Order>3</Order> <Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Tags> </CustomFieldOptionsRequestVM> </Options> <ParentAccountId>sample string 1</ParentAccountId> <UserId>sample string 3</UserId> </SaveCustomFieldRequestVM>
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.