You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/DeletionAndSuppressionApi.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ All URIs are relative to *https://api.segmentapis.com*
21
21
22
22
Create Cloud Source Regulation
23
23
24
-
Creates a Source-scoped regulation. Please Note: Suppression rules at the Workspace level take precedence over those at the Source level. If a user has been suppressed at the Workspace level, any attempt to un-suppress at the Source level is not supported and the processing of the request will fail in Segment Config API omitted fields: - `attributes`, - `userAgent`
24
+
Creates a Source-scoped regulation. Please Note: Suppression rules at the Workspace level take precedence over those at the Source level. If a user has been suppressed at the Workspace level, any attempt to un-suppress at the Source level is not supported and the processing of the request will fail in Segment Config API omitted fields: - `attributes`, - `userAgent`Rate limit headers will be updated to reflect regulation-specific limits (tracked separately for Segment-only vs Segment & Destination regulation types): - X-RateLimit-Remaining: Remaining requests for the regulation type category - Segment-only Regulations: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - Segment & Destination Regulations: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-RateLimit-Reset: RFC 5322 timestamp for when the quota resets (for example, Tue, 31 Dec 2024 23:59:59 GMT)
25
25
26
26
### Example
27
27
@@ -84,7 +84,7 @@ public class Example {
84
84
### HTTP response details
85
85
| Status code | Description | Response headers |
86
86
|-------------|-------------|------------------|
87
-
|**200**| OK |-|
87
+
|**200**| OK |* X-RateLimit-Remaining - Remaining requests in the current period for the regulation type category. Tracked separately for Segment-only vs Segment & Destination regulation types. <br> * X-RateLimit-Consumed - Number of requests consumed in the current period for the regulation type category. Tracked separately for Segment-only vs Segment & Destination regulation types. <br> * X-RateLimit-Reset - RFC 5322 timestamp indicating when the regulation quota resets for the specific regulation type category. <br>|
88
88
|**404**| Resource not found | - |
89
89
|**422**| Validation failure | - |
90
90
|**429**| Too many requests | - |
@@ -96,7 +96,7 @@ public class Example {
96
96
97
97
Create Source Regulation
98
98
99
-
Creates a Source-scoped regulation. Please Note: Suppression rules at the Workspace level take precedence over those at the Source level. If a user has been suppressed at the Workspace level, any attempt to un-suppress at the Source level is not supported and the processing of the request will fail in Segment • When called, this endpoint may generate the `Source Regulation Created` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `attributes`, - `userAgent`
99
+
Creates a Source-scoped regulation. Please Note: Suppression rules at the Workspace level take precedence over those at the Source level. If a user has been suppressed at the Workspace level, any attempt to un-suppress at the Source level is not supported and the processing of the request will fail in Segment • When called, this endpoint may generate the `Source Regulation Created` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `attributes`, - `userAgent` Rate limit headers will be updated to reflect regulation-specific limits (tracked separately for Segment-only vs Segment & Destination regulation types): - X-RateLimit-Remaining: Remaining requests for the regulation type category - Segment-only Regulations: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - Segment & Destination Regulations: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-RateLimit-Reset: RFC 5322 timestamp for when the quota resets (for example, Tue, 31 Dec 2024 23:59:59 GMT)
100
100
101
101
### Example
102
102
@@ -159,7 +159,7 @@ public class Example {
159
159
### HTTP response details
160
160
| Status code | Description | Response headers |
161
161
|-------------|-------------|------------------|
162
-
|**200**| OK |-|
162
+
|**200**| OK |* X-RateLimit-Remaining - Remaining requests in the current period for the regulation type category. Tracked separately for Segment-only vs Segment & Destination regulation types. <br> * X-RateLimit-Consumed - Number of requests consumed in the current period for the regulation type category. Tracked separately for Segment-only vs Segment & Destination regulation types. <br> * X-RateLimit-Reset - RFC 5322 timestamp indicating when the regulation quota resets for the specific regulation type category. <br>|
163
163
|**404**| Resource not found | - |
164
164
|**422**| Validation failure | - |
165
165
|**429**| Too many requests | - |
@@ -171,7 +171,7 @@ public class Example {
171
171
172
172
Create Workspace Regulation
173
173
174
-
Creates a Workspace-scoped regulation. • When called, this endpoint may generate the `Workspace Regulation Created` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `attributes`, - `userAgent`
174
+
Creates a Workspace-scoped regulation. • When called, this endpoint may generate the `Workspace Regulation Created` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `attributes`, - `userAgent`Rate limit headers will be updated to reflect regulation-specific limits (tracked separately for Segment-only vs Segment & Destination regulation types): - X-RateLimit-Remaining: Remaining requests for the regulation type category - Segment-only Regulations: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - Segment & Destination Regulations: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-RateLimit-Reset: RFC 5322 timestamp for when the quota resets (for example, Tue, 31 Dec 2024 23:59:59 GMT)
175
175
176
176
### Example
177
177
@@ -232,7 +232,7 @@ public class Example {
232
232
### HTTP response details
233
233
| Status code | Description | Response headers |
234
234
|-------------|-------------|------------------|
235
-
|**200**| OK |-|
235
+
|**200**| OK |* X-RateLimit-Remaining - Remaining requests in the current period for the regulation type category. Tracked separately for Segment-only vs Segment & Destination regulation types. <br> * X-RateLimit-Consumed - Number of requests consumed in the current period for the regulation type category. Tracked separately for Segment-only vs Segment & Destination regulation types. <br> * X-RateLimit-Reset - RFC 5322 timestamp indicating when the regulation quota resets for the specific regulation type category. <br>|
0 commit comments