Note: This endpoint is only available for mutable streams.
To delete records, the user must have capabilities to access (write to) the referenced record space.
Batches of records are deleted from a stream with implicit ignoreUnknownIds=true semantic.
The record operations are eventually consistent, but under normal conditions deleted records stop being returned by other endpoints within a few seconds. Sync endpoint is returning a "tombstone" record (which only has a few top level fields and a deleted status) for at least 3 days since deleting the actual record.
Records to delete from a stream.
required | Array of objects (recordItems) [ 1 .. 1000 ] items List of records to delete. |
An empty response is returned if all records from the request are successfully deleted.
The response for a failed request.
Some record identifiers (space and externalId) are duplicated in the request or attempt to delete records from an immutable stream.
If at least one record was not deleted due to an internal error, and all other errors in the failed list were non-retryable,
this error code will be returned.
Note: Record operations are not transactional. This means that during batch delete, some records may be deleted successfully even if the deletion of others fails. The response body indicates which records were successfully deleted and which were not.
An internal server error usually indicates an issue that requires investigation. A simple retry might not help, but a few retries could be a reasonable approach.
Note: If you choose to retry on a 500 error, it is recommended to retry only the failed records rather than the entire request.
If at least one record was not deleted due to the service being temporarily unavailable, this error code will be returned.
Note: Record operations are not transactional. This means that during batch delete, some records may be deleted successfully even if the deletion of others fails. The response body indicates which records were successfully deleted and which were not.
A "service temporarily unavailable" error usually indicates a temporary issue, and several retries may help complete the records deletion.
Note: It is recommended to retry deletion of only the failed records rather than the entire request.
{- "items": [
- {
- "space": "mySpace",
- "externalId": "some_id"
}
]
}{ }