TicketUserServices

OutboundCampaignCreateRequest

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/Outbound/Campaigns

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundCampaignResult:
    campaign_id: Optional[int] = None
    decisions: Optional[Dict[str, int]] = None
    queued_by_channel: Optional[Dict[str, int]] = None
    message_statuses: Optional[Dict[str, int]] = None
    duplicates: Optional[int] = None
    no_identity: Optional[int] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundCampaignDevice:
    token: Optional[str] = None
    platform: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundCampaignPerson:
    phone: Optional[str] = None
    email: Optional[str] = None
    devices: Optional[List[OutboundCampaignDevice]] = None
    push_consent: Optional[bool] = None
    sms_consent: Optional[bool] = None
    email_consent: Optional[bool] = None
    payload_json: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundCampaignCreateRequest:
    owner_id: Optional[int] = None
    name: Optional[str] = None
    lane: Optional[str] = None
    template_key: Optional[str] = None
    payload_json: Optional[str] = None
    channel_order: Optional[str] = None
    holdout_percent: Optional[int] = None
    guard_key: Optional[str] = None
    guard_subject: Optional[str] = None
    send_at: Optional[datetime.datetime] = None
    expires_at: Optional[datetime.datetime] = None
    audience_source: Optional[str] = None
    people: Optional[List[OutboundCampaignPerson]] = None

Python OutboundCampaignCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
Content-Length: length

{"campaignId":0,"decisions":{"String":0},"queuedByChannel":{"String":0},"messageStatuses":{"String":0},"duplicates":0,"noIdentity":0,"statusCode":0,"message":"String"}