Delete emails by submitting their IDs, literal email-ID prefixes, or their union. Requests require a plugin token with the API role and apply only to emails belonging to that plugin.
A 202 response confirms that a deletion job was stored, not that deletion finished. If needed, poll the job and inspect its item results before considering the request complete. Deleted data cannot be restored.
Stripo Plugin API server
Email model deletion jobs
Accepts emailIds, emailIdPatterns, or both. At least one array must be
nonempty. A field may be omitted or empty when the other is nonempty;
explicit null, non-array values, invalid elements, and unknown fields
return 400 before a job is created. The request body is limited to 1 MiB.
emailIds are literal IDs, including any *.
At most 1000 distinct explicit IDs are accepted.
Duplicate IDs and overlapping selections are processed once.
Each pattern must contain exactly one *, at the end, after at least
three literal Unicode code points. Matching preserves case and treats
%, _, and ! in the prefix as literal characters.
Retry key scoped to the plugin and DELETE operation. The same key and
normalized selector arrays return the existing job. Order and duplicate
selectors do not change the selection identity; both emailIds and
emailIdPatterns participate. Reusing the key with a different selector
set returns 409. Keep the returned job ID for subsequent reads;
idempotency is limited by the lifetime of the stored job.
Provide a nonempty emailIds array, a nonempty emailIdPatterns array, or both. Either field may be omitted or empty when the other is nonempty. Neither field nor its elements may be null.
Provide a nonempty emailIds array, a nonempty emailIdPatterns array, or both. Either field may be omitted or empty when the other is nonempty. Neither field nor its elements may be null.
Provide a nonempty emailIds array, a nonempty emailIdPatterns array, or both. Either field may be omitted or empty when the other is nonempty. Neither field nor its elements may be null.
Literal email-ID prefixes in this plugin's namespace, each followed by one terminal wildcard. Duplicate and overlapping patterns are accepted; every discovered email is processed once. There is no per-pattern result count or limit of 1000 discovered candidates.
Job persisted. Deletion may still be pending or running.
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
Time after which the job and its items may no longer be available.
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
Invalid body, empty combined selection, null or malformed selector arrays, invalid email IDs or patterns, excess distinct explicit IDs, unknown request fields, cursor, status filter, or page size.
Missing or invalid plugin authentication.
The plugin token does not have the API role.
HTTP method is not supported for this path.
Idempotency key reused for another selection or invalid control transition.
Rate limit exceeded. Retry after the indicated delay.
Unexpected server error; include the X-Trace-Id in support requests.
The service is temporarily unavailable. Try again later.
curl https://plugins.stripo.email/coediting/v1/emails/delete-jobs \
--request POST \
--header 'Content-Type: application/json' \
--header 'ES-PLUGIN-AUTH: YOUR_SECRET_TOKEN' \
--data '{
"emailIds": [
"email-123"
]
}'
{
"jobId": "gcj_0123456789abcdef0123456789abcdef",
"status": "QUEUED",
"createdAt": "2026-09-29T08:00:00Z",
"startedAt": null,
"finishedAt": null,
"expiresAt": "2026-09-30T08:00:00Z",
"progress": {
"total": null,
"discovered": 0,
"processed": 0,
"running": 0,
"succeeded": 0,
"skipped": 0,
"failed": 0,
"remaining": null,
"percentage": null
}
}Job persisted. Deletion may still be pending or running.
Returns the current state. The total, remaining, and percentage
progress fields are null until discovery finishes. discovered counts
unique candidates across both selector arrays.
Job ID returned by the create endpoint.
Current job status and progress.
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
Time after which the job and its items may no longer be available.
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
Missing or invalid plugin authentication.
The plugin token does not have the API role.
Job not found, expired, owned by another plugin, or for another operation.
HTTP method is not supported for this path.
Rate limit exceeded. Retry after the indicated delay.
Unexpected server error; include the X-Trace-Id in support requests.
The service is temporarily unavailable. Try again later.
curl 'https://plugins.stripo.email/coediting/v1/emails/delete-jobs/{jobId}' \
--header 'ES-PLUGIN-AUTH: YOUR_SECRET_TOKEN'
{
"jobId": "string",
"status": "QUEUED",
"createdAt": "2026-10-22T09:34:23.529Z",
"startedAt": null,
"finishedAt": null,
"expiresAt": "2026-10-22T09:34:23.529Z",
"progress": {
"total": null,
"discovered": 1,
"processed": 1,
"running": 1,
"succeeded": 1,
"skipped": 1,
"failed": 1,
"remaining": null,
"percentage": null
}
}Current job status and progress.
Returns one page of results for the authenticated plugin's job.
Follow nextCursor until it is absent. The cursor is opaque.
Results may change while the job is running; inspect them again after
a terminal job status if a final accounting is required.
Job ID returned by the create endpoint.
Opaque nextCursor returned by the previous page.
Items per page; defaults to 50.
Optional case-insensitive item-status filter.
Page of per-email results.
Omitted when there is no next page.
Invalid body, empty combined selection, null or malformed selector arrays, invalid email IDs or patterns, excess distinct explicit IDs, unknown request fields, cursor, status filter, or page size.
Missing or invalid plugin authentication.
The plugin token does not have the API role.
Job not found, expired, owned by another plugin, or for another operation.
HTTP method is not supported for this path.
Rate limit exceeded. Retry after the indicated delay.
Unexpected server error; include the X-Trace-Id in support requests.
The service is temporarily unavailable. Try again later.
curl 'https://plugins.stripo.email/coediting/v1/emails/delete-jobs/{jobId}/items?pageSize=50&status=PENDING' \
--header 'ES-PLUGIN-AUTH: YOUR_SECRET_TOKEN'
{
"items": [
{
"emailId": "email-123",
"status": "SUCCEEDED",
"attempt": 1,
"error": null
},
{
"emailId": "email-456",
"status": "FAILED",
"attempt": 1,
"error": {
"code": "ROW_TOO_LARGE",
"message": "The email could not be processed"
}
}
],
"nextCursor": "2"
}Page of per-email results.
Provide a nonempty emailIds array, a nonempty emailIdPatterns array, or both. Either field may be omitted or empty when the other is nonempty. Neither field nor its elements may be null.
Provide a nonempty emailIds array, a nonempty emailIdPatterns array, or both. Either field may be omitted or empty when the other is nonempty. Neither field nor its elements may be null.
Provide a nonempty emailIds array, a nonempty emailIdPatterns array, or both. Either field may be omitted or empty when the other is nonempty. Neither field nor its elements may be null.
Literal email-ID prefixes in this plugin's namespace, each followed by one terminal wildcard. Duplicate and overlapping patterns are accepted; every discovered email is processed once. There is no per-pattern result count or limit of 1000 discovered candidates.
Exactly one * is required at the end, preceded by at least three
literal Unicode code points. The prefix must not consist entirely of
whitespace and must fit 100 UTF-8 bytes; the composed plugin model-ID
prefix must also fit its server limit. maxLength is a Unicode-code-point
upper bound; the server additionally enforces the UTF-8 byte limit.
Double quotes, backslashes, tabs, carriage returns, and newlines are
forbidden in the prefix. Matching is case-sensitive; %, _, and !
are literal. IDs and prefixes are not trimmed or lowercased.
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
Time after which the job and its items may no longer be available.
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
Unique candidates recorded so far across IDs and patterns.
Signed 64-bit integers (long type).
Sum of succeeded, skipped, and failed items.
Signed 64-bit integers (long type).
Signed 64-bit integers (long type).
Signed 64-bit integers (long type).
Signed 64-bit integers (long type).
Final unique candidate count; null until discovery finishes.
Omitted when there is no next page.
Integer numbers.
Machine-readable reason; possible codes can evolve.
Human-readable explanation.