Optimove API Usage Guide

Notes on Customer Attributes

• • All functions can include customer attributes as optional parameters and will include up to 10 customer attributes.
  • If supplied, CustomerAttributes must contain one or more valid attribute names (see GetCustomerAttributeList) separated by semicolons (;). The values are returned in the same order as the attribute names are specified in the request.
  • The customer attribute values returned are the current (latest available) values, not the values on the specified date.

Notes

• Refer to this GitHub repository for diagrammic use cases of how the Login function should be used.
• Our token policy is following JWT access token standard. Please make sure you comply with the token policy as exampled it the “Sample Response” attached here.
• The response returned by this request will be the session authentication token (a string). If the supplied credentials are invalid, HTTP error code 401 (Unauthorized) is returned.
• The returned token must be included within the HTTP request header "Authorization-Token" of subsequent function calls (see Session Authentication Token).
• The received authentication token remains valid for 20 minutes from the last time any API function was called using it. The Login function should only be called if 20 minutes has elapsed since the last call to the API; otherwise, the authentication token received previously remains valid. As a best practice, the Login function should only be called in the event that any other function call returns an HTTP error 403, "Authorization-Token expired".
• An HTTP error code of 429 (Too many requests) is returned if the Login function is called too many times unnecessarily.
• Your Username and Password are provided to you by your Optimove representative.

Notes

• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.
• Valid values for EventTypeID are:
  • 1 = A campaign has been processed for execution. Will be sent when the execution of at least one of the channels/templates was successful.
  • 2 = All today's campaigns have been processed for execution (even if some failed).
  • 3 = Today's entire daily process has been completed.
  • 4 = A campaign that had been processed for execution was canceled.
  • 5 = A campaign with conditional promo/bonus system activation has been processed for execution, but is on hold until the ClearanceRequiredBy date/time supplied to the listener at the time of event notification, and then will only be sent to customers for whom the promotion was activated in the promo/bonus system (learn more here).
    Please Note: EventTypeID = 5 cannot be registered for a specific channel, rather it should be registered as a general listener (without specifying a specific channel ID).
  • 11 = A user has met a trigger criteria set-up for a realtime campaign (Note: This event type is only relevant for Optimove clients using Track & Trigger).
  • 13 = A campaign has been executed via a particular channel (but not necessarily via any additional channels included in the same campaign). Will be sent when ALL templates for the specific channel sent successfully. Note: If a ChannelID is specified when registering this type of listener, a notification will be sent each time a campaign has been executed via the specified channel. If no ChannelID is specified, a notification will be sent when execution has completed for each channel for every campaign.
• ChannelID is optional for users with full permissions. Users with limited permissions (i.e. per specific channel) must include ChannelID for all types of events. Available ChannelID values can be seen here.
• The specified ListenerURL must be encoded using percent encoding, also known as URL encoding (learn more).
• Each EventTypeID needs to be registered separately (via a separate call), even if the listener URL is identical for more than one EventTypeID.
• Once a listener has been registered, Optimove will call the listener with an HTTP POST request in JSON format, and expects to receive a response of success (200). The structure of the request depends on the EventTypeID:
  EventTypeID = 1:

  {

  "EventTypeID":1,

  "TimeStamp":"YYYY-MM-DD HH:MM:SS",

  "CampaignID":x

  }

  EventTypeID = 2:

  {

  "EventTypeID":2,

  "TimeStamp":"YYYY-MM-DD HH:MM:SS"

  }

  EventTypeID = 3:

  {

  "EventTypeID":3,

  "TimeStamp":"YYYY-MM-DD HH:MM:SS",

  "UpdateDate":"YYYY-MM-DD"

  }

  EventTypeID = 4:

  {

  "EventTypeID":4,

  "TimeStamp":"YYYY-MM-DD HH:MM:SS",

  "CampaignID":x

  }

  EventTypeID = 5:

  {

  "EventTypeID":5,

  "TimeStamp":"YYYY-MM-DD HH:MM:SS",

  "CampaignID":x,

  "CampaignDuration":y,

  "ClearanceRequiredBy":"YYYY-MM-DD HH:MM:SS"

  }

  Note: ClearanceRequiredBy is calculated by Optimove based on the campaign's selected execution channel(s).

  EventTypeID = 11:

  {

  "customerID":"string",
  "isVisitor":true/false,
  "actionID":X,
  "promoCode":[],
  "channelID":X,
  "campaignID":"string",
  "templateName":"string",
  "campaignSeriesID":"string",
  "templateID":X,
  "timestamp":"string",
  "personalization":
  {
  "personalInfo":{tagName:'val'},
  "eventName":{eventParam:'val'}
  },
  "actionName":"string",
  "triggerName":"string",
  "targetGroupName":"string"

  }

  Note:

  • Personalization values will only be included if defined in the campaign: personalInfo may be one more personalization fields defined in the Optimove database (personalInfo is available for any channel using personalization tags); eventName may be one or more defined events that are part of the campaign's trigger.
  • In order to receive this event for customers that are allocated to the campaign’s control group, ChannelID 100 must be included in the registration request.
  • ExternalData will be supplied only for Optimove’s integration partners for whom it was considers as part of the integration scope

  EventTypeID = 13:

  {

  "EventTypeID":13,

  "TimeStamp":"YYYY-MM-DD HH:MM:SS",

  "CampaignID":x,

  "ChannelID":x

  }

   

  Note: TimeStamp values sent to the listener are in UTC.

Notes

• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.
• ChannelID is optional. Available values can be seen here.

Notes

• The customer IDs returned are those whose micro-segment changed during the last day for which data is available.

Note

Duration and lead time values are number of days.

Notes

• Duration and lead time values are number of days.
• This function will return details of campaigns scheduled for execution on the specified date, as well as campaigns with a specified lead time that points to the specified date (e.g., a campaign scheduled for execution on 5 June with a lead time of three days will be returned by this function when called by specifying the date of 2 June).
• Possible results for CampaignType are:
  • Test/Control
  • A/B
  • A/B/N
  • Self-Optimizing
  • No Control
• Possible results for Status are:
  • Processed (means the campaign was processed for execution, but hasn’t finished yet)
  • Successful
  • Partially Run
• Failed campaigns will not be returned by this function.

Notes

• Duration and lead time values are number of days.
• Possible results for CampaignType are:
  • Test/Control
  • A/B
  • A/B/N
  • Self-Optimizing
  • No Control
• Possible results for Status are:
  • Successful
  • Not Run
  • Partially Run
• Failed campaigns will not be returned by this function.

Notes

• This function is generally used after the Event Listener receives notification that a campaign has been scheduled in order to verify with the delivery system (e.g., Silverpop) that the campaign was sent and then to set promotions for individual customers according to the time the campaign was sent.
• Available ChannelID values can be seen here.
• All times are returned in UTC.

Note

Duration and lead time values are number of days.

Notes

• Limitation: up to 40 attributes can be added via API
• Attributes created via the AddCustomerAttribute function can only be updated using the UpdateCustomerAttributes function.
• If a Callback URL was defined you will receive the following response to the Webhook up to 1 minute after the call:
  • Attribute Name
  • IsSuccess: true or false
  • Error ID and error message in case of failure. Possible values for Error in case of failure in the response:
  • 1 = Attribute was not added, number of attributes added exceeds the 40 attributes limit
  • 2 = Attribute was not added, specified RealFieldName already exists
  • 3 = Attribute was not added, field_Type Input should be 'DECIMAL(19,4), 'INT', 'BIGINT', 'DATE' ,'VARCHAR(X)' or 'NVARCHAR(X)'
  • 4 = Attribute was not added, 'CHAR' value (DefaultValue) cannot be inserted into a column with data type 'INT'
  • 5 = Attribute was not added, general error occurred

Examples for reference:

{"attributeName":"LoDoTestNVarcharr11","isSuccess":false,"errorId":"3","errorMsg":"Attribute was not added, Type Input should be 'DECIMAL(19,4), 'INT', 'BIGINT', 'DATE' ,'VARCHAR(X)' or 'NVARCHAR(X)'."}

{"attributeName":"LoDoTestNVarcharr17","isSuccess":true}

{"attributeName":"LoDoTestNVarcharr17","isSuccess":false,"errorId":"2","errorMsg":"Attribute was not added, specified RealFieldName already exists."}

Notes

• By specifying a ChannelID, you can limit the results returned to marketing actions sent via a particular channel. You can see the available ChannelID values here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• The results may optionally include customer IDs of customers included in the control group (i.e., those who did not actually receive the campaign). To include these customers in the response, set IncludeControlGroup=1 (if omitted or set to 0, control group customer IDs will not be returned). If included, these customers are identified in the response by an ActionID of 1.
• This function does not return information about a one-time campaign; thus, an error results if -1 is passed as the target group ID. To retrieve information about one-time campaigns, use GetCustomerOneTimeActionsByDate or GetCustomerOneTimeActionsByCampaign.

Notes

• One-time actions are those marketing actions initiated on an ad hoc customer list via the Run Action command on various Optimove reports (as opposed to a pre-defined target group).
• The results may optionally include customer IDs of customers included in the control group (i.e., those who did not actually receive the campaign) – an ActionID value of 1 indicates a member of control group.
• ChannelID is optional. You can see the available ChannelID values here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.

Notes

• By specifying a ChannelID, you can limit the results returned to marketing actions sent via a particular channel. You can see the available ChannelID values here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• One-time actions are those marketing actions initiated on an ad hoc customer list via the Run Action command on various Optimove reports (as opposed to a pre-defined target group).
• The results may optionally include customer IDs of customers included in the control group (i.e., those who did not actually receive the campaign) – an ActionID value of 1 indicates a member of control group.

Notes

• With this request, we support most attributes, but not customer characteristics. For further information, don't hesitate to get in touch with support or your CSM.
• ChangedCustomerAttribute can contain only a single attribute per each call.
• For customers who only appeared in the database after the previous period, the InitialCustomerAttribute returned will be null (as in the sample response above).
• This function is processing-intensive and may not return results immediately.

Notes

• This function can be called specifying either LifecycleStageID or CustomerAttribute with CustomerAttributeValue.
• When using LifecycleStageID, a single integer lifecycle stage ID or a string containing multiple comma-separated integer values may be supplied (as shown in the above sample requests).
• The list of lifecycle stage IDs available for this function can be obtained with the GetLifecycleStageList function.

Notes

• If supplied, CustomerAttributes must contain one or more valid attribute names (see GetCustomerAttributeList) separated by semicolons (;). The values are returned in the same order as the attribute names are specified in the request.
• The customer attribute values returned are the current (latest available) values, not the values on the campaign date.
• If the optional request parameter IncludeControlGroup is set to True, the results returned will include the customer IDs of customers who were included in the campaign's control group (i.e., those customers included in the campaign's target group, but who did not actually receive the campaign). When included, these customers are identified in the response by an ActionID of 1 ChannelID of 100 and TemplateID of -1.
• All times are returned in UTC.
• Channel ID must be provided while calling this function upon receiving an event type 13 notification.

Notes

• The response structure will be different for different channels.
• All times are returned in UTC.

Notes

• Available ChannelID values can be seen here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• All times are returned in UTC.

Note

The data for a cancelled campaign will be available for two hours from the time that the cancellation notification is sent to an event listener registered to receive notice of cancelled campaigns (refer to EventTypeID 4 in RegisterEventListener).

Notes

• This function returns a maximum of 10 product recommendations, in priority order.
• Valid values for RecommendationType are:
  • 1 = Replenishment Reminder
  • 2 = Product Recommendation
  • Additional custom types can be supported – contact your CSM for details.
• Regarding SuggestedInCampaign:
  • If this parameter is set to False or omitted, all product recommendations calculated by Optimove are returned (any supplied StartDate and EndDate values are ignored).
  • If this parameter is set to True, only products recommended to customers in Optimove campaigns during the specified date range are returned.
  • If this parameter is set to True and date parameters were omitted, products recommended to customers targeted with any Optimove campaign during the past month are returned.
• If CustomerID is specified, then only product recommendations for the individual customer are returned.

Notes

• Valid values for EventID are:
  • 2 = Opened
  • 3 = Clicked
  • 4 = Unsubscribed
  • 5 = Dropped
  • 6 = SpamReport
  • 9 = Bounced
• This function is available only for channels that include customer-level metrics. This includes all Optimail and Optipush campaigns (by default), as well as campaigns that were updated using the UpdateCampaignInteractions function.

Notes

• Valid values for EventID are:
  • 2 = Opened
  • 3 = Clicked
  • 4 = Unsubscribed
  • 5 = Dropped
  • 6 = SpamReport
  • 7 = Bounced
• ChannelID is optional. Available values can be seen here.

Notes

• This function is only relevant for Optimove clients using the Track & Trigger add-on product.
• Date refers to the date of actual customer data and must thus always be earlier than the current date.
• If the optional EventParamIDs is not specified, all event parameters are returned.
• When specified, EventParamIDs must contain one or more valid parameter IDs separated by semicolons (;). Valid values are those returned by calling GetActivityEventList. The values are returned in the same order as the attribute names are specified in the request.
• The event parameter values returned are the latest available values for the specified date (relevant when the same event occurred more than once on the same date).

Notes

• Attributes are identified by their RealFieldName values. You can retrieve all available customer attribute names and a description of each using the GetCustomerAttributeList function, or by accessing the Customer Attributes list in Optimove’s interface and export the list.
• Attribute values supplied in this call overwrite any previous values in the database.
• Each call may include up to 1,000 customer IDs, with a maximum of 10 attributes per customer ID.
• In order to avoid high volumes of these requests, which may result in delays, it is recommended to only use this call for specific customer attributes, based on your use cases.
• If a Callback URL was defined you will receive the following response to the Webhook up to 1 minute after the call:
  • IsSuccess: true or false
  • Request ID
  • Error in case of failure. Error will consist of error details, customer id and real field name. Possible values for Error in the response:
  • 1:“INVALID_CUSTOMER” = Specified CustomerID does not exist
  • 2:“INVALID_FIELD” = Specified RealFieldName does not exist
  • 3:“INVALID_VALUE” = Specified value is invalid
  • 4:“UPDATE_FIELD_TEMPORARY_UNAVIALABLE” = Update for is temporarily unavailable. In case of receiving this error message, please contact Optimove’s support team in order to enable this.
• Please note that using this API call was previously accessed by a different request and responded differently, with a different logic. Starting on June 2023, this API call will support only the documented way.

Examples for reference:

{"isSuccess":false,"errors":[{"error":"UPDATE_FIELD_TEMPORARY_UNAVAILABLE","customerId":"1289049",
"realFieldName":"DaysSinceFirstAbsGameDate"}],"requestId":"77e34963-8142-4fde-a403-ebe03feec41e"}

{"isSuccess":true,"requestId":"0386932e-db94-4567-9d38-76d98ce50e4a"}

Notes

• A maximum of 50,000 customer IDs may be included in one call.
• Response will be an empty array unless there was a failure in erasing the PII of one or more specified customer IDs, in which case the ones that failed will be returned in this array. The most common reason for failure is that the customer ID was not found in Optimove’s database.
• Response will only return failed customer IDs that Optimove has never received previously. Customer IDs that were previously deleted from Optimove and sent again for removal will not be returned.

Notes

• The customer IDs returned are those whose value segment changed during the last day for which data is available.

Notes

• If a PromoCode being added already exists, it will be replaced with the PromotionName specified in the call.
• A maximum of 100 promotions may be added with one call.
• Once added, a promotion can be deleted by calling the DeletePromotions function.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.

Notes

• A maximum of 100 templates may be deleted with one call.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.

Notes

• A maximum of 10,000 customer IDs may be included in one call.
• This function may called as many times as required.
• The campaign will only be sent to customer IDs with Status set to true; if a customer ID is never received by this function, it is the same as if it was sent with Status set to false.
• Once the campaign's specified ClearanceRequiredBy time arrives, Optimove will schedule the campaign for execution only to those customer IDs for which PromosUpdated was specified as true using this API call by that time. For more information about this process, click here.

Notes

• Available ChannelID values can be seen here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• AppID is optional.
• If a TemplateID being added already exists, it will be replaced with the TemplateName specified in the call.
• A maximum of 100 templates may be added with one call.
• Once added, a template can be deleted by calling the DeleteChannelTemplates function.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.

Notes

• A maximum of 100 templates may be deleted with one call.
• Available ChannelID values can be seen here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.

Notes

• If an AppID being added already exists, it will be replaced with the AppName specified in the call.
• A maximum of 100 apps may be added with one call.
• Once added, an app can be deleted by calling the DeleteChannelApps function.
• Available ChannelID values can be seen here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.

Notes

• A maximum of 100 apps may be deleted with one call.
• Available ChannelID values can be seen here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.

Notes

• A maximum of 100 triggers may be added with one call.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.

Notes

• Valid values for MetricID are:
  • 0 = Number sent
  • 1 = Number delivered
  • 2 = Number opened
  • 3 = Number clicked
  • 4 = Number unsubscribed
  • 5 = Number dropped
  • 6 = Number of spam reports
  • 9 = Number bounced
• Reported metrics are stored by campaign execution date.
• When not supplied, RecipientGroupID defaults to 1, which is the test group in case of a test/control campaign or the A group in the case of an A/B campaign.
• Available ChannelID values can be seen here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• This function can be called as often as is desired; the most up-to-date values received for the campaign’s individual metrics will be displayed in the campaign analysis report.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.

Notes

• Valid values for EventID are:
  • 2 = Opened
  • 3 = Clicked
  • 4 = Unsubscribed
  • 5 = Dropped
  • 6 = Spam report
  • 9 = Bounced
• When not supplied, RecipientGroupID defaults to 1, which is the test group in case of a test/control campaign or the A group in the case of an A/B campaign.
• The CustomerIDs array may contain a maximum of 10,000 rows (customers) each time this function is called.
• Available ChannelID values can be seen here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• This function should be called upon each new campaign interaction. Upon multiple calls with the same parameters, Optimove will aggregate the number of interactions based on the provided data. This will allow users to have the campaign analysis channel metrics as clickable numbers. Once clicked, the list of interacted customer will be displayed in Optimove’s customer explorer.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.

Notes

• Valid values for CommunicationMode are:
  • 1 = Allowed
  • 2 = Not allowed / Unsubscribed
• The CustomerIDs array may contain a maximum of 50,000 rows (customers) each time this function is called.
• Available ChannelID values can be seen here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Function Error Response Codes.
• Preference data will not be visible in your Optimove instance by default.
  In order to add it, please contact your CSM.

Note

If ParentFolderID is included in the request, the response will include only Optimail template folders located in the specified parent folder, and not templates located in any subfolders of the specified folder.

Notes

Any optional fields not specified when calling this function will remain unchanged in the template.

Notes

• BrandID – The ID of your Optimail account (if you don't have this ID, contact your CSM).
• Error – A description of the error. When the send succeeds, null is returned.
• Each call may include a maximum of 200 email.
• This function supports a maximum of 10 calls in parallel.
• This API call supports a maximum of 600 requests/min

Notes

• BrandID – The ID of your Optimail account (if you don't have this ID, contact your CSM).
• Error – A description of the error. When the send succeeds, null is returned.
• This function supports a maximum of 10 calls in parallel
• This API call supports a maximum of 600 requests/min

Notes

• BrandID – The ID of your Optimail account (if you don't have this ID, contact your CSM)
• This function supports a maximum of 10 calls in parallel
• A maximum page size of 10 thousand (10,000) results is allowed. To request subsequent pages of results, repeat the request with the additional parameter $skip=n where n is the number of resulting records of the entire result set to skip over when returning the current page.
• StartDate and EndDate refers to the date range when an unsubscribe email was created (inclusive)
• If StartDate and EndDate are not provided the response will include the entire list
• StartDate and EndDate parameters must be formatted exactly as depicted above
• All times are returned in UTC

Notes

• TemplateID is the transactional template identifier, defined by Optimove (this ID can be found in the Optimove UI, when viewing the template in the Manage Templates page).
• ScheduleTime is optional, and must be specified in UTC. If not provided, the email will be sent immediately.
• The Personalizations array is optional. Multiple personalization tags may be provided for each recipient. Each Personalizations block is limited to 10,000 bytes.
• In the case that personalization tags were not sent as part of the Personalizations array, but are located within the template, the missing tags will populate with an empty value within the email body and the transactional email will be successfully sent. For example, if you have a template which includes “Hi [%TRANS:FIRST_NAME%],” and this tag is not received in the API call then the email will go out simply as “Hi.” In such cases, the response code received will be 206 (partial content) success status. Also, an error message will be received noting the missing tags. To avoid incorrect content from being sent to your customers, within the email body, conditional language can be used to validate whether a given tag has been populated with an empty value or not and dynamically change the content accordingly on a given mail send.
• Type specifies the MIME type of the attachment (e.g., "text/plain", "text/html", "application/pdf")
• UniqueMessageID enforces idempotency. This is limited to 254 characters.
• IsSuccess – true is returned if the send was successful. Otherwise, false.
• SendID – If the send failed, null is returned.
• Error – A description of the error. When the send succeeds, null is returned. If the specified template is invalid, Error contains "Invalid template". If idempotency is enforced a 409 error code shows with the following message "Request for this UniqueMessageID has succeeded before".
• Each call may include a maximum of 200 email recipients.
• This function supports a maximum of 10 calls per second.

Notes

• BrandID – The ID of your transactional account (if you don't have this ID, contact your CSM).
• Type – The MIME type of the attachment (e.g., "text/plain", "text/html", "application/pdf").
• UniqueMessageID enforces idempotency. This is limited to 254 characters.
• IsSuccess – true is returned if the send was successful. Otherwise, false.
• SendID – If the send failed, null is returned.
• Error – A description of the error. When the send succeeds, null is returned. If the specified template is invalid, Error contains "Invalid template". If idempotency is enforced a 409 error code shows with the following message "Request for this UniqueMessageID has succeeded before".
• Each call may include a maximum of 200 email recipients.
• This function supports a maximum of 10 calls in parallel.

Notes

• The optional LastNumberOfDays parameter specifies for how many days back in time results are provided. Acceptable values are 1-60. If omitted, the default value of 7 is used.
• TemplateID is the transactional template identifier, defined by Optimove (this ID can be found in the Optimove UI, when viewing the template in the Manage Templates page).
• Sent, delivered, opened and clicked are the unique number of times the specific template was sent, delivered, opened and clicked, respectively, by each individual recipient.

Notes

• The optional LastNumberOfDays parameter specifies for how many days back in time results are provided. Acceptable values are 1-60. If omitted, the default value of 7 is used.
• TemplateID is the transactional template identifier, defined by Optimove (this ID can be found in the Optimove UI, when viewing the template in the Manage Templates page).

Notes

• This function returns the details of all defined Optimail email templates.
• TemplateAttributes returns a StringArray containing the following three strings, in the following order:
  • From name
  • Reply-to
  • Subject