ElasticEmail.InboundRouteApi

All URIs are relative to https://api.elasticemail.com/v4

Method	HTTP request	Description
inboundroute_by_id_delete	DELETE /inboundroute/{id}	Delete Route
inboundroute_by_id_get	GET /inboundroute/{id}	Get Route
inboundroute_by_id_put	PUT /inboundroute/{id}	Update Route
inboundroute_get	GET /inboundroute	Get Routes
inboundroute_order_put	PUT /inboundroute/order	Update Sorting
inboundroute_post	POST /inboundroute	Create Route

inboundroute_by_id_delete

inboundroute_by_id_delete(id)

Delete Route

Deletes the Inbound Route. Required Access Level: ModifySettings

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.InboundRouteApi(api_client)
    id = 'id_example' # str | 

    try:
        # Delete Route
        api_instance.inboundroute_by_id_delete(id)
    except Exception as e:
        print("Exception when calling InboundRouteApi->inboundroute_by_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

void (empty response body)

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

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

inboundroute_by_id_get

InboundRoute inboundroute_by_id_get(id)

Get Route

Load an Inbound Route. Required Access Level: ViewSettings

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.inbound_route import InboundRoute
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.InboundRouteApi(api_client)
    id = '123456' # str | ID number of your attachment

    try:
        # Get Route
        api_response = api_instance.inboundroute_by_id_get(id)
        print("The response of InboundRouteApi->inboundroute_by_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InboundRouteApi->inboundroute_by_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID number of your attachment

Return type

InboundRoute

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

inboundroute_by_id_put

InboundRoute inboundroute_by_id_put(id, inbound_payload)

Update Route

Update the Inbound Route. Required Access Level: ModifySettings

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.inbound_payload import InboundPayload
from ElasticEmail.models.inbound_route import InboundRoute
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.InboundRouteApi(api_client)
    id = 'id_example' # str | 
    inbound_payload = ElasticEmail.InboundPayload() # InboundPayload | 

    try:
        # Update Route
        api_response = api_instance.inboundroute_by_id_put(id, inbound_payload)
        print("The response of InboundRouteApi->inboundroute_by_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InboundRouteApi->inboundroute_by_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
inbound_payload	InboundPayload

Return type

InboundRoute

Authorization

apikey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

inboundroute_get

List[InboundRoute] inboundroute_get()

Get Routes

Get all your Inbound Routes. Required Access Level: ViewSettings

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.inbound_route import InboundRoute
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.InboundRouteApi(api_client)

    try:
        # Get Routes
        api_response = api_instance.inboundroute_get()
        print("The response of InboundRouteApi->inboundroute_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InboundRouteApi->inboundroute_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[InboundRoute]

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

inboundroute_order_put

List[InboundRoute] inboundroute_order_put(sort_order_item)

Update Sorting

Required Access Level: ViewSettings

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.inbound_route import InboundRoute
from ElasticEmail.models.sort_order_item import SortOrderItem
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.InboundRouteApi(api_client)
    sort_order_item = [ElasticEmail.SortOrderItem()] # List[SortOrderItem] | Change the ordering of inbound routes for when matching the inbound

    try:
        # Update Sorting
        api_response = api_instance.inboundroute_order_put(sort_order_item)
        print("The response of InboundRouteApi->inboundroute_order_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InboundRouteApi->inboundroute_order_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
sort_order_item	List[SortOrderItem]	Change the ordering of inbound routes for when matching the inbound

Return type

List[InboundRoute]

Authorization

apikey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

inboundroute_post

InboundRoute inboundroute_post(inbound_payload)

Create Route

Create new Inbound Route. Required Access Level: ModifySettings

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.inbound_payload import InboundPayload
from ElasticEmail.models.inbound_route import InboundRoute
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.InboundRouteApi(api_client)
    inbound_payload = ElasticEmail.InboundPayload() # InboundPayload | 

    try:
        # Create Route
        api_response = api_instance.inboundroute_post(inbound_payload)
        print("The response of InboundRouteApi->inboundroute_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InboundRouteApi->inboundroute_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
inbound_payload	InboundPayload

Return type

InboundRoute

Authorization

apikey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

Files

InboundRouteApi.md

Latest commit

History

InboundRouteApi.md

File metadata and controls

ElasticEmail.InboundRouteApi

inboundroute_by_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inboundroute_by_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inboundroute_by_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inboundroute_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inboundroute_order_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inboundroute_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details