Skip to content

SenderIdentitiesApi.md

Latest commit

 

History

History
243 lines (149 loc) · 11.7 KB

SenderIdentitiesApi.md

File metadata and controls

243 lines (149 loc) · 11.7 KB

SenderIdentitiesApi

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

Method HTTP request Description
createSenderIdentities() POST /v1/senderIdentities/create Creates sender identity.
deleteSenderIdentities() DELETE /v1/senderIdentities/delete Deletes sender identity.
getSenderIdentityProperties() GET /v1/senderIdentities/properties Gets sender identity by ID or email.
listSenderIdentities() GET /v1/senderIdentities/list Lists sender identity.
reRequestSenderIdentities() POST /v1/senderIdentities/rerequest Rerequests denied sender identity.
resendInvitationSenderIdentities() POST /v1/senderIdentities/resendInvitation Resends sender identity invitation.
updateSenderIdentities() POST /v1/senderIdentities/update Updates sender identity.

createSenderIdentities()

createSenderIdentities(createSenderIdentityRequest: CreateSenderIdentityRequest): SenderIdentityCreated

Creates sender identity.

Parameters

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

Return type

SenderIdentityCreated

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/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
  • Accept: application/json

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

deleteSenderIdentities()

deleteSenderIdentities(email: string)

Deletes sender identity.

Parameters

Name Type Description Notes
email string The email address.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

getSenderIdentityProperties()

getSenderIdentityProperties(id: string, email: string): SenderIdentityViewModel

Gets sender identity by ID or email.

Parameters

Name Type Description Notes
id string The sender identity id. [optional]
email string The sender identity email. [optional]

Return type

SenderIdentityViewModel

Authorization

X-API-KEY, Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

listSenderIdentities()

listSenderIdentities(page: number, pageSize: number, search: string, brandIds: Array<string>): SenderIdentityList

Lists sender identity.

Parameters

Name Type Description Notes
page number Page index specified in get sender identity request. [default to 1]
pageSize number Page size specified in get sender identity list request. [optional] [default to 10]
search string Users can be listed by the search key present in the sender identity like sender identity name and email address [optional]
brandIds Array 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

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

reRequestSenderIdentities()

reRequestSenderIdentities(email: string)

Rerequests denied sender identity.

Parameters

Name Type Description Notes
email string The email address.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

resendInvitationSenderIdentities()

resendInvitationSenderIdentities(email: string)

Resends sender identity invitation.

Parameters

Name Type Description Notes
email string The email address.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

updateSenderIdentities()

updateSenderIdentities(email: string, editSenderIdentityRequest: EditSenderIdentityRequest)

Updates sender identity.

Parameters

Name Type Description Notes
email string The email address.
editSenderIdentityRequest 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/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
  • Accept: application/json

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