Sign in
OutboundMessage

Get preview count for outbound message filters

post/v1/outbound/messages/preview

Request body

type1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
<p>Enum values:</p><ul><li><i>1 = Chat</i></li><li><i>2 = Post</i></li><li><i>3 = Email</i></li><li><i>4 = Chatbot</i></li><li><i>5 = ProductTour</i></li><li><i>6 = Banner</i></li><li><i>7 = MobilePush</i></li><li><i>8 = MobileCarousel</i></li><li><i>9 = SocialMedia</i></li><li><i>10 = Sms</i></li></ul>
{"stackTrail":"components:schemas:OutboundPreviewRequestBody:properties:settings","oasType":"schema","type":"unknown","nullable":true}
departmentIdinteger

IDT-1368: the brand the message will be sent as; the preview counts only that brand's contacts. Server-side it is intersected with the caller's permitted brands (default-deny).

Response

OK

countinteger
totalMatchingFiltersinteger

Changes

No recorded changes to this endpoint across all 1 revision of this API.