Delete Plugin Modules API

This API call bulk soft-deletes plugin modules from the module library. Modules are marked as deleted and are not physically removed from the database.

Authentication: Plugin-based authentication using custom headers. Requires a valid plugin authentication token.

Authorization: Only users with "API" role are permitted to use this endpoint. Other roles will receive a 403 Forbidden response.

Ownership Validation: Each module ID in the request is validated to ensure it belongs to the authenticated plugin. If any module belongs to a different plugin, the entire request is rejected with 403 and no modules are deleted.

Behaviour:

Modules that belong to the plugin are soft-deleted (marked as deleted = true).
If any moduleId belongs to another plugin, the request is rejected with 403 and no module is deleted.
Non-existent moduleIds are silently skipped.

Server

https://plugins.stripo.email

Stripo Plugin API server

Client Libraries

Shell Curl

Methods

Plugin module management operations

Methods Operations

post/api/v1/customblocks/v4/modules/bulk-delete

Bulk soft-delete modules

Soft-deletes a list of plugin modules by their IDs. Requires a token with the "API" role. Each module ID is verified to belong to the plugin identified by the authentication token.

Headers

ES-PLUGIN-AUTH
Type: string
required

Stripo plugin auth token in the format — Bearer ${AUTH_TOKEN}. Must have the 'API' role.

Body·

required

application/json

Request body containing module IDs to soft-delete.

moduleIds
Type: array integer[] 1…1000
required

List of module IDs to soft-delete. Min: 1, max: 1000. All IDs must belong to the plugin identified by the authentication token. Non-existent IDs are silently skipped.

Responses

204

All modules soft-deleted successfully. No response body is returned.
400
Type: object ·

Bad request — moduleIds must not be empty or array too large.
message
Type: string

Human-readable error description
application/json
401
Type: object ·

Unauthorized — ES-PLUGIN-AUTH header is missing or the token is invalid or expired.
message
Type: string

Human-readable error description
application/json
403
Type: object ·

Forbidden — either the token does not have the "API" role, or at least one of the provided moduleIds belongs to another plugin. In the latter case no module is deleted.
message
Type: string

Human-readable error description
application/json
500
Type: object ·

Internal server error — Failed to delete modules.
message
Type: string

Human-readable error description
application/json

post/api/v1/customblocks/v4/modules/bulk-delete

curl https://plugins.stripo.email/api/v1/customblocks/v4/modules/bulk-delete \
  --request POST \
  --header 'ES-PLUGIN-AUTH: ' \
  --header 'Content-Type: application/json' \
  --header 'ES-PLUGIN-AUTH: YOUR_SECRET_TOKEN' \
  --data '{
  "moduleIds": [
    101
  ]
}'

No Body

All modules soft-deleted successfully. No response body is returned.

Models

Request body containing module IDs to soft-delete.

moduleIds
Type: array integer[] 1…1000
required

List of module IDs to soft-delete. Min: 1, max: 1000. All IDs must belong to the plugin identified by the authentication token. Non-existent IDs are silently skipped.

message
Type: string

Human-readable error description

Delete Plugin Modules API

AuthenticationRequired

Methods

Bulk soft-delete modules

Models

{} BulkDeleteModulesRequest

{} ErrorResponse