ImportApi.md

workplace_client.ImportApi

All URIs are relative to https://workplace-console.truehost.cloud/api

Method	HTTP request	Description
import_create	POST /import/	Bulk create emails

import_create

StandardResponse import_create(file, domain)

Bulk create emails

Bulk create emails via uploaded file and domain

Example

• Bearer (JWT) Authentication (BearerAuth):

import workplace_client
from workplace_client.models.standard_response import StandardResponse
from workplace_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://workplace-console.truehost.cloud/api
# See configuration.py for a list of all supported configuration parameters.
configuration = workplace_client.Configuration(
    host = "https://workplace-console.truehost.cloud/api"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = workplace_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with workplace_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = workplace_client.ImportApi(api_client)
    file = None # bytearray | CSV or excel file containing email accounts
    domain = 'domain_example' # str | Domain to associate with emails

    try:
        # Bulk create emails
        api_response = api_instance.import_create(file, domain)
        print("The response of ImportApi->import_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImportApi->import_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
file	bytearray	CSV or excel file containing email accounts
domain	str	Domain to associate with emails

Return type

StandardResponse

Authorization

BearerAuth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-

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