Mapping targets and presets of the template

Scope items.read

Path parameters

idstringrequired

Returns

2 fields of the 200 answer

targetsarray of objectsrequired

3 fields

namestringrequired

requiredbooleanrequired

kindenumrequired

recipientvariable

presetsarray of objectsrequired

4 fields

idstringrequired

namestringrequired

headersarray of stringrequired

mappingobjectrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

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

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/postbatches/pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K/mapping-presets \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY"

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.postbatches.mappingPresets('pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.postbatches.mapping_presets("pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K")

Response

{
  "targets": [
    {
      "name": "Welcome card",
      "required": false,
      "kind": "recipient"
    }
  ],
  "presets": [
    {
      "id": "mp_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
      "name": "Welcome card",
      "headers": [
        "Example"
      ],
      "mapping": {
        "key": "first_name"
      }
    }
  ]
}

{
  "type": "https://docs.postbuddy.nl/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Not found",
  "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K"
}