Skip to content

Latest commit

 

History

History
282 lines (184 loc) · 10.4 KB

ListsApi.md

File metadata and controls

282 lines (184 loc) · 10.4 KB
Raw

sib_api_v3_sdk.ListsApi

All URIs are relative to https://api.sendinblue.com/v3

Method HTTP request Description
AddContactToList Post /contacts/lists/{listId}/contacts/add Add existing contacts to a list
CreateList Post /contacts/lists Create a list
DeleteList Delete /contacts/lists/{listId} Delete a list
GetContactsFromList Get /contacts/lists/{listId}/contacts Get contacts in a list
GetFolderLists Get /contacts/folders/{folderId}/lists Get lists in a folder
GetList Get /contacts/lists/{listId} Get a list's details
GetLists Get /contacts/lists Get all the lists
RemoveContactFromList Post /contacts/lists/{listId}/contacts/remove Delete a contact from a list
UpdateList Put /contacts/lists/{listId} Update a list

AddContactToList

PostContactInfo AddContactToList(ctx, body, listId) Add existing contacts to a list

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body AddContactToList Emails addresses OR IDs of the contacts
listId int64 Id of the list

Return type

PostContactInfo

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateList

CreateModel CreateList(ctx, body) Create a list

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body CreateList Values to create a list

Return type

CreateModel

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteList

DeleteList(ctx, listId) Delete a list

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
listId int64 Id of the list

Return type

(empty response body)

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetContactsFromList

GetContacts GetContactsFromList(ctx, listId, optional) Get contacts in a list

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
listId int64 Id of the list
optional *ListsApiGetContactsFromListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListsApiGetContactsFromListOpts struct

Name Type Description Notes

modifiedSince | optional.String| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | limit | optional.Int64| Number of documents per page | [default to 50] 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]

Return type

GetContacts

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFolderLists

GetFolderLists GetFolderLists(ctx, folderId, optional) Get lists in a folder

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
folderId int64 Id of the folder
optional *ListsApiGetFolderListsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListsApiGetFolderListsOpts 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]

Return type

GetFolderLists

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetList

GetExtendedList GetList(ctx, listId) Get a list's details

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
listId int64 Id of the list

Return type

GetExtendedList

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLists

GetLists GetLists(ctx, optional) Get all the lists

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListsApiGetListsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListsApiGetListsOpts 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]

Return type

GetLists

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveContactFromList

PostContactInfo RemoveContactFromList(ctx, body, listId) Delete a contact from a list

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body RemoveContactFromList Emails addresses OR IDs of the contacts
listId int64 Id of the list

Return type

PostContactInfo

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateList

UpdateList(ctx, body, listId) Update a list

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body UpdateList Values to update a list
listId int64 Id of the list

Return type

(empty response body)

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]