Update an existing custom field. | Virtuous Developer Documentation

curl -X PUT https://prod-api.raisedonors.com/api/CustomField/1 \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Donor Membership Level",
  "entityType": 3,
  "dataType": 2
}'

{
  "id": 42,
  "customCollectionId": 7,
  "name": "Donor Membership Level",
  "displayName": "Membership Level",
  "entityType": 3,
  "entityTypeDisplayName": "Donor",
  "dataType": 2,
  "dataTypeDisplayName": "String",
  "isEnabled": true,
  "canSync": true,
  "formatter": 1,
  "listValues": [
    {
      "id": 101,
      "value": "Gold",
      "active": true,
      "rank": 1
    },
    {
      "id": 102,
      "value": "Silver",
      "active": true,
      "rank": 2
    },
    {
      "id": 103,
      "value": "Bronze",
      "active": true,
      "rank": 3
    }
  ],
  "rank": 1.1,
  "required": true
}

Authentication

Authorizationstring

JWT Authorization header using the Bearer scheme. Example: “Authorization: Bearer {token}”

Path parameters

idlongRequired

The ID of the custom field.

Request

The custom field request model.

namestringRequired1-100 characters

Gets or sets the name.

entityTypeenumRequired

Gets or sets the entity type.

dataTypeenumRequired

Gets or sets the data type.

displayNamestring or nullOptional<=300 characters

Gets or sets the display name.

isEnabledbooleanOptional

Gets or sets a value indicating whether this instance is enabled.

requiredbooleanOptional

Gets or sets a value indicating whether this instance is required.

rankdouble or nullOptional

Gets or sets the rank.

canSyncbooleanOptional

Gets or sets a value indicating whether this instance can synchronize.

formatterenumOptional

Gets or sets the formatter.

listValueslist of objects or nullOptional

Gets or sets the list values.

Response

idlongOptional

Gets or sets the identifier.

customCollectionIdlong or nullOptional

Gets or sets the custom collection identifier.

namestring or nullOptional

Gets or sets the name.

displayNamestring or nullOptional

Gets or sets the display name.

entityTypeenumOptional

Gets or sets the entity type.

entityTypeDisplayNamestring or nullOptional

Gets or sets the entity type display name.

dataTypeenumOptional

Gets or sets the data type.

dataTypeDisplayNamestring or nullOptional

Gets or sets the data type display name.