Push Unsubscribes
A Push Unsubscribe represents a global opt-out for all push notifications. It allows targets (such as email addresses) to be excluded from any future push dispatches.
The PushUnsubscribe model
This model contains the identifier of the target that has unsubscribed from all pushes, along with the timestamp of unsubscription.
Properties
- Name
target- Type
- string
- Description
The unique identifier of the target that opted out (usually an email).
- Name
created_at- Type
- timestamp
- Description
Timestamp of when the unsubscription was created.
List all unsubscribes
This endpoint returns a paginated list of all global push unsubscriptions.
Optional attributes
- Name
filter[target]- Type
- string
- Description
Filter unsubscribes by target.
- Name
sort- Type
- string
- Description
Sort the results by
created_at.
- Name
page- Type
- integer
- Description
Page number of the results.
Request
curl -G https://api.bx.feedier.com/v3/push-unsubscribes \
-H "Authorization: Bearer {token}"
Response
{
"data": [
{
"target": "jane.doe@example.com",
"created_at": "2025-05-21T14:22:13.000000Z"
}
],
"links": {
"first": "https://api.bx.feedier.com/v3/push-unsubscribes?page=1",
"last": null,
"prev": null,
"next": null
}
}
Create an unsubscription
This endpoint creates a new global unsubscription for the specified target.
Required attributes
- Name
target- Type
- string
- Description
The email address to unsubscribe from all pushes.
Request
curl https://api.bx.feedier.com/v3/push-unsubscribes \
-H "Authorization: Bearer {token}" \
-d target="jane.doe@example.com"
Response
{
"target": "jane.doe@example.com",
"created_at": "2025-05-21T14:22:13.000000Z"
}
Delete an unsubscription
This endpoint removes a push unsubscription based on the provided target.
Required query parameters
- Name
target- Type
- string
- Description
The email address to resubscribe to pushes.
Request
curl -X DELETE https://api.bx.feedier.com/v3/push-unsubscribes?target=jane.doe@example.com \
-H "Authorization: Bearer {token}"