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

Create a mapping preset

Scope postbatches.writeIdempotent with a key

Path parameters

idstringrequired

Headers

Idempotency-Keystringmax length 255

Up to 255 characters, scoped to the organisation and the endpoint, kept for 24 hours: a repeat with the same body replays the stored response with Idempotent-Replayed: true (API-004).

Body

namestringrequiredmin length 1max length 120

headersarray of stringrequiredmin items 1max items 500

mappingobjectrequired

Returns

10 fields of the 201 answer

idstringrequired

templateIdstringrequired

namestringrequired

headersarray of stringrequired

mappingobjectrequired

createdByTypeenumrequired

USERAPI_KEY

createdByIdstringrequired

lastUsedAtdate-time or nullrequired

createdAtdate-timerequired

updatedAtdate-timerequired

Responses

201Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

409A request with this Idempotency-Key is still in progress (idempotency_in_progress)

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 \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Idempotency-Key: crm-0062p00001Xyz-signed" \ -H "Content-Type: application/json" \ -d '{ "name": "Welcome card", "headers": [ "Example" ], "mapping": { "key": "first_name" } }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.mappingPresets.create('tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K', { body: { name: 'Welcome card', headers: [ 'Example', ], mapping: { key: 'first_name', }, },, idempotencyKey: 'crm-0062p00001Xyz-signed', });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.mapping_presets.create("tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", { "name": "Welcome card", "headers": [ "Example", ], "mapping": { "key": "first_name", }, }, idempotency_key="crm-0062p00001Xyz-signed")

{ "id": "mp_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "templateId": "tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "headers": [ "Example" ], "mapping": { "key": "first_name" }, "createdByType": "USER", "createdById": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "lastUsedAt": "2026-10-16T09:14:02.000Z", "createdAt": "2026-10-16T09:14:02.000Z", "updatedAt": "2026-10-16T09:14:02.000Z" }

{ "type": "https://docs.postbuddy.nl/errors/idempotency_in_progress", "title": "Request with this idempotency key in progress", "status": 409, "code": "idempotency_in_progress", "detail": "A request with this Idempotency-Key is still in progress (idempotency_in_progress)", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K" }

{ "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" } ] }