| Required role: | Admin |
| POST | /Outbound/Campaigns |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OwnerId | body | int | No | |
| Name | body | string | No | |
| Lane | body | string | No | |
| TemplateKey | body | string | No | |
| PayloadJson | body | string | No | |
| ChannelOrder | body | string | No | |
| HoldoutPercent | body | int? | No | |
| GuardKey | body | string | No | |
| GuardSubject | body | string | No | |
| SendAt | body | DateTime? | No | |
| ExpiresAt | body | DateTime? | No | |
| AudienceSource | body | string | No | |
| People | body | List<OutboundCampaignPerson> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Phone | form | string | No | |
| form | string | No | ||
| Devices | form | List<OutboundCampaignDevice> | No | |
| PushConsent | form | bool? | No | |
| SmsConsent | form | bool? | No | |
| EmailConsent | form | bool? | No | |
| PayloadJson | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | form | string | No | |
| Platform | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CampaignId | form | int | No | |
| Decisions | form | Dictionary<string, int> | No | |
| QueuedByChannel | form | Dictionary<string, int> | No | |
| MessageStatuses | form | Dictionary<string, int> | No | |
| Duplicates | form | int | No | |
| NoIdentity | form | int | No | |
| StatusCode | form | int | No | |
| Message | 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/Campaigns HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ownerId":0,"name":"String","lane":"String","templateKey":"String","payloadJson":"String","channelOrder":"String","holdoutPercent":0,"guardKey":"String","guardSubject":"String","sendAt":"0001-01-01T00:00:00.0000000","expiresAt":"0001-01-01T00:00:00.0000000","audienceSource":"String","people":[{"phone":"String","email":"String","devices":[{"token":"String","platform":"String"}],"pushConsent":false,"smsConsent":false,"emailConsent":false,"payloadJson":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"campaignId":0,"decisions":{"String":0},"queuedByChannel":{"String":0},"messageStatuses":{"String":0},"duplicates":0,"noIdentity":0,"statusCode":0,"message":"String"}