Skip to main content
POST
Create a Custom Field
Send its name and displayName, the entityType it is collected on, and its dataType; for a picklist, include the listValues to choose from. Returns the created field with its new id.

Authorizations

Authorization
string
header
required

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

Body

The custom field request model.

Custom field request model.

name
string
required

The name of the custom field.

Required string length: 1 - 100
entityType
enum<integer>
required

The type of record the custom field is collected on, such as Donor or Gift.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
dataType
enum<integer>
required

The type of value the custom field holds, such as Text, Number, or Date.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8
displayName
string | null

The name shown to donors on the page.

Maximum string length: 300
isEnabled
boolean

Whether this instance is enabled.

required
boolean

Whether this instance is required.

rank
number<double> | null

The position of the custom field in the order it is displayed in.

canSync
boolean

Whether this instance can synchronize.

formatter
enum<integer>

How the value is formatted when it is displayed.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
listValues
object[] | null

The values a donor can choose from, for fields that offer a list.

Response

OK

Custom field model.

id
integer<int64>

The unique identifier of the custom field.

customCollectionId
integer<int64> | null

The unique identifier of the custom collection the field belongs to.

name
string | null

The name of the custom field.

displayName
string | null

The name shown to donors on the page.

entityType
enum<integer>

The type of record the custom field is collected on, such as Donor or Gift.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
entityTypeDisplayName
string | null

The entity type display name.

dataType
enum<integer>

The type of value the custom field holds, such as Text, Number, or Date.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8
dataTypeDisplayName
string | null

The data type display name.

isEnabled
boolean

Whether this instance is enabled.

canSync
boolean

Whether this instance can synchronize.

formatter
enum<integer>

How the value is formatted when it is displayed.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
listValues
object[] | null

The values a donor can choose from, for fields that offer a list.

rank
number<double> | null

The rank of the custom field.

required
boolean

Whether this custom field is required.

Last modified on July 28, 2026