All URIs are relative to https://api.brevo.com/v3
| Method | HTTP request | Description |
|---|---|---|
| CreateCouponCollection | Post /couponCollections | Create а coupon collection |
| CreateCoupons | Post /coupons | Create coupons for a coupon collection |
| GetCouponCollection | Get /couponCollections/{id} | Get a coupon collection by id |
| GetCouponCollections | Get /couponCollections | Get all your coupon collections |
| UpdateCouponCollection | Patch /couponCollections/{id} | Update a coupon collection by id |
InlineResponse2013 CreateCouponCollection(ctx, createCouponCollection) Create а coupon collection
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createCouponCollection | CreateCouponCollection | Values to create a coupon collection |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateCoupons(ctx, createCoupons) Create coupons for a coupon collection
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createCoupons | CreateCoupons | Values to create coupons |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCouponCollection GetCouponCollection(ctx, id) Get a coupon collection by id
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Id of the collection to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCouponCollection GetCouponCollections(ctx, optional) Get all your coupon collections
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetCouponCollectionsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetCouponCollectionsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | optional.Int64 | Number of documents returned per page | [default to 50] |
| offset | optional.Int64 | Index of the first document on the page | [default to 0] |
| sort | optional.String | Sort the results by creation time in ascending/descending order | [default to desc] |
| sortBy | optional.String | The field used to sort coupon collections | [default to createdAt] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2008 UpdateCouponCollection(ctx, id, optional) Update a coupon collection by id
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Id of the collection to update | |
| optional | *UpdateCouponCollectionOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UpdateCouponCollectionOpts struct
| Name | Type | Description | Notes |
|---|
updateCouponCollection | optional.Interface of UpdateCouponCollection| Values to update the coupon collection |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]