Web Service Documentation / Categories / Basic Account Services / Edit Custom Field
Updated on May 9, 2014
This web service updates a specified custom field. This custom field is used by the data exchange web services during the connection/share process.
24.0
PUT
/dataExchangeSettings/customField/(customFieldId)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials | |
Content-Type | application/xml |
Yes
Parameter Name | Description |
---|---|
customFieldId | Id to the custom field |
Request/Response | Schema Name |
---|---|
Request | customField.xsd |
Response | response.xsd |
The following example updates a custom field that has an id of 46.
PUT /dataExchangeSettings/customField/46<?xml version="1.0" encoding="UTF-8"?> <customField whenToPrompt="Property" name="FG ID" required="true" validCharacters="Any"> <minChars>1</minChars> <maxChars>12</maxChars> <description>Federal ID</description> <example>FG 323</example> <displayOrder>1</displayOrder> <url>http://www.acme.com</url> </customField>
The following example indicates that the custom field was successfully updated. It also returns the new custom field id of 46 and a link to web service to retrieve the custom field.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
<id>46</id>
<links>
<link httpMethod="GET" link="/dataExchangeSettings/customField/46" linkDescription="This is the GET url for this custom field."/>
</links>
</response>