POST/v1/media/delete

Delete unused images and fonts in bulk

Scope templates.write

Body

assetIdsarray of stringmax items 500default []

fontIdsarray of stringmax items 500default []

Returns

2 fields of the 200 answer

deletedarray of stringrequired

refusedarray of objectsrequired

3 fields

idstringrequired

reasonstringrequired

usagesarray of objectsrequired

4 fields

templateIdstringrequired

templateNamestringrequired

versioninteger or nullrequired

archivedbooleanrequired

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/media/delete \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "assetIds": [ "ast_01J9Y2K8QF4T6W8Z0B2D4F6H8K" ], "fontIds": [ "fnt_01J9Y2K8QF4T6W8Z0B2D4F6H8K" ] }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.media.bulkDelete({ body: { assetIds: [ 'ast_01J9Y2K8QF4T6W8Z0B2D4F6H8K', ], fontIds: [ 'fnt_01J9Y2K8QF4T6W8Z0B2D4F6H8K', ], }, });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.media.bulk_delete({ "assetIds": [ "ast_01J9Y2K8QF4T6W8Z0B2D4F6H8K", ], "fontIds": [ "fnt_01J9Y2K8QF4T6W8Z0B2D4F6H8K", ], })

{ "deleted": [ "Example" ], "refused": [ { "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "reason": "Example", "usages": [ { "templateId": "tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "templateName": "Example", "version": 1, "archived": false } ] } ] }

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