All URIs are relative to https://api.sendinblue.com/v3
| Method | HTTP request | Description |
|---|---|---|
| CreateFolder | Post /contacts/folders | Create a folder |
| DeleteFolder | Delete /contacts/folders/{folderId} | Delete a folder (and all its lists) |
| GetFolder | Get /contacts/folders/{folderId} | Returns a folder's details |
| GetFolderLists | Get /contacts/folders/{folderId}/lists | Get lists in a folder |
| GetFolders | Get /contacts/folders | Get all folders |
| UpdateFolder | Put /contacts/folders/{folderId} | Update a folder |
CreateModel CreateFolder(ctx, createFolder) Create a folder
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createFolder | CreateUpdateFolder | Name of the folder |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteFolder(ctx, folderId) Delete a folder (and all its lists)
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| folderId | int64 | Id of the folder |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetFolder GetFolder(ctx, folderId) Returns a folder's details
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| folderId | int64 | id of the folder |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetFolderLists GetFolderLists(ctx, folderId, optional) Get lists in a folder
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| folderId | int64 | Id of the folder | |
| optional | *GetFolderListsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetFolderListsOpts struct
| Name | Type | Description | Notes |
|---|
limit | optional.Int64| Number of documents per page | [default to 10] offset | optional.Int64| Index of the first document of the page | [default to 0] 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]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetFolders GetFolders(ctx, limit, offset, optional) Get all folders
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| limit | int64 | Number of documents per page | [default to 10] |
| offset | int64 | Index of the first document of the page | [default to 0] |
| optional | *GetFoldersOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetFoldersOpts struct
| Name | Type | Description | Notes |
|---|
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]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateFolder(ctx, folderId, updateFolder) Update a folder
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| folderId | int64 | Id of the folder | |
| updateFolder | CreateUpdateFolder | Name of the folder |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]