SibApiV3Sdk::ListsApi

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

Method	HTTP request	Description
add_contact_to_list	POST /contacts/lists/{listId}/contacts/add	Add existing contacts to a list
create_list	POST /contacts/lists	Create a list
delete_list	DELETE /contacts/lists/{listId}	Delete a list
get_contacts_from_list	GET /contacts/lists/{listId}/contacts	Get the contacts in a list
get_folder_lists	GET /contacts/folders/{folderId}/lists	Get the lists in a folder
get_list	GET /contacts/lists/{listId}	Get the details of a list
get_lists	GET /contacts/lists	Get all the lists
remove_contact_from_list	POST /contacts/lists/{listId}/contacts/remove	Remove existing contacts from a list
update_list	PUT /contacts/lists/{listId}	Update a list

add_contact_to_list

PostContactInfo add_contact_to_list(list_id, contact_emails)

Add existing contacts to a list

Example

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = SibApiV3Sdk::ListsApi.new

list_id = 789 # Integer | Id of the list

contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts


begin
  #Add existing contacts to a list
  result = api_instance.add_contact_to_list(list_id, contact_emails)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ListsApi->add_contact_to_list: #{e}"
end

Parameters

Name	Type	Description	Notes
list_id	Integer	Id of the list
contact_emails	AddContactToList	Emails addresses of the contacts

Return type

PostContactInfo

Authorization

api-key, partner-key

HTTP request headers

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

create_list

CreateModel create_list(create_list)

Create a list

Example

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = SibApiV3Sdk::ListsApi.new

create_list = SibApiV3Sdk::CreateList.new # CreateList | Values to create a list


begin
  #Create a list
  result = api_instance.create_list(create_list)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ListsApi->create_list: #{e}"
end

Parameters

Name	Type	Description	Notes
create_list	CreateList	Values to create a list

Return type

CreateModel

Authorization

api-key, partner-key

HTTP request headers

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

delete_list

delete_list(list_id)

Delete a list

Example

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = SibApiV3Sdk::ListsApi.new

list_id = 789 # Integer | Id of the list


begin
  #Delete a list
  api_instance.delete_list(list_id)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ListsApi->delete_list: #{e}"
end

Parameters

Name	Type	Description	Notes
list_id	Integer	Id of the list

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

get_contacts_from_list

GetContacts get_contacts_from_list(list_id, opts)

Get the contacts in a list

Example

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = SibApiV3Sdk::ListsApi.new

list_id = 789 # Integer | Id of the list

opts = { 
  modified_since: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | 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: 50, # Integer | Number of documents per page
  offset: 0 # Integer | Index of the first document of the page
}

begin
  #Get the contacts in a list
  result = api_instance.get_contacts_from_list(list_id, opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ListsApi->get_contacts_from_list: #{e}"
end

Parameters

Name	Type	Description	Notes
list_id	Integer	Id of the list
modified_since	DateTime	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.	[optional]
limit	Integer	Number of documents per page	[optional] [default to 50]
offset	Integer	Index of the first document of the page	[optional] [default to 0]

Return type

GetContacts

Authorization

api-key, partner-key

HTTP request headers

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

get_folder_lists

GetFolderLists get_folder_lists(folder_id, opts)

Get the lists in a folder

Example

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = SibApiV3Sdk::ListsApi.new

folder_id = 789 # Integer | Id of the folder

opts = { 
  limit: 10, # Integer | Number of documents per page
  offset: 0 # Integer | Index of the first document of the page
}

begin
  #Get the lists in a folder
  result = api_instance.get_folder_lists(folder_id, opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ListsApi->get_folder_lists: #{e}"
end

Parameters

Name	Type	Description	Notes
folder_id	Integer	Id of the folder
limit	Integer	Number of documents per page	[optional] [default to 10]
offset	Integer	Index of the first document of the page	[optional] [default to 0]

Return type

GetFolderLists

Authorization

api-key, partner-key

HTTP request headers

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

get_list

GetExtendedList get_list(list_id)

Get the details of a list

Example

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = SibApiV3Sdk::ListsApi.new

list_id = 789 # Integer | Id of the list


begin
  #Get the details of a list
  result = api_instance.get_list(list_id)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ListsApi->get_list: #{e}"
end

Parameters

Name	Type	Description	Notes
list_id	Integer	Id of the list

Return type

GetExtendedList

Authorization

api-key, partner-key

HTTP request headers

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

get_lists

GetLists get_lists(opts)

Get all the lists

Example

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = SibApiV3Sdk::ListsApi.new

opts = { 
  limit: 10, # Integer | Number of documents per page
  offset: 0 # Integer | Index of the first document of the page
}

begin
  #Get all the lists
  result = api_instance.get_lists(opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ListsApi->get_lists: #{e}"
end

Parameters

Name	Type	Description	Notes
limit	Integer	Number of documents per page	[optional] [default to 10]
offset	Integer	Index of the first document of the page	[optional] [default to 0]

Return type

GetLists

Authorization

api-key, partner-key

HTTP request headers

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

remove_contact_from_list

PostContactInfo remove_contact_from_list(list_id, contact_emails)

Remove existing contacts from a list

Example

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = SibApiV3Sdk::ListsApi.new

list_id = 789 # Integer | Id of the list

contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails adresses of the contact


begin
  #Remove existing contacts from a list
  result = api_instance.remove_contact_from_list(list_id, contact_emails)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ListsApi->remove_contact_from_list: #{e}"
end

Parameters

Name	Type	Description	Notes
list_id	Integer	Id of the list
contact_emails	RemoveContactFromList	Emails adresses of the contact

Return type

PostContactInfo

Authorization

api-key, partner-key

HTTP request headers

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

update_list

update_list(list_id, update_list)

Update a list

Example

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: partner-key
  config.api_key['partner-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = SibApiV3Sdk::ListsApi.new

list_id = 789 # Integer | Id of the list

update_list = SibApiV3Sdk::UpdateList.new # UpdateList | Values to update a list


begin
  #Update a list
  api_instance.update_list(list_id, update_list)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ListsApi->update_list: #{e}"
end

Parameters

Name	Type	Description	Notes
list_id	Integer	Id of the list
update_list	UpdateList	Values to update a list

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

Files

ListsApi.md

Latest commit

History

ListsApi.md

File metadata and controls

SibApiV3Sdk::ListsApi

add_contact_to_list

Example

Parameters

Return type

Authorization

HTTP request headers

create_list

Example

Parameters

Return type

Authorization

HTTP request headers

delete_list

Example

Parameters

Return type

Authorization

HTTP request headers

get_contacts_from_list

Example

Parameters

Return type

Authorization

HTTP request headers

get_folder_lists

Example

Parameters

Return type

Authorization

HTTP request headers

get_list

Example

Parameters

Return type

Authorization

HTTP request headers

get_lists

Example

Parameters

Return type

Authorization

HTTP request headers

remove_contact_from_list

Example

Parameters

Return type

Authorization

HTTP request headers

update_list

Example

Parameters

Return type

Authorization

HTTP request headers