POST api/v1/Email2Dispatches

Will create an email2 dispatch. An id will only be returned if the scope is using segments.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
TriggerId	Trigger id of email2 message	string	Required
Schedule	DateTimeOffset of dispatch to be sent out. If null, set to UtcNow.	date	None.
IsTest	Indicates if dispatch should be created as test.	boolean	None.
BatchDelaySec	Delay between batches in seconds.	DispatchBatchDelaySec	None.
Scope	One (and only one) of the following fields must be defined: Contacts, Emails or Segments.	Email2ScopeDto	None.

Request Formats

application/json, text/json

Sample:

{
  "TriggerId": "sample string 1",
  "Schedule": "2024-11-21T06:21:16.5367133+00:00",
  "IsTest": true,
  "BatchDelaySec": "_1",
  "Scope": {
    "Contacts": {
      "1": {
        "Dynamic": {
          "sample string 1": {},
          "sample string 3": {}
        }
      },
      "2": {
        "Dynamic": {
          "sample string 1": {},
          "sample string 3": {}
        }
      }
    },
    "Emails": {
      "sample string 1": {
        "Dynamic": {
          "sample string 1": {},
          "sample string 3": {}
        }
      },
      "sample string 2": {
        "Dynamic": {
          "sample string 1": {},
          "sample string 3": {}
        }
      }
    },
    "Segments": {
      "InSegmentIds": [
        1,
        2
      ],
      "NotInSegmentIds": [
        1,
        2
      ],
      "TakeRandom": 1,
      "Dynamic": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"4408d5a0-d64f-456e-8bcc-2e240096046f"