POST/v1/items/bulk-repair

Repair several items with the same patch

Applies one patch to up to 500 items (ITEM-004 bulk edit); the result lists each item with its new status or the error code.

Scope items.write

Body

itemIdsarray of stringrequiredmin items 1max items 500

patchobjectrequired

5 fields

recipientobject

6 fields

namestringmax length 200

addressLine1stringmax length 200

addressLine2string or null

postalCodestringmax length 20

citystringmax length 120

countrystringmax length 40

variablesobject

sendDatedate or null

externalIdstring or null

metadataobject or null

Returns

2 fields of the 200 answer

resultsarray of objectsrequired

4 fields

idstringrequired

statusenum or nullrequired

NEEDS_ATTENTIONSUPPRESSEDHELDPENDING_APPROVALREADYSCHEDULED_FOR_RUNIN_PRODUCTIONCOMPLETEDFAILEDCANCELLEDRETURNEDNOT_SENT

warningsarray of objects

3 fields

codeenumrequired

address_invalidpostal_code_invalidhouse_number_missingcity_missingcountry_not_supporteddestination_not_supportedvariable_missingvariable_type_invalidvariable_too_longimage_fetch_failedimage_resolution_lowtext_overflowexpression_invalidlate_delivery_expectedwaiting_for_fundssuppressedcarrier_codes_missingexcluded_from_run

fieldstringrequired

messagestringrequired

errorstring

repairedintegerrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

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/items/bulk-repair \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "itemIds": [ "itm_01J9Y2K8QF4T6W8Z0B2D4F6H8K" ], "patch": { "recipient": { "name": "Sanne de Vries", "addressLine1": "Oudegracht 112", "postalCode": "3511 AX", "city": "Utrecht", "country": "NL" }, "variables": { "first_name": "Sanne" }, "externalId": "crm-0062p00001Xyz" } }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.items.bulkRepair({ body: { itemIds: [ 'itm_01J9Y2K8QF4T6W8Z0B2D4F6H8K', ], patch: { recipient: { name: 'Sanne de Vries', addressLine1: 'Oudegracht 112', postalCode: '3511 AX', city: 'Utrecht', country: 'NL', }, variables: { first_name: 'Sanne', }, externalId: 'crm-0062p00001Xyz', }, }, });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.items.bulk_repair({ "itemIds": [ "itm_01J9Y2K8QF4T6W8Z0B2D4F6H8K", ], "patch": { "recipient": { "name": "Sanne de Vries", "addressLine1": "Oudegracht 112", "postalCode": "3511 AX", "city": "Utrecht", "country": "NL", }, "variables": { "first_name": "Sanne", }, "externalId": "crm-0062p00001Xyz", }, })

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