| Required role: | Admin |
| POST | /Outbound/Enqueue |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Channel | body | string | No | |
| Lane | body | string | No | |
| Priority | body | int | No | |
| Address | body | string | No | |
| Platform | body | string | No | |
| RecipientKey | body | string | No | |
| TemplateKey | body | string | No | |
| Language | body | string | No | |
| PayloadJson | body | string | No | |
| DedupKey | body | string | No | |
| CampaignId | body | int? | No | |
| OwnerId | body | int? | No | |
| GuardKey | body | string | No | |
| GuardSubject | body | string | No | |
| NotBefore | body | DateTime? | No | |
| ExpiresAt | body | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | form | string | No | |
| MessageId | form | long? | No | |
| Reason | form | string | No | |
| StatusCode | form | int | No | |
| Message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Outbound/Enqueue HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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-01,
expiresAt: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
status: String,
messageId: 0,
reason: String,
statusCode: 0,
message: String
}