brevo_python.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(filter_type=filter_type, filter_status=filter_status, filter_date=filter_date, filter_assign_to=filter_assign_to, filter_contacts=filter_contacts, filter_deals=filter_deals, filter_companies=filter_companies, date_from=date_from, date_to=date_to, offset=offset, limit=limit, sort=sort, sort_by=sort_by)

Get all tasks

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

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

try:
    # Get all tasks
    api_response = api_instance.crm_tasks_get(filter_type=filter_type, filter_status=filter_status, filter_date=filter_date, filter_assign_to=filter_assign_to, filter_contacts=filter_contacts, filter_deals=filter_deals, filter_companies=filter_companies, date_from=date_from, date_to=date_to, offset=offset, limit=limit, sort=sort, sort_by=sort_by)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TasksApi->crm_tasks_get: %s\n" % e)

Parameters

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

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

crm_tasks_id_delete

crm_tasks_id_delete(id)

Delete a task

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.TasksApi(brevo_python.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Delete a task
    api_instance.crm_tasks_id_delete(id)
except ApiException as e:
    print("Exception when calling TasksApi->crm_tasks_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

void (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]

crm_tasks_id_get

Task crm_tasks_id_get(id)

Get a task

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.TasksApi(brevo_python.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Get a task
    api_response = api_instance.crm_tasks_id_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TasksApi->crm_tasks_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

Task

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]

crm_tasks_id_patch

crm_tasks_id_patch(id, body)

Update a task

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.TasksApi(brevo_python.ApiClient(configuration))
id = 'id_example' # str | 
body = brevo_python.Body12() # Body12 | Updated task details.

try:
    # Update a task
    api_instance.crm_tasks_id_patch(id, body)
except ApiException as e:
    print("Exception when calling TasksApi->crm_tasks_id_patch: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
body	Body12	Updated task details.

Return type

void (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]

crm_tasks_post

InlineResponse2012 crm_tasks_post(body)

Create a task

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.TasksApi(brevo_python.ApiClient(configuration))
body = brevo_python.Body11() # Body11 | Task name.

try:
    # Create a task
    api_response = api_instance.crm_tasks_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TasksApi->crm_tasks_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Body11	Task name.

Return type

InlineResponse2012

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]

crm_tasktypes_get

TaskTypes crm_tasktypes_get()

Get all task types

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.TasksApi(brevo_python.ApiClient(configuration))

try:
    # Get all task types
    api_response = api_instance.crm_tasktypes_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TasksApi->crm_tasktypes_get: %s\n" % e)

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

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

Files

TasksApi.md

Latest commit

History

TasksApi.md

File metadata and controls

brevo_python.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