Operations at http://services.mailup.com/API/v1.1/Rest/ConsoleService.svc

This page describes the service operations at this endpoint.

Uri Method Description
Console/Authentication/Details GET Retrieve the details about current authenticated user and admin console.
Console/Authentication/Info GET Retrieve the information about current authenticated user and admin console.
Console/ContentProvider/Sources GET Retrieve the list of content sources.
POST Create a content source.
Console/ContentProvider/Sources/{id_Source} PUT Update a content source.
DELETE Delete the content source.
Console/ContentProvider/Sources/{id_Source}/Content POST Add or update a content.
GET Get source content.
Console/ContentProvider/Sources/{id_Source}/Content/{content_Key} DELETE Delete a content.
Console/Email/Send POST Send single email message to specified recipient.
Console/Email/Sending/{id_Sending}/Deferred GET Retrieves the first useful date to schedule the given sending task.
Console/Email/Sendings/{id_Sending} DELETE Delete the given sending task.
Console/Email/Sendings/{id_Sending}/Deferred POST Schedule a deferred dispatch of the given email message at the given datetime.
Console/Email/Sendings/{id_Sending}/Immediate POST Schedule an immediate dispatch of the given email message.
Console/Email/Sendings/{id_Sending}/Stop POST Stop the given sending task.
Console/Email/Sendings/Deferred GET Retrieves the status of email sending queues for deferred scheduled dispatches.
Console/Email/Sendings/Immediate GET Retrieves the status of email sending queues for immediate scheduled dispatches.
Console/Email/Sendings/Undefined GET Retrieves the status of email sending queues for dispatches to be scheduled.
Console/Group/{id_Group}/Email/{id_Message}/Send POST Send email message to all recipient in group.
Console/Group/{id_Group}/Recipient POST Import recipient to the specified group.
Console/Group/{id_Group}/Recipients POST Async Import recipients to the specified group.
GET Retrieve the recipients in the specified group.
Console/Group/{id_Group}/Subscribe/{id_Recipient} POST Subscribe the recipient with the related id to the specified group.
Console/Group/{id_Group}/Unsubscribe/{id_Recipient} DELETE Unsubscribe the recipient with the realated id from the specified group.
Console/Images GET Get the list of all shared images for the current console.
POST Add a new image to the shared images list.
DELETE Delete the image corresponding to the provided full path name.
Console/Import/{id_Import} GET Get import status.
Console/Import/{id_Import}/Sending GET Get sending identifier in order to access to the queue of confirmation request messages
Console/Imports GET Retrieve the list of imports.
Console/Imports/{id_Import} GET Retrieve the import details by id.
Console/Imports/StatusCodes GET Retrieve the list of import status codes.
Console/List POST Create a new list.
GET Retrieve the admin console lists by current user id.
Console/List/{id_List} PUT Modify details of the specified list.
DELETE Delete the specified list.
GET Retrieve list details by list id.
Console/List/{id_List}/Archived/Emails GET Retrieve the archived email messages by the specified list id.
Console/List/{id_List}/Email POST Create an email message in the specified list id.
Console/List/{id_List}/Email/{id_Message} POST Copy an email message.
PUT Modify an email message in the specified list id.
DELETE Delete an email message from the specified list id.
GET Retrieve the email details by specified id.
Console/List/{id_List}/Email/{id_Message}/Attachment GET Get attachment list for the specified message id.
Console/List/{id_List}/Email/{id_Message}/Attachment/{Slot} POST Add an attachment to the specified message id.
DELETE Delete the attachment in the corresponding slot for the specified message id.
Console/List/{id_List}/Email/{id_Message}/EnableDynamicFields/{enable} PUT Modify an email message in the specified list id, setting use dynamic field property to the specified value.
Console/List/{id_List}/Email/{id_Message}/OnlineVisibility PUT Modify the email message online visibility.
Console/List/{id_List}/Email/{id_Message}/Send POST Send an email message to the recipients in the specified list.
Console/List/{id_List}/Email/{id_Message}/SendHistory GET Get email message send history.
Console/List/{id_List}/Email/Template/{id_Template} POST Create an email message in the specified list id from template.
Console/List/{id_List}/Emails GET Retrieve the email messages (cloned and not cloned) by the specified list id.
Console/List/{ID_LIST}/Emails/SendHistory GET Get email send history.
Console/List/{id_List}/Group POST Create a new group in the specified list.
Console/List/{id_List}/Group/{id_Group} PUT Modify details of a group in the specified list.
DELETE Delete a group in the specified list.
Console/List/{id_List}/Group/{id_Group}/Recipients DELETE Empty a group in the specified list.
Console/List/{id_List}/Groups GET Retrieve the admin console groups by specified list id.
Console/List/{id_List}/Images GET Get all the images for the specified list.
POST Add a new image to the specified mailing list.
Console/List/{id_List}/Online/Emails GET Retrieve the email messages visible online through the website by the specified list id.
Console/List/{id_List}/Recipient POST Import recipient to the specified list.
Console/List/{id_List}/Recipient/{id_Recipient} DELETE Delete a recipient from specified list.
Console/List/{id_List}/Recipient/{id_Recipient}/Groups GET Retrieve the console groups by specified list and recipient id.
Console/List/{id_List}/Recipients POST Import recipients to the specified list.
Console/List/{id_List}/Recipients/EmailOptins GET Retrieve the recipients in the specified list (both subscribed and unsubscribed), including all sub/unsub details.
Console/List/{id_List}/Recipients/Pending GET Retrieve the pending recipients in the specified list.
Console/List/{id_List}/Recipients/Subscribed GET Retrieve the subscribed recipients in the specified list.
Console/List/{id_List}/Recipients/Unsubscribed GET Retrieve the unsubscribed recipients in the specified list.
Console/List/{id_List}/SmtpPlus POST Create a new SMTP+ user account.
Console/List/{id_List}/SmtpPlus/Reset POST Reset an existing SMTP+ user account.
Console/List/{id_List}/Subscribe/{id_Recipient} POST Subscribe a recipient to the specified list.
Console/List/{id_List}/Tag POST Create a tag in the specified list id.
Console/List/{id_List}/Tag/{id_Tag} PUT Modify a tag in the specified list id.
DELETE Delete a tag from the specified list id.
Console/List/{id_List}/Tags GET Get the enabled tag list for the specified list id.
Console/List/{id_List}/Templates GET Retrieve the list of the current defined message templates in the specified list.
Console/List/{id_List}/Templates/{id_Template} GET Retrieve the details for the specified message template in the specified list.
Console/List/{id_List}/Tracking/{id_Recipient} GET Get tracking status for specified list.
POST Enable/disable tracking for specified list.
Console/List/{id_List}/Unsubscribe/{id_Recipient} DELETE Unsubscribe a recipient from the specified list.
Console/List/Countries GET Retrieve the information about console country codes.
Console/List/Scopes GET Retrieve the information about list scopes. The scope is the purpouse you intend to use the list for.
Console/List/Unsubscribe/{id_Recipient} DELETE Unsubscribe a recipient from specified lists.
Console/Personalization/Endpoints GET Retrieve the list of personalization endpoints.
POST Add a personalization endpoint.
Console/Personalization/Endpoints/{id_Endpoint} GET Retrieve a personalization endpoint.
PUT Modify a personalization endpoint.
DELETE Delete a personalization endpoint.
Console/Personalization/Endpoints/{id_Endpoint}/List/{id_List} POST Add a personalization endpoint to a list.
DELETE Delete a personalization endpoint from a list.
Console/Personalization/Endpoints/List/{id_List} GET Retrieve the list of personalization endpoints by list.
Console/Recipient/Detail PUT Update a recipient with the specified details into address book.
Console/Recipient/DynamicFields GET Retrieve recipient dynamic field definitions.
Console/Recipients GET Retrieve recipients' information.
Console/Recipients/{id_Recipient} GET Retrieve recipient's information.
DELETE Delete a recipient from every list.
Console/Recipients/{id_Recipient}/EmailOptins GET Retrieve recipient's lists optin status.
Console/Recipients/{id_Recipient}/SmsOptins GET Retrieve recipient's lists optin status for Sms channel.
Console/Sms/{id_Message}/Sendings/Report GET Retrieve the SMS message sending report by specifying SMS ID.
Console/Sms/{id_Message}/Sendings/ReportDetails GET Retrieve the SMS message sending report details by specifying SMS ID.
Console/Sms/{SenderNumber}/ConfirmCode GET Get the SMS numeric sender authentication code.
POST Confirm an SMS numeric sender.
Console/Sms/{SenderNumber}/Status GET Retrieve the SMS Numeric Sender Status.
Console/Sms/Errors GET Retrieve non temporary errors with no delivered.
Console/Sms/Group/{id_Group}/Message/{id_Message}/Send POST Send sms message to all recipient in group.
Console/Sms/Group/{id_Group}/Recipient POST Import recipient to the specified group for Sms channel.
Console/Sms/Group/{id_Group}/Recipients GET Retrieve the recipients in the specified group for Sms channel.
POST Import recipient to the specified group for Sms channel.
Console/Sms/Group/{id_Group}/Subscribe/{id_Recipient} POST Subscribe the recipient with the related id to the specified group for Sms channel.
Console/Sms/List/{id_List}/Message POST Create an sms message in the specified list id.
Console/Sms/List/{id_List}/Message/{id_Message} PUT Modify an sms message in the specified list id.
DELETE Delete an sms message from the specified list id.
GET Retrieve the sms details by specified id.
Console/Sms/List/{id_List}/Message/{id_Message}/EnableDynamicFields/{enable} PUT Modify an sms message in the specified list id, setting use dynamic field property to the specified value.
Console/Sms/List/{id_List}/Message/{id_Message}/Send POST Send an sms message to the recipients in the specified list.
Console/Sms/List/{id_List}/Message/{id_Message}/SendHistory GET Get sms message send history.
Console/Sms/List/{id_List}/Messages GET Retrieve the sms messages by the specified list id.
Console/Sms/List/{id_List}/Messages/SendHistory GET Retrieve last sent messages.
Console/Sms/List/{id_List}/Recipient POST Import recipient to the specified list for Sms channel.
Console/Sms/List/{id_List}/Recipients POST Import recipient to the specified list for Sms channel.
Console/Sms/List/{id_List}/Recipients/Pending GET Retrieve the pending recipients in the specified list for Sms channel.
Console/Sms/List/{id_List}/Recipients/SmsOptins GET Retrieve the recipients in the specified list (both subscribed and unsubscribed), including all sub/unsub details, for Sms channel.
Console/Sms/List/{id_List}/Recipients/Subscribed GET Retrieve the subscribed recipients in the specified list for Sms channel.
Console/Sms/List/{id_List}/Recipients/Unsubscribed GET Retrieve the unsubscribed recipients in the specified list for Sms channel.
Console/Sms/List/{id_List}/Subscribe/{id_Recipient} POST Subscribe a recipient to the specified list.
Console/Sms/List/{id_List}/Unsubscribe/{id_Recipient} DELETE Unsubscribe a recipient from the specified list for Sms channel.
Console/Sms/List/Unsubscribe/{id_Recipient} DELETE Unsubscribe a recipient from specified lists for Sms channel.
Console/Sms/Send POST Send single sms message to specified recipient.
Console/Sms/Sending/{id_Sending}/Deferred GET Retrieves the first useful date to schedule the given sending task.
Console/Sms/Sendings/{id_Sending}/Deferred POST Schedule a deferred dispatch of the given sms message at the given datetime.
Console/Sms/Sendings/{id_Sending}/Immediate POST Schedule an immediate dispatch of the given sms message.
Console/Sms/Sendings/Deferred GET Retrieves the status of sms sending queues for deferred scheduled dispatches.
Console/Sms/Sendings/Immediate GET Retrieves the status of sms sending queues for immediate scheduled dispatches.
Console/Sms/Sendings/Undefined GET Retrieves the status of sms sending queues for dispatches to be scheduled.
Console/Sms/TempErrors GET Retrieve temporary errors with no delivered.
Console/SmtpPlusPriorities GET Retrieve SMTP+ priority information.
Console/Sso POST Retrieve the url to login into your MailUp platform. Please, contact MailUp to enable this option.
Console/TimeZones GET Retrieve the information about console time zones.
Console/Tracking/{id_Recipient} GET Get tracking status for every list.
POST Enable/disable tracking for every list.
Console/TrustedSenders GET Retrieve the list of trusted senders.
POST Request to trust provided email.
Console/TrustedSenders/{IdTrustedSender} GET Retrieve the selected trusted sender by id.
DELETE Disable the trusted sender by id.
Console/User/Emails GET Retrieve the email messages (cloned and not cloned) by current user id.
Console/User/List/{id_List} PUT DEPRECATED - Modify details of the specified list.
Console/User/Lists POST DEPRECATED - Create a new list.
GET DEPRECATED - Retrieve the admin console lists by current user id.