SenderApi.md

sendx.SenderApi

All URIs are relative to https://api.sendx.io/api/v1/rest

Method	HTTP request	Description
createSender	POST /sender	Create sender
getAllSenders	GET /sender	Get all senders

createSender

RestRSender createSender(restESender)

Create sender

Adds a new sender email address.

Example

import sendx from 'sendx-javascript-sdk';
let defaultClient = sendx.ApiClient.instance;
// Configure API key authorization: TeamApiKey
let TeamApiKey = defaultClient.authentications['TeamApiKey'];
TeamApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TeamApiKey.apiKeyPrefix = 'Token';

let apiInstance = new sendx.SenderApi();
let restESender = new sendx.RestESender(); // RestESender | 
apiInstance.createSender(restESender).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
restESender	RestESender

Return type

RestRSender

Authorization

TeamApiKey

HTTP request headers

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

getAllSenders

[RestRSender] getAllSenders()

Get all senders

Retrieves all verified sender addresses.

Example

import sendx from 'sendx-javascript-sdk';
let defaultClient = sendx.ApiClient.instance;
// Configure API key authorization: TeamApiKey
let TeamApiKey = defaultClient.authentications['TeamApiKey'];
TeamApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TeamApiKey.apiKeyPrefix = 'Token';

let apiInstance = new sendx.SenderApi();
apiInstance.getAllSenders().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

[RestRSender]

Authorization

TeamApiKey

HTTP request headers

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