Skip to content

Latest commit

 

History

History
310 lines (231 loc) · 10.4 KB

NotesApi.md

File metadata and controls

310 lines (231 loc) · 10.4 KB
Raw

brevo_python.NotesApi

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

Method HTTP request Description
crm_notes_get GET /crm/notes Get all notes
crm_notes_id_delete DELETE /crm/notes/{id} Delete a note
crm_notes_id_get GET /crm/notes/{id} Get a note
crm_notes_id_patch PATCH /crm/notes/{id} Update a note
crm_notes_post POST /crm/notes Create a note

crm_notes_get

NoteList crm_notes_get(entity=entity, entity_ids=entity_ids, date_from=date_from, date_to=date_to, offset=offset, limit=limit, sort=sort)

Get all notes

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.NotesApi(brevo_python.ApiClient(configuration))
entity = 'entity_example' # str | Filter by note entity type (optional)
entity_ids = 'entity_ids_example' # str | Filter by note entity 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)

try:
    # Get all notes
    api_response = api_instance.crm_notes_get(entity=entity, entity_ids=entity_ids, date_from=date_from, date_to=date_to, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotesApi->crm_notes_get: %s\n" % e)

Parameters

Name Type Description Notes
entity str Filter by note entity type [optional]
entity_ids str Filter by note entity 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]

Return type

NoteList

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_notes_id_delete

crm_notes_id_delete(id)

Delete a note

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.NotesApi(brevo_python.ApiClient(configuration))
id = 'id_example' # str | Note ID to delete

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

Parameters

Name Type Description Notes
id str Note ID to delete

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_notes_id_get

Note crm_notes_id_get(id)

Get a note

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.NotesApi(brevo_python.ApiClient(configuration))
id = 'id_example' # str | Note ID to get

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

Parameters

Name Type Description Notes
id str Note ID to get

Return type

Note

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_notes_id_patch

crm_notes_id_patch(id, body)

Update a note

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.NotesApi(brevo_python.ApiClient(configuration))
id = 'id_example' # str | Note ID to update
body = brevo_python.NoteData() # NoteData | Note data to update a note

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

Parameters

Name Type Description Notes
id str Note ID to update
body NoteData Note data to update a note

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_notes_post

NoteId crm_notes_post(body)

Create a note

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.NotesApi(brevo_python.ApiClient(configuration))
body = brevo_python.NoteData() # NoteData | Note data to create a note.

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

Parameters

Name Type Description Notes
body NoteData Note data to create a note.

Return type

NoteId

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]