Skip to main content
POST
/
api
/
contact
/
map-excess-data
Map excess fields for contact payload
curl --request POST \
  --url https://your-instance.example.com/api/contact/map-excess-data \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceText": "Jane Doe, +1-416-555-0100, jane@example.com, lead from referral",
  "existingSchema": {
    "firstName": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "phoneNumber": {
      "type": "string"
    }
  },
  "mappedData": {
    "firstName": "Jane",
    "email": "jane@example.com",
    "phoneNumber": "+14165550100"
  },
  "excessData": {
    "note": "lead from referral"
  }
}
'
{
  "success": true,
  "message": "Excess data mapped successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
sourceText
string

Raw lead text the AI mapper should re-parse into structured contact fields.

​
existingSchema
object

Field definitions describing the target schema the mapper should populate.

​
mappedData
object

Already-mapped first-class fields; the server protects these from being overwritten when re-mapping.

​
excessData
object

Previously-unmapped key/value pairs (from misc) to re-evaluate for promotion to first-class fields.

Response

Mapped excess data

The response is of type object.