SibApiV3Sdk::ContactsApi

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_attribute	POST /contacts/attributes/{attributeCategory}/{attributeName}	Create contact attribute
create_contact	POST /contacts	Create a contact
create_doi_contact	POST /contacts/doubleOptinConfirmation	Create Contact via DOI (Double-Opt-In) Flow
create_folder	POST /contacts/folders	Create a folder
create_list	POST /contacts/lists	Create a list
delete_attribute	DELETE /contacts/attributes/{attributeCategory}/{attributeName}	Delete an attribute
delete_contact	DELETE /contacts/{identifier}	Delete a contact
delete_folder	DELETE /contacts/folders/{folderId}	Delete a folder (and all its lists)
delete_list	DELETE /contacts/lists/{listId}	Delete a list
get_attributes	GET /contacts/attributes	List all attributes
get_contact_info	GET /contacts/{identifier}	Get a contact's details
get_contact_stats	GET /contacts/{identifier}/campaignStats	Get email campaigns' statistics for a contact
get_contacts	GET /contacts	Get all the contacts
get_contacts_from_list	GET /contacts/lists/{listId}/contacts	Get contacts in a list
get_folder	GET /contacts/folders/{folderId}	Returns a folder's details
get_folder_lists	GET /contacts/folders/{folderId}/lists	Get lists in a folder
get_folders	GET /contacts/folders	Get all folders
get_list	GET /contacts/lists/{listId}	Get a list's details
get_lists	GET /contacts/lists	Get all the lists
import_contacts	POST /contacts/import	Import contacts
remove_contact_from_list	POST /contacts/lists/{listId}/contacts/remove	Delete a contact from a list
request_contact_export	POST /contacts/export	Export contacts
update_attribute	PUT /contacts/attributes/{attributeCategory}/{attributeName}	Update contact attribute
update_batch_contacts	POST /contacts/batch	Update multiple contacts
update_contact	PUT /contacts/{identifier}	Update a contact
update_folder	PUT /contacts/folders/{folderId}	Update a folder
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::ContactsApi.new

list_id = 789 # Integer | Id of the list

contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses OR IDs 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 ContactsApi->add_contact_to_list: #{e}"
end

Parameters

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

Return type

PostContactInfo

Authorization

api-key, partner-key

HTTP request headers

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

create_attribute

create_attribute(attribute_category, attribute_name, create_attribute)

Create contact attribute

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::ContactsApi.new

attribute_category = 'attribute_category_example' # String | Category of the attribute

attribute_name = 'attribute_name_example' # String | Name of the attribute

create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values to create an attribute


begin
  #Create contact attribute
  api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->create_attribute: #{e}"
end

Parameters

Name	Type	Description
attribute_category	String	Category of the attribute
attribute_name	String	Name of the attribute
create_attribute	CreateAttribute	Values to create an attribute

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

create_contact

CreateUpdateContactModel create_contact(create_contact)

Create a contact

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::ContactsApi.new

create_contact = SibApiV3Sdk::CreateContact.new # CreateContact | Values to create a contact


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

Parameters

Name	Type	Description	Notes
create_contact	CreateContact	Values to create a contact

Return type

CreateUpdateContactModel

Authorization

api-key, partner-key

HTTP request headers

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

create_doi_contact

create_doi_contact(create_doi_contact)

Create Contact via DOI (Double-Opt-In) Flow

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::ContactsApi.new

create_doi_contact = SibApiV3Sdk::CreateDoiContact.new # CreateDoiContact | Values to create the Double opt-in (DOI) contact


begin
  #Create Contact via DOI (Double-Opt-In) Flow
  api_instance.create_doi_contact(create_doi_contact)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->create_doi_contact: #{e}"
end

Parameters

Name	Type	Description	Notes
create_doi_contact	CreateDoiContact	Values to create the Double opt-in (DOI) contact

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

create_folder

CreateModel create_folder(create_folder)

Create 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::ContactsApi.new

create_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder


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

Parameters

Name	Type	Description	Notes
create_folder	CreateUpdateFolder	Name of the folder

Return type

CreateModel

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::ContactsApi.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 ContactsApi->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_attribute

delete_attribute(attribute_category, attribute_name)

Delete an attribute

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::ContactsApi.new

attribute_category = 'attribute_category_example' # String | Category of the attribute

attribute_name = 'attribute_name_example' # String | Name of the existing attribute


begin
  #Delete an attribute
  api_instance.delete_attribute(attribute_category, attribute_name)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->delete_attribute: #{e}"
end

Parameters

Name	Type	Description	Notes
attribute_category	String	Category of the attribute
attribute_name	String	Name of the existing attribute

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

delete_contact

delete_contact(identifier)

Delete a contact

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::ContactsApi.new

identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact


begin
  #Delete a contact
  api_instance.delete_contact(identifier)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->delete_contact: #{e}"
end

Parameters

Name	Type	Description	Notes
identifier	String	Email (urlencoded) OR ID of the contact

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

delete_folder

delete_folder(folder_id)

Delete a folder (and all its 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::ContactsApi.new

folder_id = 789 # Integer | Id of the folder


begin
  #Delete a folder (and all its lists)
  api_instance.delete_folder(folder_id)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->delete_folder: #{e}"
end

Parameters

Name	Type	Description	Notes
folder_id	Integer	Id of the folder

Return type

nil (empty response body)

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::ContactsApi.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 ContactsApi->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_attributes

GetAttributes get_attributes

List all attributes

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::ContactsApi.new

begin
  #List all attributes
  result = api_instance.get_attributes
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->get_attributes: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

GetAttributes

Authorization

api-key, partner-key

HTTP request headers

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

get_contact_info

GetExtendedContactDetails get_contact_info(identifier, opts)

Get a contact's details

Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.

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::ContactsApi.new

identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact OR its SMS attribute value

opts = { 
  start_date: nil, # Object | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate 
  end_date: nil # Object | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. 
}

begin
  #Get a contact's details
  result = api_instance.get_contact_info(identifier, opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->get_contact_info: #{e}"
end

Parameters

Name	Type	Description	Notes
identifier	String	Email (urlencoded) OR ID of the contact OR its SMS attribute value
start_date	Object	Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate	[optional]
end_date	Object	Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate.	[optional]

Return type

GetExtendedContactDetails

Authorization

api-key, partner-key

HTTP request headers

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

get_contact_stats

GetContactCampaignStats get_contact_stats(identifier, opts)

Get email campaigns' statistics for a contact

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::ContactsApi.new

identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact

opts = { 
  start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
  end_date: 'end_date_example' # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
}

begin
  #Get email campaigns' statistics for a contact
  result = api_instance.get_contact_stats(identifier, opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->get_contact_stats: #{e}"
end

Parameters

Name	Type	Description	Notes
identifier	String	Email (urlencoded) OR ID of the contact
start_date	String	Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate	[optional]
end_date	String	Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days	[optional]

Return type

GetContactCampaignStats

Authorization

api-key, partner-key

HTTP request headers

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

get_contacts

GetContacts get_contacts(opts)

Get all the contacts

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::ContactsApi.new

opts = { 
  limit: 50, # Integer | Number of documents per page
  offset: 0, # Integer | Index of the first document of the page
  modified_since: 'modified_since_example', # 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.
  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
}

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

Parameters

Name	Type	Description	Notes
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]
modified_since	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.	[optional]
sort	String	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]

Return type

GetContacts

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 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::ContactsApi.new

list_id = 789 # Integer | Id of the list

opts = { 
  modified_since: 'modified_since_example', # 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: 50, # Integer | Number of documents per page
  offset: 0, # Integer | Index of the first document of the page
  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
}

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

Parameters

Name	Type	Description	Notes
list_id	Integer	Id of the list
modified_since	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.	[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]
sort	String	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]

Return type

GetContacts

Authorization

api-key, partner-key

HTTP request headers

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

get_folder

GetFolder get_folder(folder_id)

Returns a folder's details

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::ContactsApi.new

folder_id = 789 # Integer | id of the folder


begin
  #Returns a folder's details
  result = api_instance.get_folder(folder_id)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->get_folder: #{e}"
end

Parameters

Name	Type	Description	Notes
folder_id	Integer	id of the folder

Return type

GetFolder

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 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::ContactsApi.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
  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
}

begin
  #Get lists in a folder
  result = api_instance.get_folder_lists(folder_id, opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->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]
sort	String	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]

Return type

GetFolderLists

Authorization

api-key, partner-key

HTTP request headers

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

get_folders

GetFolders get_folders(limit, offset, opts)

Get all folders

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::ContactsApi.new

limit = 10 # Integer | Number of documents per page

offset = 0 # Integer | Index of the first document of the page

opts = { 
  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
}

begin
  #Get all folders
  result = api_instance.get_folders(limit, offset, opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->get_folders: #{e}"
end

Parameters

Name	Type	Description	Notes
limit	Integer	Number of documents per page	[default to 10]
offset	Integer	Index of the first document of the page	[default to 0]
sort	String	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]

Return type

GetFolders

Authorization

api-key, partner-key

HTTP request headers

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

get_list

GetExtendedList get_list(list_id)

Get a list's details

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::ContactsApi.new

list_id = 789 # Integer | Id of the list


begin
  #Get a list's details
  result = api_instance.get_list(list_id)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->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::ContactsApi.new

opts = { 
  limit: 10, # Integer | Number of documents per page
  offset: 0, # Integer | Index of the first document of the page
  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
}

begin
  #Get all the lists
  result = api_instance.get_lists(opts)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->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]
sort	String	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed	[optional] [default to desc]

Return type

GetLists

Authorization

api-key, partner-key

HTTP request headers

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

import_contacts

CreatedProcessId import_contacts(request_contact_import)

Import contacts

It returns the background process ID which on completion calls the notify URL that you have set in the input.

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::ContactsApi.new

request_contact_import = SibApiV3Sdk::RequestContactImport.new # RequestContactImport | Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``


begin
  #Import contacts
  result = api_instance.import_contacts(request_contact_import)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->import_contacts: #{e}"
end

Parameters

Name	Type	Description	Notes
request_contact_import	RequestContactImport	Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``

Return type

CreatedProcessId

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)

Delete a contact 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::ContactsApi.new

list_id = 789 # Integer | Id of the list

contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts


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

Parameters

Name	Type	Description	Notes
list_id	Integer	Id of the list
contact_emails	RemoveContactFromList	Emails addresses OR IDs of the contacts

Return type

PostContactInfo

Authorization

api-key, partner-key

HTTP request headers

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

request_contact_export

CreatedProcessId request_contact_export(request_contact_export)

Export contacts

It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

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::ContactsApi.new

request_contact_export = SibApiV3Sdk::RequestContactExport.new # RequestContactExport | Values to request a contact export


begin
  #Export contacts
  result = api_instance.request_contact_export(request_contact_export)
  p result
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->request_contact_export: #{e}"
end

Parameters

Name	Type	Description	Notes
request_contact_export	RequestContactExport	Values to request a contact export

Return type

CreatedProcessId

Authorization

api-key, partner-key

HTTP request headers

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

update_attribute

update_attribute(attribute_category, attribute_name, update_attribute)

Update contact attribute

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::ContactsApi.new

attribute_category = 'attribute_category_example' # String | Category of the attribute

attribute_name = 'attribute_name_example' # String | Name of the existing attribute

update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values to update an attribute


begin
  #Update contact attribute
  api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->update_attribute: #{e}"
end

Parameters

Name	Type	Description
attribute_category	String	Category of the attribute
attribute_name	String	Name of the existing attribute
update_attribute	UpdateAttribute	Values to update an attribute

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

update_batch_contacts

update_batch_contacts(update_batch_contacts)

Update multiple contacts

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::ContactsApi.new

update_batch_contacts = SibApiV3Sdk::UpdateBatchContacts.new # UpdateBatchContacts | Values to update multiple contacts


begin
  #Update multiple contacts
  api_instance.update_batch_contacts(update_batch_contacts)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->update_batch_contacts: #{e}"
end

Parameters

Name	Type	Description	Notes
update_batch_contacts	UpdateBatchContacts	Values to update multiple contacts

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

update_contact

update_contact(identifier, update_contact)

Update a contact

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::ContactsApi.new

identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact

update_contact = SibApiV3Sdk::UpdateContact.new # UpdateContact | Values to update a contact


begin
  #Update a contact
  api_instance.update_contact(identifier, update_contact)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->update_contact: #{e}"
end

Parameters

Name	Type	Description	Notes
identifier	String	Email (urlencoded) OR ID of the contact
update_contact	UpdateContact	Values to update a contact

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

update_folder

update_folder(folder_id, update_folder)

Update 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::ContactsApi.new

folder_id = 789 # Integer | Id of the folder

update_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder


begin
  #Update a folder
  api_instance.update_folder(folder_id, update_folder)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling ContactsApi->update_folder: #{e}"
end

Parameters

Name	Type	Description	Notes
folder_id	Integer	Id of the folder
update_folder	CreateUpdateFolder	Name of the folder

Return type

nil (empty response body)

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::ContactsApi.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 ContactsApi->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

ContactsApi.md

Latest commit

History

ContactsApi.md

File metadata and controls

SibApiV3Sdk::ContactsApi

add_contact_to_list

Example

Parameters

Return type

Authorization

HTTP request headers

create_attribute

Example

Parameters

Return type

Authorization

HTTP request headers

create_contact

Example

Parameters

Return type

Authorization

HTTP request headers

create_doi_contact

Example

Parameters

Return type

Authorization

HTTP request headers

create_folder

Example

Parameters

Return type

Authorization

HTTP request headers

create_list

Example

Parameters

Return type

Authorization

HTTP request headers

delete_attribute

Example

Parameters

Return type

Authorization

HTTP request headers

delete_contact

Example

Parameters

Return type

Authorization

HTTP request headers

delete_folder

Example

Parameters

Return type

Authorization

HTTP request headers

delete_list

Example

Parameters

Return type

Authorization

HTTP request headers

get_attributes

Example

Parameters

Return type

Authorization

HTTP request headers

get_contact_info

Example

Parameters

Return type

Authorization

HTTP request headers

get_contact_stats