| Required role: | Admin |
| POST | /Outbound/EnqueueBatch |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Messages | body | List<OutboundEnqueueRequest> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Channel | form | string | No | |
| Lane | form | string | No | |
| Priority | form | int | No | |
| Address | form | string | No | |
| Platform | form | string | No | |
| RecipientKey | form | string | No | |
| TemplateKey | form | string | No | |
| Language | form | string | No | |
| PayloadJson | form | string | No | |
| DedupKey | form | string | No | |
| CampaignId | form | int? | No | |
| OwnerId | form | int? | No | |
| GuardKey | form | string | No | |
| GuardSubject | form | string | No | |
| NotBefore | form | DateTime? | No | |
| ExpiresAt | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enqueued | form | int | No | |
| Duplicate | form | int | No | |
| Rejected | form | int | No | |
| Rejections | form | List<OutboundEnqueueBatchRejection> | No | |
| StatusCode | form | int | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Index | form | int | No | |
| DedupKey | form | string | No | |
| Reason | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Outbound/EnqueueBatch HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: application/json
Content-Type: application/json
Content-Length: length
{"messages":[{"channel":"String","lane":"String","priority":0,"address":"String","platform":"String","recipientKey":"String","templateKey":"String","language":"String","payloadJson":"String","dedupKey":"String","campaignId":0,"ownerId":0,"guardKey":"String","guardSubject":"String","notBefore":"0001-01-01T00:00:00.0000000","expiresAt":"0001-01-01T00:00:00.0000000"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"enqueued":0,"duplicate":0,"rejected":0,"rejections":[{"index":0,"dedupKey":"String","reason":"String"}],"statusCode":0,"message":"String"}