Map a property

POST /v1/bridges/{id}/properties

Map a property

cURL

curl --request POST \
  --url https://pnbr.io/v1/bridges/{id}/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_path": "#/components/schemas/Customer",
  "from_property": "email",
  "to_type_name": "Person",
  "to_shape": "crm",
  "to_property": "email",
  "role": "titular"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from_path: '#/components/schemas/Customer',
    from_property: 'email',
    to_type_name: 'Person',
    to_shape: 'crm',
    to_property: 'email',
    role: 'titular'
  })
};

fetch('https://pnbr.io/v1/bridges/{id}/properties', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://pnbr.io/v1/bridges/{id}/properties"

payload = {
    "from_path": "#/components/schemas/Customer",
    "from_property": "email",
    "to_type_name": "Person",
    "to_shape": "crm",
    "to_property": "email",
    "role": "titular"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "content": [
    {
      "type": "text",
      "text": "Mapped Customer.email -> crm.Person.email [titular].\n\nNext steps:\n  • analyze — Every property on Customer is mapped. Review full coverage."
    }
  ],
  "structuredContent": {
    "ok": true,
    "mapping_id": "fe711e54-05e3-42d7-9e54-1a0527e5638c",
    "from_path": "#/components/schemas/Customer",
    "property_coverage": {
      "mapped": 1,
      "unmapped": 0
    },
    "property_completeness": 1
  }
}

Authorizations

Authorization · string · header · required

A pnbr- API key. Project-scoped keys make project_id implicit; org-scoped keys require it.

Path Parameters

id · string · required

Body

application/json

from_path · string

from_property · string

to_property · string

role · string

Response

200 - application/json

The recorded property mapping.