POST/v1/templates/{id}/mapping-presets/suggest

Suggest a mapping for CSV headers

Scope templates.read

Path parameters

idstringrequired

Body

headersarray of stringrequiredmin items 1max items 500

mappingobject

Returns

4 fields of the 200 answer

presetobject or nullrequired

3 fields

idstringrequired

namestringrequired

similaritynumberrequired

targetsarray of objectsrequired

3 fields

namestringrequired

requiredbooleanrequired

kindenumrequired

recipientvariable

mappingobjectrequired

issuesarray of objectsrequired

5 fields

codeenumrequired

unknown_targetunknown_columnunmapped_requiredunused_columnempty_expression

severityenumrequired

errorwarning

messagestringrequired

targetstring

columnstring

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

422Validation failed

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

curl -X POST https://api.postbuddy.nl/v1/templates/tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K/mapping-presets/suggest \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "headers": [ "Example" ] }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.mappingPresets.suggest('tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K', { body: { headers: [ 'Example', ], }, });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.mapping_presets.suggest("tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", { "headers": [ "Example", ], })

{ "preset": { "id": "mp_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "similarity": 1 }, "targets": [ { "name": "Welcome card", "required": false, "kind": "recipient" } ], "mapping": { "key": "first_name" }, "issues": [ { "code": "unknown_target", "severity": "error", "message": "The postal code is not valid", "target": "Example", "column": "Example" } ] }

{ "type": "https://docs.postbuddy.nl/errors/validation_failed", "title": "Validation failed", "status": 422, "code": "validation_failed", "detail": "Validation failed", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "errors": [ { "field": "recipient.postalCode", "code": "invalid_string", "message": "Invalid postal code" } ] }