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

# \PreferencesApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**list_preferences**](PreferencesApi.md#list_preferences) | **GET** /v1/subscribers/{id}/preferences/ | GET /v1/subscribers/:id/preferences
[**update_global_preference**](PreferencesApi.md#update_global_preference) | **PATCH** /v1/subscribers/{id}/preferences/ | PATCH /v1/subscribers/:id/preferences
[**update_workflow_preference**](PreferencesApi.md#update_workflow_preference) | **PATCH** /v1/subscribers/{id}/preferences/{workflow_id}/ | PATCH /v1/subscribers/:id/preferences/:workflowId



## list_preferences

> Vec<models::PreferenceRecord> list_preferences(id)
GET /v1/subscribers/:id/preferences

### Parameters


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

### Return type

[**Vec<models::PreferenceRecord>**](PreferenceRecord.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)


## update_global_preference

> models::PreferenceRecord update_global_preference(id, update_preference)
PATCH /v1/subscribers/:id/preferences

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**update_preference** | [**UpdatePreference**](UpdatePreference.md) |  | [required] |

### Return type

[**models::PreferenceRecord**](PreferenceRecord.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## update_workflow_preference

> models::PreferenceRecord update_workflow_preference(id, workflow_id, update_preference)
PATCH /v1/subscribers/:id/preferences/:workflowId

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Subscriber ID | [required] |
**workflow_id** | **uuid::Uuid** | Workflow ID | [required] |
**update_preference** | [**UpdatePreference**](UpdatePreference.md) |  | [required] |

### Return type

[**models::PreferenceRecord**](PreferenceRecord.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)