ElasticEmail.ContactsApi

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

Method	HTTP request	Description
contacts_by_email_delete	DELETE /contacts/{email}	Delete Contact
contacts_by_email_get	GET /contacts/{email}	Load Contact
contacts_by_email_put	PUT /contacts/{email}	Update Contact
contacts_delete_post	POST /contacts/delete	Delete Contacts Bulk
contacts_export_by_id_status_get	GET /contacts/export/{id}/status	Check Export Status
contacts_export_post	POST /contacts/export	Export Contacts
contacts_get	GET /contacts	Load Contacts
contacts_import_post	POST /contacts/import	Upload Contacts
contacts_post	POST /contacts	Add Contact

contacts_by_email_delete

contacts_by_email_delete(email)

Delete Contact

Deletes the provided contact. Required Access Level: ModifyContacts

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.ContactsApi(api_client)
    email = 'mail@example.com' # str | Proper email address.

    try:
        # Delete Contact
        api_instance.contacts_by_email_delete(email)
    except Exception as e:
        print("Exception when calling ContactsApi->contacts_by_email_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	Proper email address.

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]

contacts_by_email_get

Contact contacts_by_email_get(email)

Load Contact

Load detailed contact information for specified email. Required Access Level: ViewContacts

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.contact import Contact
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.ContactsApi(api_client)
    email = 'mail@example.com' # str | Proper email address.

    try:
        # Load Contact
        api_response = api_instance.contacts_by_email_get(email)
        print("The response of ContactsApi->contacts_by_email_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactsApi->contacts_by_email_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	Proper email address.

Return type

Contact

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]

contacts_by_email_put

Contact contacts_by_email_put(email, contact_update_payload)

Update Contact

Update selected contact. Omitted contact's fields will not be changed. Required Access Level: ModifyContacts

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.contact import Contact
from ElasticEmail.models.contact_update_payload import ContactUpdatePayload
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.ContactsApi(api_client)
    email = 'mail@example.com' # str | Proper email address.
    contact_update_payload = ElasticEmail.ContactUpdatePayload() # ContactUpdatePayload | 

    try:
        # Update Contact
        api_response = api_instance.contacts_by_email_put(email, contact_update_payload)
        print("The response of ContactsApi->contacts_by_email_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactsApi->contacts_by_email_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	Proper email address.
contact_update_payload	ContactUpdatePayload

Return type

Contact

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]

contacts_delete_post

contacts_delete_post(emails_payload)

Delete Contacts Bulk

Deletes provided contacts in bulk. Required Access Level: ModifyContacts

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.emails_payload import EmailsPayload
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.ContactsApi(api_client)
    emails_payload = ElasticEmail.EmailsPayload() # EmailsPayload | Provide either rule or a list of emails, not both.

    try:
        # Delete Contacts Bulk
        api_instance.contacts_delete_post(emails_payload)
    except Exception as e:
        print("Exception when calling ContactsApi->contacts_delete_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
emails_payload	EmailsPayload	Provide either rule or a list of emails, not both.

Return type

void (empty response body)

Authorization

apikey

HTTP request headers

Content-Type: application/json
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]

contacts_export_by_id_status_get

ExportStatus contacts_export_by_id_status_get(id)

Check Export Status

Check the current status of the export. Required Access Level: Export

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.export_status import ExportStatus
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.ContactsApi(api_client)
    id = 'E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F' # str | ID of the exported file

    try:
        # Check Export Status
        api_response = api_instance.contacts_export_by_id_status_get(id)
        print("The response of ContactsApi->contacts_export_by_id_status_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactsApi->contacts_export_by_id_status_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of the exported file

Return type

ExportStatus

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]

contacts_export_post

ExportLink contacts_export_post(file_format=file_format, rule=rule, emails=emails, compression_format=compression_format, file_name=file_name)

Export Contacts

Request an Export of specified Contacts. Required Access Level: Export

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.compression_format import CompressionFormat
from ElasticEmail.models.export_file_formats import ExportFileFormats
from ElasticEmail.models.export_link import ExportLink
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.ContactsApi(api_client)
    file_format = Csv # ExportFileFormats | Format of the exported file (optional) (default to Csv)
    rule = 'Status%20=%20Engaged' # str | Query used for filtering. (optional)
    emails = ['[\"mail@contact.com,mail1@contact.com,mail2@contact.com\"]'] # List[str] | Comma delimited list of contact emails (optional)
    compression_format = None # CompressionFormat | FileResponse compression format. None or Zip. (optional) (default to None)
    file_name = 'filename.txt' # str | Name of your file including extension. (optional)

    try:
        # Export Contacts
        api_response = api_instance.contacts_export_post(file_format=file_format, rule=rule, emails=emails, compression_format=compression_format, file_name=file_name)
        print("The response of ContactsApi->contacts_export_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactsApi->contacts_export_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_format	ExportFileFormats	Format of the exported file	[optional] [default to Csv]
rule	str	Query used for filtering.	[optional]
emails	List[str]	Comma delimited list of contact emails	[optional]
compression_format	CompressionFormat	FileResponse compression format. None or Zip.	[optional] [default to None]
file_name	str	Name of your file including extension.	[optional]

Return type

ExportLink

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-

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

contacts_get

List[Contact] contacts_get(limit=limit, offset=offset)

Load Contacts

Returns a list of contacts. Required Access Level: ViewContacts

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.contact import Contact
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.ContactsApi(api_client)
    limit = 100 # int | Maximum number of returned items. (optional)
    offset = 20 # int | How many items should be returned ahead. (optional)

    try:
        # Load Contacts
        api_response = api_instance.contacts_get(limit=limit, offset=offset)
        print("The response of ContactsApi->contacts_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactsApi->contacts_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	Maximum number of returned items.	[optional]
offset	int	How many items should be returned ahead.	[optional]

Return type

List[Contact]

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]

contacts_import_post

contacts_import_post(list_name=list_name, encoding_name=encoding_name, file_url=file_url, file=file)

Upload Contacts

Upload contacts from a file. Required Access Level: ModifyContacts

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.ContactsApi(api_client)
    list_name = 'list_name_example' # str | Name of an existing list to add these contacts to (optional)
    encoding_name = 'encoding_name_example' # str | In what encoding the file is uploaded (optional)
    file_url = 'file_url_example' # str | Optional url of csv to import (optional)
    file = None # bytearray |  (optional)

    try:
        # Upload Contacts
        api_instance.contacts_import_post(list_name=list_name, encoding_name=encoding_name, file_url=file_url, file=file)
    except Exception as e:
        print("Exception when calling ContactsApi->contacts_import_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
list_name	str	Name of an existing list to add these contacts to	[optional]
encoding_name	str	In what encoding the file is uploaded	[optional]
file_url	str	Optional url of csv to import	[optional]
file	bytearray		[optional]

Return type

void (empty response body)

Authorization

apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

HTTP response details

Status code	Description	Response headers
202	Accepted	-

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

contacts_post

List[Contact] contacts_post(contact_payload, listnames=listnames)

Add Contact

Add new Contacts to your Lists. Up to 1000 can be added (for more please refer to the import request). Required Access Level: ModifyContacts

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.contact import Contact
from ElasticEmail.models.contact_payload import ContactPayload
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.ContactsApi(api_client)
    contact_payload = [ElasticEmail.ContactPayload()] # List[ContactPayload] | 
    listnames = ['listnames_example'] # List[str] | Names of lists to which the uploaded contacts should be added to (optional)

    try:
        # Add Contact
        api_response = api_instance.contacts_post(contact_payload, listnames=listnames)
        print("The response of ContactsApi->contacts_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactsApi->contacts_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
contact_payload	List[ContactPayload]
listnames	List[str]	Names of lists to which the uploaded contacts should be added to	[optional]

Return type

List[Contact]

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]

FilesExpand file tree

ContactsApi.md

Latest commit

History

ContactsApi.md

File metadata and controls

ElasticEmail.ContactsApi

contacts_by_email_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contacts_by_email_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contacts_by_email_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contacts_delete_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contacts_export_by_id_status_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contacts_export_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contacts_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contacts_import_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

contacts_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details