Batch delete pull events by ID

POST

/v1/pull-endpoints/{id}/events/delete-batch

curl --request POST \
  --url https://api.hookbridge.io/v1/pull-endpoints/01935abc-def0-7123-4567-890abcdef012/events/delete-batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "message_ids": [ "01935abc-def0-7123-4567-890abcdef012", "01935abc-def0-7123-4567-890abcdef013" ] }'

• Production

Soft-delete a batch of pull events by their IDs. Returns per-ID outcomes: deleted, already_deleted, or not_found. Maximum 100 IDs per request.

Note: the request body uses message_ids (shared schema across all message families). In this context, each entry is a pull event ID.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Pull endpoint identifier (UUIDv7)

Example

01935abc-def0-7123-4567-890abcdef012

Request Body^required

Media typeapplication/json

object

message_ids

required

List of message IDs to delete (max 100)

Array<string>

>= 1 items <= 100 items

Example

{
  "message_ids": [
    "01935abc-def0-7123-4567-890abcdef012",
    "01935abc-def0-7123-4567-890abcdef013"
  ]
}

Responses

200

Batch delete results

Media typeapplication/json

object

data

object

results

required

Array<object>

object

event_id

required

The event ID

string

outcome

required

The outcome for this event

string

Allowed values: deleted already_deleted not_found

deleted_at

Timestamp when the event was deleted (present for deleted and already_deleted outcomes)

string format: date-time

deleted_count

required

Number of events newly deleted

integer

already_deleted_count

required

Number of events that were already deleted

integer

not_found_count

required

Number of event IDs not found

integer

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "data": {
    "results": [
      {
        "event_id": "01935abc-def0-7123-4567-890abcdef012",
        "outcome": "deleted",
        "deleted_at": "2026-04-05T14:23:11.123Z"
      },
      {
        "event_id": "01935abc-def0-7123-4567-890abcdef013",
        "outcome": "not_found"
      }
    ],
    "deleted_count": 1,
    "already_deleted_count": 0,
    "not_found_count": 1
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

400

Invalid request

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Examples

Endpoint not found

{
  "error": {
    "code": "ENDPOINT_NOT_FOUND",
    "message": "endpoint not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid endpoint ID format

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "endpoint_id must be in format ep_xxx"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid payload

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "payload must be valid JSON"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid headers

{
  "error": {
    "code": "INVALID_HEADERS",
    "message": "header 'Host' is forbidden and cannot be overridden"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

401

Unauthorized - Invalid or missing API key

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

404

Resource not found

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Message not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

500

Internal server error

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An internal error occurred"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}