Skip to content

Latest commit

 

History

History
128 lines (94 loc) · 4.58 KB

ProcessApi.md

File metadata and controls

128 lines (94 loc) · 4.58 KB
Raw

sib_api_v3_sdk.ProcessApi

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

Method HTTP request Description
get_process GET /processes/{processId} Return the informations for a process
get_processes GET /processes Return all the processes for your account

get_process

GetProcess get_process(process_id)

Return the informations for a process

Example

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

# Configure API key authorization: api-key
configuration = sib_api_v3_sdk.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 = sib_api_v3_sdk.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 = sib_api_v3_sdk.ProcessApi(sib_api_v3_sdk.ApiClient(configuration))
process_id = 789 # int | Id of the process

try:
    # Return the informations for a process
    api_response = api_instance.get_process(process_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessApi->get_process: %s\n" % e)

Parameters

Name Type Description Notes
process_id int Id of the process

Return type

GetProcess

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]

get_processes

GetProcesses get_processes(limit=limit, offset=offset, sort=sort)

Return all the processes for your account

Example

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

# Configure API key authorization: api-key
configuration = sib_api_v3_sdk.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 = sib_api_v3_sdk.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 = sib_api_v3_sdk.ProcessApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 10 # int | Number limitation for the result returned (optional) (default to 10)
offset = 0 # int | Beginning point in the list to retrieve from. (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
    # Return all the processes for your account
    api_response = api_instance.get_processes(limit=limit, offset=offset, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessApi->get_processes: %s\n" % e)

Parameters

Name Type Description Notes
limit int Number limitation for the result returned [optional] [default to 10]
offset int Beginning point in the list to retrieve from. [optional] [default to 0]
sort str 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

GetProcesses

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]