Brevo::TasksApi

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

Method	HTTP request	Description
crm_tasks_get	GET /crm/tasks	Get all tasks
crm_tasks_id_delete	DELETE /crm/tasks/{id}	Delete a task
crm_tasks_id_get	GET /crm/tasks/{id}	Get a task
crm_tasks_id_patch	PATCH /crm/tasks/{id}	Update a task
crm_tasks_post	POST /crm/tasks	Create a task
crm_tasktypes_get	GET /crm/tasktypes	Get all task types

crm_tasks_get

TaskList crm_tasks_get(opts)

Get all tasks

Example

# load the gem
require 'brevo'
# setup authorization
Brevo.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 = Brevo::TasksApi.new

opts = { 
  filter_type: 'filter_type_example', # String | Filter by task type (ID)
  filter_status: 'filter_status_example', # String | Filter by task status
  filter_date: 'filter_date_example', # String | Filter by date
  filter_assign_to: 'filter_assign_to_example', # String | Filter by the \"assignTo\" ID. You can utilize account emails for the \"assignTo\" attribute.
  filter_contacts: 'filter_contacts_example', # String | Filter by contact ids
  filter_deals: 'filter_deals_example', # String | Filter by deals ids
  filter_companies: 'filter_companies_example', # String | Filter by companies ids
  date_from: 56, # Integer | dateFrom to date range filter type (timestamp in milliseconds)
  date_to: 56, # Integer | dateTo to date range filter type (timestamp in milliseconds)
  offset: 789, # Integer | Index of the first document of the page
  limit: 50, # Integer | Number of documents per page
  sort: 'sort_example', # String | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
  sort_by: 'sort_by_example' # String | The field used to sort field names.
}

begin
  #Get all tasks
  result = api_instance.crm_tasks_get(opts)
  p result
rescue Brevo::ApiError => e
  puts "Exception when calling TasksApi->crm_tasks_get: #{e}"
end

Parameters

Name	Type	Description	Notes
filter_type	String	Filter by task type (ID)	[optional]
filter_status	String	Filter by task status	[optional]
filter_date	String	Filter by date	[optional]
filter_assign_to	String	Filter by the "assignTo" ID. You can utilize account emails for the "assignTo" attribute.	[optional]
filter_contacts	String	Filter by contact ids	[optional]
filter_deals	String	Filter by deals ids	[optional]
filter_companies	String	Filter by companies ids	[optional]
date_from	Integer	dateFrom to date range filter type (timestamp in milliseconds)	[optional]
date_to	Integer	dateTo to date range filter type (timestamp in milliseconds)	[optional]
offset	Integer	Index of the first document of the page	[optional]
limit	Integer	Number of documents per page	[optional] [default to 50]
sort	String	Sort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed	[optional]
sort_by	String	The field used to sort field names.	[optional]

Return type

TaskList

Authorization

api-key, partner-key

HTTP request headers

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

crm_tasks_id_delete

crm_tasks_id_delete(id)

Delete a task

Example

# load the gem
require 'brevo'
# setup authorization
Brevo.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 = Brevo::TasksApi.new

id = 'id_example' # String | 


begin
  #Delete a task
  api_instance.crm_tasks_id_delete(id)
rescue Brevo::ApiError => e
  puts "Exception when calling TasksApi->crm_tasks_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

crm_tasks_id_get

Task crm_tasks_id_get(id)

Get a task

Example

# load the gem
require 'brevo'
# setup authorization
Brevo.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 = Brevo::TasksApi.new

id = 'id_example' # String | 


begin
  #Get a task
  result = api_instance.crm_tasks_id_get(id)
  p result
rescue Brevo::ApiError => e
  puts "Exception when calling TasksApi->crm_tasks_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String

Return type

Task

Authorization

api-key, partner-key

HTTP request headers

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

crm_tasks_id_patch

crm_tasks_id_patch(id, body)

Update a task

Example

# load the gem
require 'brevo'
# setup authorization
Brevo.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 = Brevo::TasksApi.new

id = 'id_example' # String | 

body = Brevo::Body10.new # Body10 | Updated task details.


begin
  #Update a task
  api_instance.crm_tasks_id_patch(id, body)
rescue Brevo::ApiError => e
  puts "Exception when calling TasksApi->crm_tasks_id_patch: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
body	Body10	Updated task details.

Return type

nil (empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

crm_tasks_post

InlineResponse2012 crm_tasks_post(body)

Create a task

Example

# load the gem
require 'brevo'
# setup authorization
Brevo.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 = Brevo::TasksApi.new

body = Brevo::Body9.new # Body9 | Task name.


begin
  #Create a task
  result = api_instance.crm_tasks_post(body)
  p result
rescue Brevo::ApiError => e
  puts "Exception when calling TasksApi->crm_tasks_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	Body9	Task name.

Return type

InlineResponse2012

Authorization

api-key, partner-key

HTTP request headers

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

crm_tasktypes_get

TaskTypes crm_tasktypes_get

Get all task types

Example

# load the gem
require 'brevo'
# setup authorization
Brevo.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 = Brevo::TasksApi.new

begin
  #Get all task types
  result = api_instance.crm_tasktypes_get
  p result
rescue Brevo::ApiError => e
  puts "Exception when calling TasksApi->crm_tasktypes_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

TaskTypes

Authorization

api-key, partner-key

HTTP request headers

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

Files

TasksApi.md

Latest commit

History

TasksApi.md

File metadata and controls

Brevo::TasksApi

crm_tasks_get

Example

Parameters

Return type

Authorization

HTTP request headers

crm_tasks_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

crm_tasks_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

crm_tasks_id_patch

Example

Parameters

Return type

Authorization

HTTP request headers

crm_tasks_post

Example

Parameters

Return type

Authorization

HTTP request headers

crm_tasktypes_get

Example

Parameters

Return type

Authorization

HTTP request headers