All URIs are relative to https://api.brevo.com/v3
| Method | HTTP request | Description |
|---|---|---|
| CreateExternalFeed | Post /feeds | Create an external feed |
| DeleteExternalFeed | Delete /feeds/{uuid} | Delete an external feed |
| GetAllExternalFeeds | Get /feeds | Fetch all external feeds |
| GetExternalFeedByUUID | Get /feeds/{uuid} | Get an external feed by UUID |
| UpdateExternalFeed | Put /feeds/{uuid} | Update an external feed |
InlineResponse2015 CreateExternalFeed(ctx, createExternalFeed) Create an external feed
This endpoint will create an external feed.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createExternalFeed | CreateExternalFeed | Values to create a feed |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteExternalFeed(ctx, uuid) Delete an external feed
This endpoint will delete an external feed.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| uuid | string | UUID of the feed to delete |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetAllExternalFeeds GetAllExternalFeeds(ctx, optional) Fetch all external feeds
This endpoint can fetch all created external feeds.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetAllExternalFeedsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetAllExternalFeedsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| search | optional.String | Can be used to filter records by search keyword on feed name | |
| startDate | optional.String | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. | |
| endDate | optional.String | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | |
| sort | optional.String | Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed. | [default to desc] |
| authType | optional.String | Filter the records by `authType` of the feed. | |
| 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] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetExternalFeedByUuid GetExternalFeedByUUID(ctx, uuid) Get an external feed by UUID
This endpoint will update an external feed.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| uuid | string | UUID of the feed to fetch |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateExternalFeed(ctx, uuid, updateExternalFeed) Update an external feed
This endpoint will update an external feed.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| uuid | string | UUID of the feed to update | |
| updateExternalFeed | UpdateExternalFeed | Values to update a feed |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]