Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

2014-10-14 Confirmed opt-in and scheduled sending added to Version 1.1

...

What's new

  1. Performance improvement - API response time has been significantly reduced
  2. Added restriction - HTTP 403 error is returned if authenticated user has not yet accepted the MailUp "Terms of Service", which appears the first time the user signs in with the admin console account
  3. New features - version 1.1 has been extended with the following methods.

Confirmed opt-in for single subscriber (synchronous)

Code Block
POST Console/List/{ListID}/Recipient?ConfirmEmail=true

Adds a new subscriber to the specified list with the "Confirmed Optin" option turned on, which is an email marketing best practice. Recipient is added as "pending" and a confirmation request email is automatically sent.

Code Block
POST Console/Group/{GroupID}/Recipient?ConfirmEmail=true

Same as above, but the recipient is both (a) added to specified group and (b) subscribed to the list that the specified group belongs to.

Confirmed opt-in for multiple subscribers (asynchronous)

Code Block
POST Console/List/{ListID}/Recipients?ConfirmEmail=true

Adds a list of subscribers to the specified list with the "Confirmed Optin" option turned on. Recipients are added as "pending" and a confirmation request email is queued but not automatically sent

Code Block
POST Console/Group/{GroupID}/Recipients?ConfirmEmail=true

Same as above, but recipients are both (a) added to specified group and (b) subscribed to the list that the specified group belongs to.

Code Block
GET Console/Import/{id_import}/Sending

Gets the ID of the mailing that has been created in the system when adding recipients with the "Confirmed Optin" option set as 'true'. The mailing refers to the subscription confirmation request message.

Code Block
POST Console/Email/Sendings/{id_Sending}/Immediate

Schedules a mailing for immediate sending (i.e. send as soon as possible).

Code Block
POST Console/Email/Sendings/{id_Sending}/Deferred

Sets up a mailing for scheduled delivery (i.e. send at specified date and time)

Bulk unsubscription

Code Block
POST Console/List/{ListID}/Recipients?importType='asOptout' 

Allows you to "import as unsubscribed" a list of specified recipients. Please note that this import task will affect current subscribers, forcing their subscription status to "unsubscribed".

Send queue management

Code Block
GET Console/Email/Sendings/Immediate

Retrieves from the sending queue the list of email messages that are currently queued up for "immediate sending".

Code Block
GET Console/Email/Sendings/Deferred

 Retrieves from the sending queue the list of email messages that are currently scheduled for deferred delivery.

Code Block
GET Console/Email/Sendings/Undefined

Retrieves from the sending queue the list of messages that are neither "scheduled" nor queued up for "immediate sending". This is a "limbo" state that messages are placed into when they are removed from the queue either manually or because there was an issue.

Code Block
GET Console/Email/Sending/{id_Sending}/Deferred

Retrieves the earliest date to schedule the given sending task.

Scheduled mailing

Code Block
POST Console/List/{id_List}/Email/{id_Message}/Send?datetime='1994-11-05T13:15:30Z'

Allows you to schedule a specific message for deferred delivery. Make sure to use the UTC time zone when specifying the date and time. 

...

Version 1.1 has been updated with two new methods:

 

Code Block
GET - Console/List/{id_List}/Recipient/{id_Recipient}/Groups
: to retrieve

Retrieves the list of

the

groups

in

to which the specified recipient has been

subscribed

assigned.

 

Code Block
GET - Console/List/{id_List}/Archived/Emails
: to get

 

Retrieves the list of the archived emails in the specified list

 

2013-10-10 Version 1.1 has been released

...