enbbox 1.0.1

Notification infrastructure API — open-source alternative to Novu/Courier
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

# \MessagesApi

All URIs are relative to *https://api.enbbox.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_by_transaction**](MessagesApi.md#delete_by_transaction) | **DELETE** /v1/messages/transaction/{transaction_id}/ | DELETE /v1/messages/transaction/:transaction_id — delete all messages by transaction
[**delete_message**](MessagesApi.md#delete_message) | **DELETE** /v1/messages/{id}/ | DELETE /v1/messages/:id — soft-delete a single message
[**list_messages**](MessagesApi.md#list_messages) | **GET** /v1/messages/ | GET /v1/messages — list all messages with cursor pagination



## delete_by_transaction

> delete_by_transaction(transaction_id)
DELETE /v1/messages/transaction/:transaction_id — delete all messages by transaction

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**transaction_id** | **String** | Transaction ID | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_message

> delete_message(id)
DELETE /v1/messages/:id — soft-delete a single message

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Message ID | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_messages

> models::CursorPaginatedMessageRecord list_messages(limit, after, before, channel, subscriber_id, q)
GET /v1/messages — list all messages with cursor pagination

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u32**> | Maximum number of items to return (1–100, default: 25). |  |
**after** | Option<**String**> | Cursor for next page (ISO 8601 timestamp from previous response). |  |
**before** | Option<**String**> | Cursor for previous page. |  |
**channel** | Option<**String**> | Filter by channel type. |  |
**subscriber_id** | Option<**String**> | Filter by subscriber identifier. |  |
**q** | Option<**String**> | Optional full-text search query (e.g. content, subject, subscriber_id). |  |

### Return type

[**models::CursorPaginatedMessageRecord**](CursorPaginated_MessageRecord.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)