POST /products/{id}/alerts/{type}
Register a contact to receive an alert for a specific product event, such as back_in_stock. At least one contact identifier (ext_id, email, or sms) must be provided; when multiple are given, priority is ext_id > email > sms. Returns a 404 error if the product ID does not exist, and a 403 error if product alerts are not enabled for the account.
Servers
- https://api.brevo.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Product ID |
type |
String | Yes |
Alert type Valid values:
|
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
contactIdentifiers |
Object | No | |
contactIdentifiers.email |
String | No |
Email address of the contact |
contactIdentifiers.ext_id |
String | No |
Contact ID in your system |
contactIdentifiers.sms |
String | No |
Sms of the contact |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.