PATCH /couponCollections/{id}
Update an existing coupon collection by its UUID. You can modify the default coupon value, set or remove the expiration date (pass null to remove), and configure or disable alert thresholds for remaining coupons or remaining days. Only the fields included in the request body are updated; omitted fields remain unchanged.
Servers
- https://api.brevo.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Id of the collection to update |
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 |
|---|---|---|---|
expirationDate |
String | No |
Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date. |
defaultCoupon |
String | No |
A default coupon to be used in case there are no coupons left |
remainingDaysAlert |
Integer | No |
Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts. |
remainingCouponsAlert |
Integer | No |
Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts. |
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.