PostMessageToList
Initiates a message send to one or more contact lists in Salesforce Marketing Cloud. This procedure supports mass communication by triggering predefined message content for targeted lists managed within the account.
EXECUTE PostMessageToList MessageId = 'NCNSDNsd222as85dj92j2sM', TargetListIds = ' [" +
" \"bzZ0cENGam1FZUtNX0poTDRYZzhlQTo2Mzow\"" +
" ]', OverrideTemplateTargetLists = true, OverrideTemplateExclusionLists = false, IgnoreExclusionLists = true, OverrideMessageText = false, " +
"ContentURL = 'http://image.exct.net/lib/fe6d15707662057c7411/m/1/dj_CC_AUS.jpg'," +
"UtcOffset = '-0500', WindowStart = '1500', WindowEnd = '2200', AllowDuplication = false
Input
| Name | Type | Required | Description |
| MessageId | String | True | Specifies the encoded identifier (Id) of the outbound message definition. This Id appears when creating an 'API Entry Event' message in the user interface. If the configuration screen is no longer available, the Id can be retrieved by inspecting the associated API resource when the message is opened in the UI. |
| TargetListIds | String | False | Specifies one or more list Id values that identify the lists whose contacts will be included in the send. When these values are provided, they override the message's default inclusion lists. |
| OverrideTemplateTargetLists | Boolean | False | Specifies whether the values in the TargetListIds input should override the message's default target list configuration. A value of 'true' applies the override, and a value of 'false' retains the template defaults. |
| ExclusionListIds | String | False | Specifies one or more list Id values that identify the lists whose contacts must be excluded from the send. When these values are provided, they override the message's default exclusion lists. |
| OverrideTemplateExclusionLists | Boolean | False | Specifies whether the values in ExclusionListIds input should override the message's default exclusion list configuration. A value of 'true' applies the override, and a value of 'false' retains the template defaults. |
| IgnoreExclusionLists | Boolean | False | Specifies whether all exclusion lists, including default exclusion lists defined for the message, should be ignored. A value of 'true' disables exclusion filtering for the send. |
| OverrideMessageText | Boolean | False | Specifies whether the message text that is provided by the caller should override the message text that is stored with the outbound message definition. A value of 'true' applies the override. |
| MessageText | String | False | Specifies the outbound message text. This value is required when OverrideMessageText field is set to 'true' and replaces the existing message body stored in the definition. |
| UtcOffset | String | False | Specifies the offset from Coordinated Universal Time (UTC) that applies to the start and end times of the blackout window. A valid offset is required in every request to ensure that blackout restrictions are evaluated correctly. |
| WindowStart | String | False | Specifies the start time of the blackout window in the time zone that is determined by the UtcOffset parameter. To determine whether the scheduled SendTime input falls within the blackout period, convert both the start and end times to UTC before evaluating them. |
| WindowEnd | String | False | Specifies the end time of the blackout window in the time zone determined by the UtcOffset parameter. To determine whether the scheduled SendTime input falls within the blackout period, convert both the start and end times to UTC before evaluating them. |
| SendTime | Datetime | False | Specifies the UTC date and time when the message is scheduled for delivery. If the value represents a time in the past, the message is sent immediately. The blackout window is still enforced when a blackout configuration exists. |
| AllowDuplication | Boolean | False | Specifies whether the same mobile number is allowed to receive multiple copies of the message. A value of 'true' permits duplication during the send. |
| ContentURL | String | False | Specifies the URL of the media file that is to be included with a Multimedia Messaging Service (MMS) message. This content is downloaded by carriers when processing the outbound request. |
Result Set Columns
| Name | Type | Description |
| TokenId | String | Specifies the token Id that is returned after the request is submitted. This Id is used to request the processing status in a follow-up API call. |