Delete Events

5min

About
Remove event messages from the events queue of the Jetstream user whose access key is being used. Events are removed in batches using the batch ID. Events are removed individually or as a collection using event IDs.
Parameters
Property
Location
Details
AccessKey
string
Required
Unique
Header
The access key for your user account.
This value is a 36-character GUID provided during user account sign up.
BatchId
string
Unique
Body
The batch ID associated with the batch of event messages to be removed.
This value is a 36-character GUID provided via a Get Events﻿ request.
Each Get Events﻿ request returns a batch of event messages along with an associated batch ID. By using this batch ID with a Delete Events request, all events within this batch can be removed.
EventIds
array(string)
Unique
Body
The set of event IDs associated with the individual event message or collection of event messages to be removed.
Each value is a 36-character GUID associated with an event message.
More than 100 event IDs may not be defined, despite the fact that more than 100 events may be returned via a Get Events﻿ request.
More Info
Delete Events requires that either the BatchId property or the EventId property be defined with each request. You may not pass both at the same time. If you need to remove individual events and a batch of events, you must make two separate requests.
Examples
Example Delete by BatchId
Request URL
DELETE https://api.jetstreamrfid.com/2/events
Request Body
{
    "BatchId": "c15d316b-5fc3-4a7f-a2ba-b1a96aabcd32"
}
Response Code
204 No Content
Response Body
None Returned
Example Delete by EventIds
Request URL
DELETE https://api.jetstreamrfid.com/2/events
Request Body
{
    "EventIds": [
        "8af92758-451c-4082-a455-d57e927676a8",
        "64f295f7-ceb6-46aa-a5d0-2a66e7009ff0"
    ]
}
Response Code
204 No Content
Response Body
None Returned
Version Changes
Replaces RemoveEvents

Property	Location	Details
AccessKey string Required Unique	Header	The access key for your user account. This value is a 36-character GUID provided during user account sign up.
BatchId string Unique	Body	The batch ID associated with the batch of event messages to be removed. This value is a 36-character GUID provided via a Get Events request. Each Get Events request returns a batch of event messages along with an associated batch ID. By using this batch ID with a Delete Events request, all events within this batch can be removed.
EventIds array(string) Unique	Body	The set of event IDs associated with the individual event message or collection of event messages to be removed. Each value is a 36-character GUID associated with an event message. More than 100 event IDs may not be defined, despite the fact that more than 100 events may be returned via a Get Events request.

Updated 25 Mar 2024

Get Events

Event Types