Procurement Connection Mappings

Get Vendor Mapping

Get the vendor mapping configuration for a procurement connection (Ironclad or Tropic). Returns the JSONata mapping (merged with AI suggestions if available), vendor type filters, and dry run mode.

🔒 Requires Connections: Get Procurement Connection Vendor Mapping permission.

Securitybearer
Request
path Parameters
connectionId
required
number
Responses
200
400

Malformed data and/or validation errors

401

Invalid Authorization

403

You are not allowed to perform this action

404

Not Found

412

You must accept the Drata terms and conditions to use the API

500

Internal server error

get/connections/{connectionId}/vendor-mapping
Request samples 
Response samples 
application/json
{
  • "connectionId": 42,
  • "clientType": "IRONCLAD_VENDOR",
  • "vendorMapping": {
    • "name": "properties.counterpartyName.value",
    • "externalId": "id"
    },
  • "vendorTypes": [
    • "vendor",
    • "supplier"
    ],
  • "dryRun": true,
  • "aiMappingSuggested": false
}
Update Vendor Mapping
Update the vendor mapping configuration for a procurement connection (Ironclad or Tropic). Allows modifying the JSONata mapping, vendor type filters, and dry run mode.


🔒 Requires Connections: Update Procurement Connection Vendor Mapping permission.


Securitybearer 
Request 
path Parameters
connectionId
required
number
 
Request Body schema: application/json
required
object or null
JSONata mapping from provider record fields to vendor properties. Keys are vendor field names, values are JSONata expressions.


 
vendorTypes
Array of strings or null
Vendor types to filter from the procurement provider


 
dryRun
boolean
Enable dry run mode (no actual vendor creation/updates). Defaults to true if not set.


 
Responses 
200
400
Malformed data and/or validation errors


401
Invalid Authorization


403
You are not allowed to perform this action


404
Not Found


412
You must accept the Drata terms and conditions to use the API


500
Internal server error


put/connections/{connectionId}/vendor-mapping
Request samples 
application/json
{
  • "vendorMapping": {
    • "name": "properties.counterpartyName.value",
    • "externalId": "id"
    },
  • "vendorTypes": [
    • "vendor",
    • "supplier"
    ],
  • "dryRun": false
}
Response samples 
application/json
{
  • "connectionId": 42,
  • "clientType": "IRONCLAD_VENDOR",
  • "vendorMapping": {
    • "name": "properties.counterpartyName.value",
    • "externalId": "id"
    },
  • "vendorTypes": [
    • "vendor",
    • "supplier"
    ],
  • "dryRun": true,
  • "aiMappingSuggested": false
}