SmartFocus Cloud Service APIs

Transcription

1 SmartFocus Cloud Service APIs Document name SmartFocus User Guide Service Campaign management for managing campaigns Protocol SOAP & REST over HTTP Version 11.8 Last updated on June 22, 2015

2 Table of Contents Table of Contents Table of Contents 2 Introduction 3 About This Document 3 About SmartFocus APIs 3 Feedback 3 Support Options 3 Training Options 3 SmartFocus's Products and Services 3 Disclaimer 3 Overview of the Message Builder API 4 Manually Obtaining Basic Access Authentication for the Message Builder API 4 Queries 5 JSON Objects 7 Connection 11 Recommended Token Usage 11 Open Connection 12 Close Connection 14 List of Messages 15 Examples 16 Create a Message 18 Examples 21 Retrieve a Message 23 Example 25 Update a Message 26 Examples 27 Retrieve a Content Block 28 Example 29 Retrieve a List of Content Blocks 29 Example 30 Delete a Message 31 Example

3 Introduction Introduction About This Document This document is a reference document for using SmartFocus APIs. It does not explain the purpose or functions of SmartFocus features. For information on these features, please consult the SmartFocus Online Help or the SmartFocus User Guide. This document is intended for developers and project managers. About SmartFocus APIs An Application Programming Interface (API) is a source code interface that a computer system or program library provides in order to support requests for services made from another computer program. The goal of SmartFocus APIs is to offer customers the ability to pilot a complete campaign from their own system. Feedback The SmartFocus User Guide is constantly being enhanced to provide you with more and more information on using SmartFocus API methods. If you can't find the information you need or want to provide feedback, simply drop us a line at documentation@smartfocus.com. We look forward to hearing from you! Support Options SmartFocus provides you with a dedicated Account Manager to accompany you throughout the execution of your projects in SmartFocus. Your Account Manager is the gateway to support, training, and professional services. Working with your Account Manager, you can rely on SmartFocus s deliverability and technical support teams for complex troubleshooting and optimization. Training Options SmartFocus provides fully comprehensive training ranging from basic product training through to advanced modules and both strategic and tactical marketing courses. The training courses are designed to help you increase productivity, develop new methods, and share best practices to optimize your , mobile, and social marketing campaigns. To get more information on training, please contact your Account Manager. SmartFocus's Products and Services For more information on SmartFocus's products and services, please see Disclaimer While the information contained in this publication is believed to be true and accurate, SmartFocus cannot accept any legal responsibility for any errors or omissions contained herein. All information is subject to change without notice. ne of the material in this publication may be reproduced or transmitted in whole or in part without the express written permission of SmartFocus. 3

4 Overview of the Message Builder API Overview of the Message Builder API The Message Builder API is in REST and allows you to manage your messages and perform the following actions: Obtain a list of messages created in the Message Builder feature and the Message feature Retrieve the content of a specific message created HTML mode in the Message Builder feature Create a message in the Message Builder feature in HTML mode Retrieve details for a specific content block or a list of content blocks Modify an existing message created in the Message Builder feature Delete a message from the Message Builder feature te: For all methods that generate a response, the response is in JSON. For further information on how to use the Message Builder feature in SmartFocus, please consult the SmartFocus User Guide or SmartFocus Online Help. The following methods are available: Connection Operation Description Open Connection This method provides a session token when given valid credentials. Close Connection This method terminates the session token. Message Operation List of Messages Retrieve a Message Create a Message Update a Message Retrieve a Content Block Retrieve a List of Content Blocks Delete a Message Description This method allows you to obtain a list of messages created in the Message Builder feature and the Message feature. This method allows you to retrieve the content of a specific message created in the Message Builder feature and the old Message feature. This operation allows you to create a message in the Message Builder feature in HTML mode only. This message allows you to modify a message in the Message Builder feature or the old Message feature. This method retrieves the details of a content block. This method retrieves a list of content blocks. This method deletes a message from the Message Builder feature. Manually Obtaining Basic Access Authentication for the Message Builder API To use the Message Builder API methods, a basic access authentication is required. The basic access authentication is granted when a valid access token is provided, which is obtained using the Open Connection method. Once you obtain a valid token, you can use any of the other methods. Most HTTP clients natively support basic access authentication such as the curl command line tool. In this case, the value for the username is the token itself and the password is left empty. If your HTTP client does not directly support basic access authentication, you can manually configure the Authorization header: 1. Add a colon to the end of your token (e.g., token:) 2. Encode the resulting string using Base64 (e.g., dg9rzw46cg==) 3. Add the prefix Basic followed by one space (e.g., Basic dg9rzw46cg==) 4. Set the Authorization header (e.g., Authorization: Basic dg9rzw46cg==) 4

5 Overview of the Message Builder API WWW-Authenticate Since the Smart Message Builder API supports basic access authentication and returns a WWW-Authenticate header, you can use your browser to make read-only requests and test examples of GET HTTP methods. Queries Expanding Queries By default, when using the List of Messages method in the Message Builder API, the reponse displays only the href values of the messages that correspond to the request criteria. Returning this amount of information by default helps optimize network traffic. In order to obtain more detail for any field of the Message Object that is returned in the response, you can use include the_ expand query to your request. Using the formula of _expand=.itemsdesired field and adding it to your request allows you to return all of the values for the field in all of the messages returned. If you want to display the values for every field of the messages returned following a request, add _expand=.items to the request. Example: To display the first name of all members named John who are from the UK or the US, include the expand query for the firstname field as shown in the example query below: GET /users?firstname=john&country=uk,us&_expand=items.firstname The response will resemble the following: "href": " "limit": 2, "first": "href": " "next": "href": " "items": [ "href": " "firstname": "John", "href": " "firstname": "John" ] Example: To display all of the information for members named John who are from the UK or the US, include the expand query as shown in the example below: GET /users?firstname=john&country=uk,us&_expand=items The response will resemble the following: "href": " "limit": 2, "first": "href": " "next": "href": " "items": [ "href": " 5

6 Overview of the Message Builder API ] "firstname": "John", "lastname": "Stuart", "country": "us", "href": " "firstname": "John", "lastname": "Doe", "country": "uk" Pagination Limit Queries When using the Message Builder API to retrieve data, your request may return a large volume of information. A useful way to control how much information is returned is with a pagination limit query. The pagination limit query allows you to define how many objects from your database are returned per collection page for your request so that you can process the information more easily. By using the _limit query parameter as in the example below, you can limit the number of objects returned in a request: Example: The following request returns 5 users at most: GET /users?_limit=5 Filtering Queries Filtering queries allow you to specify the data that you want returned for a request by using certain criteria. The criteria used for the filter must be defined by query parameter. The query parameter is made up of the two following elements: Query parameter name: The query parameter name is the name of the filtered object field. Query parameter value: The query parameter value is a list of values you want to be returned. These values are separated by commas. Example: The following request returns a list of all users with the first name "John" and the who are from either the "United Kingdom" or the "United States": GET /users?firstname=john&country=uk,us Date Range Filtering Queries Using date range filtering allows you to filter the data returned from a request according to its date range. The format of a date range query is as follows: fieldname=fromdate~todate fieldname fromdate todate Parameter Description Type Default Value The name of the field to filter on. Must be a supported date field. The start date of the date range. The end date of the date range. String Date Date The beginning of time. The current date. 6

7 Overview of the Message Builder API Example: The following request lists all users that were created on January 2015 where: the creationdate field is being filtered, the from date is T00:00: , the to date is T23:59: , and the plus (+) symbol is replaced by the code %2B: GET /users?creationdate= t00:00:00.000%2b0000~ T23:59:59.999%2B0000 Example: The following request lists all users that have been modified since 2015: GET /users?modificationdate= t00:00:00.000%2b0000~ JSON Objects Message Object The JSON object that represents a message that can be used in campaigns contains the following fields: Field Name Description Field Type Updatable Personalizable Nullable href id version mode status name subject The unique URL reference for the message. The unique identifier of the message. The version of the message with the following values: 1: messages created in the old Message feature 2: messages created in the Message Builder The mode of the message in themessage Builder: html: The message is in HTML mode. visual: The message is in visual mode. The status of a message. The name of a message. The subject of a message. Reference ID Message Version Message Mode Message Status String Yes Yes String Yes Yes Yes 7

8 Overview of the Message Builder API Field Name Description Field Type Updatable Personalizable Nullable creationdate modificationdate fromlabel from tolabel replytolabel replyto favorite links text html The date when the Date message was created. The date when the message was last modified. This field is automatically updated whenever a change is made to the message. Date The information that will be displayed next to the sender in String Yes Yes Yes the 's From field. The sender address defined for your account. This entry can be changed in the Headers Setup (Mktg) of the Account Settings section. The information that will be displayed in the 's To field. The information that will be displayed next to the reply-to address. The address that should serve as the 's reply-to address. Whether or not the message is indicated as a favorite. Contains the links used in the message. The plain-text part of the message body. The HTML part of the message body. String Yes Yes String Yes Yes Yes Yes Boolean Link array Yes String Yes Yes String Yes Yes te: The html field of the JSON message object cannot be null if the value of the status field is ready. 8

9 Overview of the Message Builder API Field Name Description Field Type Updatable Personalizable Nullable externalmessageid The external message ID is different from the message ID in that the external message ID is the only unique identifier for a version 2 message with the status value of ready that can be used with any other SmartFocus API developed previous to the Message Builder API. ID Example: The following is an example of what a message object will resemble: "href": " "id": "fe3c4f7d-066e-45d4-9eae-4292e493a832", "name": "Welcome 2015", "subject": "Welcome to Acme!", "creationdate": " T13:19: ", "modificationdate": " T14:14: ", "fromlabel": "Acme", "from ": "news@acme.com", "tolabel": "firstname lastname", "replytolabel": "Acme Contact", "version": "2", "favorite": false, "status": "draft", "mode": "html", "links": [ "id": 1, "type": "standard", "url": " ], "html": "<!DOCTYPE html><html><head></head><body><h1>welcome firstname lastname!</h1> <p>our <a href=\"link 1\">list of products</a>.</p></body></html>" Link Object The link object is contained in a message object and contains link information for the message. The link object can contain the following fields: Field Name Description Field Type Updatable id The unique order of the link. ID Yes type The type of link. Link Type Yes label The label defined for the link. String Yes Yes Nullable 9

10 Overview of the Message Builder API Field Name url untracked Description The URL of the link. te: Only used with links that have the value standard or personalised in the type field. Whether or not a standard link is tracked. te: The untracked option can only be used with standard links. When a standard link is untracked, the value displayed is yes. Field Type Updatable String Yes Yes Boolean Yes Yes Nullable confirmationurl errorurl updateparameters The URL where the member is redirected when they click the link and the link functions correctly. The URL where the member is redirected when they click the link and the link does not function correctly. The value and the member table field where the value is inserted when the member clicks the link. The syntax for the update link parameter is: FIELDNAME1='value1',FIELDNAME2='value2' Example: TITLE='Mrs.',LASTNAME='Smith' String Yes Yes String Yes Yes String Yes Yes messageid The ID of the message. ID Yes Yes siteid The ID of the landing page. ID Yes Yes Example: An example standard link to the SmartFocus website will resemble the following: "id": "241", "type": "standard", "url": " "label": "SmartFocus" 10

11 Connection Connection Prerequisite: To use SmartFocus APIs, you need to have the API manager login provided by SmartFocus and the associated password. To connect through the API, you must first retrieve the manager key from SmartFocus. 1. Go to Account Administration and select Logins. 2. Click the Edit icon next to your API manager. 3. In the API section of the popup window, copy the API key (also known as the manager key) and use it to open a connection to retrieve the token that will be used in your calls. Calling the connect method (with the login, password, manager key) will provide a token, to be used in all subsequent calls. This token will expire in the following cases: When a close connection call is made. When the maximum number of calls per session, defined by the manager in SmartFocus, is reached. When the session times out. Recommended Token Usage An open connection call generates a token that should be used until it expires. Once the token expires, an API call will generate a session exception. At this point, you should open a new connection to continue your API calls. Example: An example workflow: 1. Open the connection to generate the token. 2. Use API method calls as needed. If a call fails due to a problem with the session: a. Send another open connection call to renew the token. b. Resend the call that failed due to the session issue. 3. Send a close connection call once all API method calls for the session have been sent successfully. te: For time consuming calls (e.g., uploading a large file), you may need to use an open connection call to ensure that the token will remain valid for the duration of the call. 11

12 Open Connection This method provides a session token when given valid credentials. te: The token is valid for 60 minutes. This is a POST method. URL te: The server information you enter in the URL depends on which of the following data centers your account is associated: Data Center Telecity Equinix Server apir.campaigncommander.com apie.campaigncommander.com For more information, please contact your Account Manager. Required parameters Description JSON Body Fields login password The login provided for API access. The password. te: API passwords expire after 365 days. apikey The manager key copied from SmartFocus(see Connection on page 11) Error Responses Status Error Messages 400 The JSON object body is either invalid or missing. The following fields are missing or invalid. 401 The credentials you entered are incorrect. Example Method POST JSON Body Fields "login": "AcmeAdmin", "password": "Acme2014*", "apikey": "CdX7CrlE_26blFNJOsgfdawh6LJ3y6pwg5PEOvA" 12

13 Response "token": "Nn3HisxFdwAu4W76mBewV9fOegnkDcDexzOKGTeBWmmNPqDigN_Z-0h" 13

14 Close Connection This method terminates the session token. This is a REST DELETE method. URL te: The server information you enter in the URL depends on which of the following data centers your account is associated: Data Center Telecity Equinix Server apir.campaigncommander.com apie.campaigncommander.com For more information, please contact your Account Manager. Required parameters Description HTTP Header Authorization Example Method The Basic access authorization. DELETE Header Authorization: Basic Base64 encoded "token:" Response te: response is generated. 14

15 List of Messages List of Messages This method allows you to obtain a list of messages created in the Message Builder feature and the Message feature. This is a GET method. URL te: The server information you enter in the URL depends on which of the following data centers your account is associated: Data Center Telecity Equinix Server apir.campaigncommander.com apie.campaigncommander.com For more information, please contact your Account Manager. Required parameters HTTP Header Authorization Query Parameters version Description The Basic access authorization. Allows you to filter the list of messages returned by message version. You can only retrieve one of the following message version types per request: 1: messages created in the old Message feature 2: messages created in the Message Builder externalmessageid _expand _limit te: If the version parameter is not defined in the request, by default only messages created with the Message Builder (i.e., version 2) are displayed. The external message ID is different from the message ID in that the external message ID is the only unique identifier for a version 2 message with the status value of ready that can be used with any other SmartFocus API developed previous to the Message Builder API. This means that if you want to create a campaign using another API in SOAP or REST, the externalmessageid is the identifier to use for the message created in the Message Builder feature. Allows you to expand any field of the Message Object. Allows you to set the limit of messages listed on a page. Error Responses Status Error Messages The Authorization header is missing. The credentials you entered are incorrect. 401 The Authorization header is incorrectly encoded. Basic authentication information is missing. 404 The message with the ID ''0'' cannot be found. 15

16 List of Messages Examples List All Message Builder Messages Method GET Header Authorization: Basic Base64 encoded "token:" Response "href": " "limit": 10, "next": "href": " "items": [ "href": " "href": " ] List All Messages from Old Message Feature Method GET Header Authorization: Basic dg9rzw46cg== Response "href": " "limit": 10, "next": "href": " "items": [ "href": " "href": " ] 16

17 List of Messages List Message Builder Messages with Message Name Displayed Method GET Header Authorization: Basic dg9rzw46cg== Response "href": " "limit": 10, "next": "href": " "items": [ "href": " "name": "December Newsletter", "href": " "name": "vember Newsletter",...,... ] 17

18 Create a Message Create a Message This operation allows you to create a message in the Message Builder feature in HTML mode only. This is a POST method. URL te: The server information you enter in the URL depends on which of the following data centers your account is associated: Data Center Telecity Equinix Server apir.campaigncommander.com apie.campaigncommander.com For more information, please contact your Account Manager. Required parameters Description HTTP Header Authorization JSON Body Fields status version The Basic access authorization. The status of the message: draft ready The version of the message: 1: old Message feature 2: Message Builder te: You can only create messages with the version number 2 using the Message Builder API. The mode of the message: mode visual html te: Currently, you can only create messages in HTML mode using the Message Builder API. name subject favorite from fromlabel The name of the message. The subject of the message. te: This field is required only if the status field value is set to ready. Whether or not the message has been marked as a favorite. The From address. te: This field is required only if the status field value is set to ready. The From name. te: This field is required only if the status field value is set to ready. 18

19 Create a Message Required parameters Description tolabel replyto replytolabel text html links The To name. te: This field is required only if the status field value is set to ready. The Reply To address. The Reply To name. te: This field is required only if the status field value is set to ready. The text that appears in the text-only version of the message. The HTML content used for the message. The links in the message. Error Responses Status Error Messages The JSON object body is either invalid or missing. The following fields are missing or invalid. 400 You do not have the following user rights for the MESSAGE feature: 0. A message that has already been sent in a campaign cannot be deleted. Messages created in the Message feature cannot be modified. The Authorization header is missing. The credentials you entered are incorrect. 401 The Authorization header is incorrectly encoded. Basic authentication information is missing. 404 The message with the ID ''0'' cannot be found. JSON Body Response Fields Name Description Personalization Type Modifiable Nullable href The unique URL reference to the message. Reference id The unique identifier to the message. String name The name of the message. String Yes Yes subject The subject of the message. Yes String Yes Yes html The HTML part of the message body. Yes String Yes Yes text The text part of the message body. Yes String Yes Yes fromlabel The label describing the sender. Yes String Yes Yes from The of the sender. Yes String Yes tolabel The label of the message recipient. Yes String Yes Yes replytolabel The label of the reply to address. Yes String Yes Yes replyto The reply to address. String Yes Yes creationdate The date when the message was created. The date format used is ISO-8601 with the time zone UTC. Date 19

20 Create a Message Name Description Personalization Type Modifiable Nullable modificationdate The date when the message was last modified. The date format used is ISO-8601 with the time zone UTC. te: This field is automatically updated when any change is made to the message. The version of the message: Date version 1: The message was created in the Message feature. 2: The message was created in the old Message feature. Message Version te: Currently, you can only create messages in HTML mode using the Message Builder API. The status of the message. status te: This field can only be changed from draft to ready. Once the message has been set to ready, it cannot be reverted back to draft. Message Status Yes The mode of the message: HTML mode Visual te: When updating the HTML part of a visual message, the mode field value is automatically changed to html. Message Mode favorite links Whether or not the message is marked as a favorite (with a star in the interface). The links used in the message: standard: A standard link redirects to a given URL. personalized: A link with personalization in the URL. mirror: A mirror link directs to an automatically generated, web-based version of the message. unsubscribe: An unsubscribe link will indicate that the member who clicks the link does not wish to receive further messages. sites: A sites link directs to an active landing page. update: An update link will update a specific field of member database when clicked. Boolean Yes List of Message Links Yes 20

21 Create a Message Examples Creating a Draft Message Method POST Header Authorization: Basic Base64 encoded "token:" JSON Body Fields "name": "Acme News", "status": "draft", "mode": "html", "text": "Acme News", "html": "<!DOCTYPE html><html><head><title>acme News</title></head><body>\n<h1>Acme News</h1>\n <p>our <a href=\" of products</a>!</p>\n</body></html>" Response "href": " "id": "d7bf11e4-09c e34-2eb7f1b47390", "name": "Acme News", "creationdate": " T14:21: ", "modificationdate": " T14:21: ", "from ": "admin@hatcompany.com", "version": "2", "status": "draft", "mode": "html", "links": [ "id": 1, "type": "standard", "url": " ], "html": "<!DOCTYPE html><html><head><title>acme News</title></head><body>\n<h1>Acme News</h1>\n <p>our <a href=\"link 1\" target=\"_blank\">list of products</a>!</p>\n</body></html>" Creating a Ready Message Method POST Header Authorization: Basic dg9rzw46cg== JSON Body Fields "name": "Acme News", "status": "ready", "mode": "html", "subject": "Acme News", "from ": "editor@acme.com", 21

22 Create a Message "fromlabel": "Acme News", "tolabel": "FIRSTNAME LASTNAME", "replytolabel": "Acme Contact", "text": "Acme News", "html": "<!DOCTYPE html><html><head><title>acme News</title></head><body>\n<h1>Acme News</h1>\n <p>our <a href=\" of products</a>!</p>\n</body></html>" ' Response "href": " "id": "91424a69-a9fc-49a5-83fb f80fe", "name": "Acme News", "subject": "Acme News", "creationdate": " T11:00: ", "modificationdate": " T11:00: ", "fromlabel": "Acme News", "from ": "editor@acme.com", "tolabel": "FIRSTNAME LASTNAME", "replytolabel": "Acme Contact", "externalmessageid": "34558", "version": "2", "status": "ready", "mode": "html", "links": [ "id": 1, "type": "standard", "url": " ], "text": "Acme News", "html": "<!DOCTYPE html><html><head><title>acme News</title></head><body>\n<h1>Acme News</h1>\n <p>our <a href=\"link 1\" target=\"_blank\">list of products</a>!</p>\n</body></html>" 22

23 Retrieve a Message Retrieve a Message This method allows you to retrieve the content of a specific message created in the Message Builder feature and the old Message feature. This is a GET method. URL te: The server information you enter in the URL depends on which of the following data centers your account is associated: Data Center Telecity Equinix Server apir.campaigncommander.com apie.campaigncommander.com For more information, please contact your Account Manager. Required parameters Description HTTP Header Authorization Path Parameter messageid The Basic access authorization. The ID of the message Error Responses Status Error Messages The Authorization header is missing. The credentials you entered are incorrect. 401 The Authorization header is incorrectly encoded. Basic authentication information is missing. 404 The message with the ID ''0'' cannot be found. JSON Body Response Fields Name Description Personalization Type Modifiable Nullable href The unique URL reference to the message. Reference id The unique identifier to the message. String name The name of the message. String Yes Yes subject The subject of the message. Yes String Yes Yes html The HTML part of the message body. Yes String Yes Yes text The text part of the message body. Yes String Yes Yes fromlabel The label describing the sender. Yes String Yes Yes from The of the sender. Yes String Yes 23

24 Retrieve a Message Name Description Personalization Type Modifiable Nullable tolabel The label of the message recipient. Yes String Yes Yes replytolabel The label of the reply to address. Yes String Yes Yes replyto The reply to address. String Yes Yes creationdate modificationdate The date when the message was created. The date format used is ISO-8601 with the time zone UTC. The date when the message was last modified. The date format used is ISO-8601 with the time zone UTC. te: This field is automatically updated when any change is made to the message. The version of the message: Date Date version 1: The message was created in the Message feature. 2: The message was created in the old Message feature. Message Version The status of the message. status te: This field can only be changed from draft to ready. Once the message has been set to ready, it cannot be reverted back to draft. Message Status Yes mode favorite links The mode of the message: HTML Visual Whether or not the message is marked as a favorite (with a star in the interface). The links used in the message: standard: A standard link redirects to a given URL. personalized: A link with personalization in the URL. mirror: A mirror link directs to an automatically generated, web-based version of the message. unsubscribe: An unsubscribe link will indicate that the member who clicks the link does not wish to receive further messages. sites: A sites link directs to an active landing page. update: An update link will update a specific field of member database when clicked. Message Mode Boolean Yes List of Message Links Yes 24

25 Retrieve a Message Example Retrieving a Specific Message Using the Message ID Method GET Header Authorization: Basic Base64 encoded "token:" Response "href": " "id": "0045e1b2-b48c-47ba-a982-95ee0e1a08c6", "name": "Welcome 2015", "subject": "Welcome to Acme!", "creationdate": " T13:19: ", "modificationdate": " T14:14: ", "fromlabel": "Acme", "from ": "news@acme.com", "tolabel": "firstname lastname", "replytolabel": "Acme Contact", "version": "2", "favorite": false, "status": "draft", "mode": "html", "links": [ "id": 1, "type": "standard", "url": " ], "html": "<!DOCTYPE html><html><head></head><body><h1>welcome firstname lastname!</h1> <p>our <a href=\"link 1\">list of products</a>.</p></body></html>" 25

26 Update a Message Update a Message This message allows you to modify a message in the Message Builder feature or the old Message feature. This is a POST method. URL te: The server information you enter in the URL depends on which of the following data centers your account is associated: Data Center Telecity Equinix Server apir.campaigncommander.com apie.campaigncommander.com For more information, please contact your Account Manager. Required parameters Description HTTP Headers Authorization Path Parameter messageid The Basic access authorization. The ID of the message JSON Body Fields status version mode name subject favorite from fromlabel tolabel replyto replytolabel text html links The status of the message: draft ready The version of the message: 1: old Message feature 2: Message Builder The mode of the message: visual html The name of the message. The subject of the message. Whether or not the message has been marked as a favorite. The From address. The From name. The To name. The Reply To address. The Reply To name. The text that appears in the text-only version of the message. The HTML content used for the message. The links in the message. 26

27 Update a Message Error Responses Status Error Messages The JSON object body is either invalid or missing. The following fields are missing or invalid. 400 You do not have the following user rights for the MESSAGE feature: 0. A message that has already been sent in a campaign cannot be deleted. Messages created in the Message feature cannot be modified. The Authorization header is missing. The credentials you entered are incorrect. 401 The Authorization header is incorrectly encoded. Basic authentication information is missing. 404 The message with the ID ''0'' cannot be found. Examples Marking a Message as Favorite Method POST Header Authorization: Basic Base64 encoded "token:" JSON Body Fields "favorite": true Response "href": " "id": "d7bf11e4-09c e34-2eb7f1b47390", "name": "Acme News", "favorite": true, "creationdate": " T14:21: ", "modificationdate": " T14:21: ", "from ": "admin@acme.com", "version": "2", "status": "draft", "mode": "html", "links": [ "id": 1, "type": "standard", "url": " ], "html": "<!DOCTYPE html><html><head><title>acme News</title></head><body>\n<h1>Acme News</h1>\n <p>our <a href=\"link 1\" target=\"_blank\">list of products</a>!</p>\n</body></html>" 27

28 Retrieve a Content Block Changing a Message's Status to Ready Method POST Header Authorization: Basic Base64 encoded "token:" JSON Body Fields "status": "ready", "subject": "Acme News", "fromlabel": "Acme Administrator", "tolabel": "firstname lastname", "replytolabel": "Acme Contact" Response "href": " "id": "f35f726c-29c4-4d21-b4f9-be7b a", "name": "Newsletter January 2015", "subject": "Acme News", "creationdate": " T12:70: ", "modificationdate": " T13:09: ", "fromlabel": "Acme Administrator", "from ": "admin@acme.com", "tolabel": "firstname lastname", "replytolabel": "Acme Contact", "externalmessageid": "34690", "version": "2", "favorite": false, "status": "ready", "mode": "html", "links": [ "id": 1, "type": "standard", "url": " ], "text": "Acme News\List of our products: link 1", "html": "<!DOCTYPE html><html><head><title>acme News</title></head><body>\n<h1>Acme News</h1>\n <p>list of our <a href=\"link 1\" target=\"_blank\">products</a>!</p>\n</body></html>" Retrieve a Content Block This method retrieves the details of a content block. This is a GET method. URL te: The server information you enter in the URL depends on which of the following data centers your account is associated: 28

29 Retrieve a List of Content Blocks Data Center Telecity Equinix Server apir.campaigncommander.com apie.campaigncommander.com For more information, please contact your Account Manager. Required parameters Description HTTP Header Authorization Path Parameter contentblockid The Basic access authorization. The ID of the message Example Method GET Head er Authorization: Basic Base64 encoded "token:" Response "href": " "id": "4312", "type": "html", "name": "Acme Footer", "description": "A footer that can should put at the bottom of messages.", "creationdate": " T13:57: ", "modificationdate": " T12:14: ", "content": "<p>copyright <b>acme</b> 2015</p>" Retrieve a List of Content Blocks This method retrieves a list of content blocks. This is a GET method. URL te: The server information you enter in the URL depends on which of the following data centers your account is associated: 29

30 Retrieve a List of Content Blocks Data Center Telecity Equinix Server apir.campaigncommander.com apie.campaigncommander.com For more information, please contact your Account Manager. Required parameters Description HTTP Headers Authorization Query Parameters _limit _expand The Basic access authorization. Allows you to define how many items to show per page. Allows you to see the details pertaining to an item returned in the response. Example Method GET Head er Authorization: Basic Base64 encoded "token:" Response "href": " "limit": 10, "next": "href": " "items": [ "href": " "href": " ] 30

31 Delete a Message Delete a Message This method deletes a message from the Message Builder feature. This is a DELETE method. URL te: The server information you enter in the URL depends on which of the following data centers your account is associated: Data Center Telecity Equinix Server apir.campaigncommander.com apie.campaigncommander.com For more information, please contact your Account Manager. Required parameters Description HTTP Header Authorization Path Parameter messageid The Basic access authorization. The ID of the message Example Method DELETE Header Authorization: Basic Base64 encoded "token:" Response te: response is generated. 31