Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!

transferEmailCredits


Partner API Only
The transferEmailCredits() method transfers email credits from one company’s account to another. The number of credits transferred must be a whole number greater than or equal to one, and the company from which the credits are being transferred must have sufficient credits in its account for the requested transaction. Note: credits can only be transferred within the cobrand: from the master account to a subaccount, or between subaccounts.

Input

[vrtypens:transferEmailCreditsArgs]

session_id [xsd:string] (required)
Your API session id.
from_company_id [xsd:int] (required)
The ID of the company the credits are being transferred from.
to_company_id [xsd:int] (required)
The ID of the company the credits are being transferred to.
credits_to_transfer [xsd:int] (required)
The number of credits to transfer.

Output

[xsd:boolean]

Examples

PHP

$vrapi->transferEmailCredits( array(
    'session_id'          => $sid, 
    'from_company_id'     => 1234,
    'to_company_id'       => 5678,
    'credits_to_transfer' => 50,
) );

Ruby

vr.transferEmailCredits({
    'session_id'          => sid, 
    'from_company_id'     => 1234,
    'to_company_id'       => 5678,
    'credits_to_transfer' => 50,
})

Java

TransferEmailCreditsArgs transferEmailCreditsArgs = new TransferEmailCreditsArgs();
	transferEmailCreditsArgs.setSession_id(sessionID);
	transferEmailCreditsArgs.setFrom_company_id(1234);
	transferEmailCreditsArgs.setTo_company_id(5678);
	transferEmailCreditsArgs.setCredits_to_transfer(15);

boolean creditsResult = vr.transferEmailCredits(transferEmailCreditsArgs);

C#/.NET

transferEmailCreditsArgs tECA = new transferEmailCreditsArgs();
	tECA.session_id = sessionId;
	tECA.from_company_id = 1234;
	tECA.to_company_id = 5678;
	tECA.credits_to_transfer = 15;

bool creditsTransferred;

try
{
	creditsTransferred = objVR.transferEmailCredits(tECA);
}
catch (Exception e)
{
	 System.Console.WriteLine(e.Message);
}

Perl

$vrapi->transferEmailCredits( {
    session_id => $sid, 
    from_company_id => 1234,
    to_company_id => 5678,
    credits_to_transfer => 50,
} );