Skip to content

Publish a channel-mapping lens (remap native → canonical)

POST
/v1/datasets/{dataset_id}/mapping-lens
curl --request POST \
--url https://example.com/v1/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mapping-lens \
--header 'Content-Type: application/json' \
--data '{ "renames": { "additionalProperty": "example" } }'

Human remap for channels the automatic grammar mis-identified or could not identify. The canonical interface and resolver refresh on the next read.

dataset_id
required
string format: uuid
account_id

Act on this account (active)

string | null format: uuid

Act on this account (active)

x-api-key
string | null
Media type application/json
PublishMappingLensBody
object
renames
required
object
>= 1 properties <= 512 properties
key
additional properties
string
Example generated
{
"renames": {
"additionalProperty": "example"
}
}

Successful Response

Media type application/json
Example generated
example

Validation Error

Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationError
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}