Skip to main content
knowledgecenter.avangate.com

Send subscription registration emails

Overview

Use this method to send registration emails for a list of subscriptions.

Requirements

This method requires you to set a specific partner using setPartner.

Parameters

Parameter Type/Description
sessionID Required (String)
  Session identifier, output of the Login method. An exception is thrown if the values are incorrect.
subscriptionReferencesList Required (StringArray)
  Array of subscription references for which the registration email will be sent. You can send registration emails for a maximum of 50 subscriptions at once.
email Required (String)
  End user email address.
language Optional (String)
 

ISO 639-1 two-letter language code for the language used in email registration messages. You can use all languages active on your account. Default language is English (en). Can be NULL.

Response

Parameter Type/Description
result Boolean
  True or false

Request

<?php

require ('PATH_TO_AUTH');  // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication
require ('PATH_TO_setPartner'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/Partner/00Set_partner

$subscriptionReferencesList = array('REFERENCE_1', 'REFERENCE_2');
$email = 'YOUR_EMAIL_ADDRESS';
$language = 'YOUR_LANGUAGE';

$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'sendRegistrationEmail ',
'params' => array($sessionID, $subscriptionReferencesList, $email, $language)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));

Errors

Error Description

NOT_FOUND_PARTNER

A partner must be set first.

INVALID_ORDER

Order is not yet completed.

EMPTY_SUBSCRIPTION_REFERENCES_LIST

The subscription references list is empty.

INVALID_SUBSCRIPTION_REFERRENCE

The subscription reference is invalid.

INVALID_EMAIL

The email address is invalid.

REGISTRATION_EMAIL_SENDING_FAILED

Failed to send the registration email.