boldsign.SenderIdentitiesApi

All URIs are relative to https://api.boldsign.com

Method	HTTP request	Description
create_sender_identities	POST /v1/senderIdentities/create	Creates sender identity.
delete_sender_identities	DELETE /v1/senderIdentities/delete	Deletes sender identity.
list_sender_identities	GET /v1/senderIdentities/list	Lists sender identity.
re_request_sender_identities	POST /v1/senderIdentities/rerequest	Rerequests denied sender identity.
resend_invitation_sender_identities	POST /v1/senderIdentities/resendInvitation	Resends sender identity invitation.
update_sender_identities	POST /v1/senderIdentities/update	Updates sender identity.

create_sender_identities

create_sender_identities(create_sender_identity_request)

Creates sender identity.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.create_sender_identity_request import CreateSenderIdentityRequest
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.SenderIdentitiesApi(api_client)
    create_sender_identity_request = boldsign.CreateSenderIdentityRequest() # CreateSenderIdentityRequest | The create sender identity request.

    try:
        # Creates sender identity.
        api_instance.create_sender_identities(create_sender_identity_request)
    except Exception as e:
        print("Exception when calling SenderIdentitiesApi->create_sender_identities: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_sender_identity_request	CreateSenderIdentityRequest	The create sender identity request.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-

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

delete_sender_identities

delete_sender_identities(email)

Deletes sender identity.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.SenderIdentitiesApi(api_client)
    email = 'email_example' # str | The email address.

    try:
        # Deletes sender identity.
        api_instance.delete_sender_identities(email)
    except Exception as e:
        print("Exception when calling SenderIdentitiesApi->delete_sender_identities: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	The email address.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

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

list_sender_identities

SenderIdentityList list_sender_identities(page, page_size=page_size, search=search, brand_ids=brand_ids)

Lists sender identity.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.sender_identity_list import SenderIdentityList
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.SenderIdentitiesApi(api_client)
    page = 1 # int | Page index specified in get sender identity request. (default to 1)
    page_size = 10 # int | Page size specified in get sender identity list request. (optional) (default to 10)
    search = 'search_example' # str | Users can be listed by the search key present in the sender identity like sender identity name and email address (optional)
    brand_ids = ['brand_ids_example'] # List[str] | A list of brand IDs to filter associated with the sender identity. (optional)

    try:
        # Lists sender identity.
        api_response = api_instance.list_sender_identities(page, page_size=page_size, search=search, brand_ids=brand_ids)
        print("The response of SenderIdentitiesApi->list_sender_identities:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SenderIdentitiesApi->list_sender_identities: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Page index specified in get sender identity request.	[default to 1]
page_size	int	Page size specified in get sender identity list request.	[optional] [default to 10]
search	str	Users can be listed by the search key present in the sender identity like sender identity name and email address	[optional]
brand_ids	List[str]	A list of brand IDs to filter associated with the sender identity.	[optional]

Return type

SenderIdentityList

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	Unauthorized	-
403	Forbidden	-

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

re_request_sender_identities

re_request_sender_identities(email)

Rerequests denied sender identity.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.SenderIdentitiesApi(api_client)
    email = 'email_example' # str | The email address.

    try:
        # Rerequests denied sender identity.
        api_instance.re_request_sender_identities(email)
    except Exception as e:
        print("Exception when calling SenderIdentitiesApi->re_request_sender_identities: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	The email address.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

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

resend_invitation_sender_identities

resend_invitation_sender_identities(email)

Resends sender identity invitation.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.SenderIdentitiesApi(api_client)
    email = 'email_example' # str | The email address.

    try:
        # Resends sender identity invitation.
        api_instance.resend_invitation_sender_identities(email)
    except Exception as e:
        print("Exception when calling SenderIdentitiesApi->resend_invitation_sender_identities: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	The email address.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

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

update_sender_identities

update_sender_identities(email, edit_sender_identity_request)

Updates sender identity.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.edit_sender_identity_request import EditSenderIdentityRequest
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.SenderIdentitiesApi(api_client)
    email = 'email_example' # str | The email address.
    edit_sender_identity_request = boldsign.EditSenderIdentityRequest() # EditSenderIdentityRequest | The create sender identity request.

    try:
        # Updates sender identity.
        api_instance.update_sender_identities(email, edit_sender_identity_request)
    except Exception as e:
        print("Exception when calling SenderIdentitiesApi->update_sender_identities: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	The email address.
edit_sender_identity_request	EditSenderIdentityRequest	The create sender identity request.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

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

Files

SenderIdentitiesApi.md

Latest commit

History

SenderIdentitiesApi.md

File metadata and controls

boldsign.SenderIdentitiesApi

create_sender_identities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_sender_identities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_sender_identities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

re_request_sender_identities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

resend_invitation_sender_identities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_sender_identities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details