/bulkImportMappingTypes/{mappingTypeName}

name

string

The unique name of the mapping type

displayName

string

A human readable version of the field name

allowMultipleMode

string

If Single, you can only apply one of this mapping in a single job;
If SinglePerType, the entity can only have one value per type at a time (e.g. one Home Phone, and one Cell Phone) so you can specify multiple of this mapping as long as they are of different types;
If Multiple, the entity may have many values set for this Field and you can apply as many of this mapping in one request as desired

resourceTypes

array

The names of the resourceType to which this field can be applied, such as Contacts or Contributions

fields

array

An array describing the possible field/column mappings available for this mapping type.

name

string

The name of the field/column

description

string

A human readable description of the column

hasPredefinedValues

bool

Whether the column requires a predefined set of possible values, under at least some circumstances

isRequired

bool

If true, the value for this field must be provided in bulk import, either from a mapped column or static value

canBeMappedToColumn

bool

Whether the column can draw values from your uploaded file, rather than requiring values be set statically for the entire upload file

parents

array

An array of other fields which must be mapped if this field has prerequisite dependencies

parentFieldName

string

The name of a field which must be mapped in order for the child mapping to be created

limitedToParentValues

array

Optional; A collection of permitted values for the parent field that is a prerequisite for the child mapping. Will be null if there is no constraint on the parent value.

name

string

The name of the permitted value

id

string

The unique identifier of the permitted value