Skip to content
BookendBookend Docs

Create a core field map version

POST
/v1/core-field-maps
curl --request POST \
  --url http://localhost:8080/v1/core-field-maps \
  --header 'Content-Type: application/json' \
  --data '{ "providerId": "example", "mapping": "example" }'

Adds a new immutable version for a provider and activates it, deactivating the previous active version. mapping is { provider, fields: [{ canonical, core, transform? }] } and mapping.provider must equal providerId. Administrators only. 400 with field errors for an unknown provider, an empty field list, an entry without canonical/core, an unknown transform or a core field mapped twice.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Body of POST /v1/core-field-maps: a new version for a provider (immutable; the previous version is deactivated).

object
providerId
string
mapping
Examplegenerated
{
  "providerId": "example",
  "mapping": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
id
required
string format: uuid
providerId
required
string
version
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
isActive
required
boolean
mapping
required

A validated JSON document destined for a jsonb / nvarchar(max) ISJSON column. Distinct from string so the persistence layer can bind it with the right provider type on each dialect.

createdAt
required
string format: date-time
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "providerId": "example",
  "version": 1,
  "isActive": true,
  "mapping": "example",
  "createdAt": "2026-04-15T12:00:00Z"
}