apiv1.websms.com
Open in
urlscan Pro
195.182.6.101
Public Scan
Submitted URL: http://apiv1.websms.com/
Effective URL: https://apiv1.websms.com/swagger-ui/index.html
Submission: On June 20 via manual from CH — Scanned from AT
Effective URL: https://apiv1.websms.com/swagger-ui/index.html
Submission: On June 20 via manual from CH — Scanned from AT
Form analysis 733 forms found in the DOM
<form id="api_selector">
<div class="input"><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"></div>
<div class="input"><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"></div>
<div class="input"><a id="explore" href="#">Explore</a></div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.20900801799319857">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.20900801799319857" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5996743278523298">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5996743278523298" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.05737458729419154">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.05737458729419154" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6842412171901566">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6842412171901566"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3112347238516837">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3112347238516837">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletRequest {</span>
<div><span class="propWrap"><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>type (optin, optout)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(optin|optout|wat_device_subscription)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>locale</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cssUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css url</p>
</span>,</div>
<div><span class="propName ">cssContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css content</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cssTheme</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css theme</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(websms|light)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssTheme</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.17491048342902227">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.17491048342902227" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7610215237360429">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7610215237360429" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.07765704031553722">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.07765704031553722" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.7155925075121616">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7155925075121616"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.879356024088336">Parameter content type:</label>
<select name="parameterContentType" id="pct0.879356024088336">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletRequest {</span>
<div><span class="propWrap"><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>type (optin, optout)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(optin|optout|wat_device_subscription)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>locale</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cssUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css url</p>
</span>,</div>
<div><span class="propName ">cssContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css content</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cssTheme</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css theme</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(websms|light)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssTheme</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7254237173197016">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7254237173197016" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.29624533993177393">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.29624533993177393" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9072739046682294">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9072739046682294" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.7668282420162524">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7668282420162524"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9858939138602345">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9858939138602345">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletRequest {</span>
<div><span class="propWrap"><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>type (optin, optout)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(optin|optout|wat_device_subscription)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>locale</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cssUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css url</p>
</span>,</div>
<div><span class="propName ">cssContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css content</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cssTheme</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css theme</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(websms|light)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssTheme</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8914387317588439">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8914387317588439" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.2391361942439194">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.2391361942439194" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.17199193748059716">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.17199193748059716" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.1962506435875564">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.1962506435875564"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4838155432943718">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4838155432943718">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletRequest {</span>
<div><span class="propWrap"><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>type (optin, optout)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(optin|optout|wat_device_subscription)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>locale</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cssUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css url</p>
</span>,</div>
<div><span class="propName ">cssContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css content</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cssTheme</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css theme</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(websms|light)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssTheme</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.42934154390883217">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.42934154390883217" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.1309132662967436">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.1309132662967436" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.4100583253967205">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.4100583253967205" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.48107465588426823">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.48107465588426823" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.19621343064902064">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.19621343064902064" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcontactGroupId0.7863089092581665">contactGroupId</label></td>
<td>
<input class="parameter" minlength="0" name="contactGroupId" placeholder="" id="mcontactGroupId0.7863089092581665" type="text" value="">
</td>
<td class="markdown">
<p>Filters results by contact group ids</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.5129927401241807">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5129927401241807"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5971373821722343">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5971373821722343">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletRequest {</span>
<div><span class="propWrap"><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>type (optin, optout)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(optin|optout|wat_device_subscription)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>locale</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cssUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css url</p>
</span>,</div>
<div><span class="propName ">cssContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css content</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cssTheme</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css theme</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(websms|light)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssTheme</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.422617972729604">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.422617972729604"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.330312156774744">Parameter content type:</label>
<select name="parameterContentType" id="pct0.330312156774744">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletRequest {</span>
<div><span class="propWrap"><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>type (optin, optout)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(optin|optout|wat_device_subscription)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>locale</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cssUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css url</p>
</span>,</div>
<div><span class="propName ">cssContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css content</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cssTheme</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css theme</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(websms|light)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssTheme</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.41453755697551653">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.41453755697551653"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.20491593420615728">Parameter content type:</label>
<select name="parameterContentType" id="pct0.20491593420615728">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletRequest {</span>
<div><span class="propWrap"><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>type (optin, optout)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(optin|optout|wat_device_subscription)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>locale</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cssUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css url</p>
</span>,</div>
<div><span class="propName ">cssContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css content</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cssTheme</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css theme</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(websms|light)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssTheme</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.929396898987624">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.929396898987624"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8752679338055149">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8752679338055149">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletRequest {</span>
<div><span class="propWrap"><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>type (optin, optout)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(optin|optout|wat_device_subscription)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>locale</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cssUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css url</p>
</span>,</div>
<div><span class="propName ">cssContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css content</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cssTheme</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>css theme</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(websms|light)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cssTheme</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8598500733923189">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8598500733923189" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8921744843535298">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8921744843535298"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8566303267671158">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8566303267671158">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CloneAppletRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.23319431328121154">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.23319431328121154" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.689556991709273">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.689556991709273"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.03572863274907645">Parameter content type:</label>
<select name="parameterContentType" id="pct0.03572863274907645">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CloneAppletRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.23047783280124867">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.23047783280124867" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.30115998799496935">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.30115998799496935"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9043858987931392">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9043858987931392">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CloneAppletRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5769734770129871">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5769734770129871" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6974342167344729">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6974342167344729"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4584541139621803">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4584541139621803">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CloneAppletRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.2977301764923559">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.2977301764923559" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.922056899093904">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.922056899093904" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.7451881102905094">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7451881102905094"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.736784413977706">Parameter content type:</label>
<select name="parameterContentType" id="pct0.736784413977706">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletOptInConfigurationRequestDto {</span>
<div><span class="propName ">components</span> (<span class="propType">AppletOptInConfigurationComponentsRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>components</p>
</span>,</div>
<div><span class="propName ">messages</span> (<span class="propType">AppletOptInConfigurationMessagesRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messages</p>
</span>,</div>
<div><span class="propName ">kioskMode</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>kiosk mode</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationComponentsRequestDto {</span>
<div><span class="propName ">title</span> (<span class="propType">AppletOptInConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">intro</span> (<span class="propType">AppletOptInConfigurationComponentTextareaRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>intro</p>
</span>,</div>
<div><span class="propName required">contactGroups</span> (<span class="propType">AppletOptInConfigurationComponentContactGroupsRequestDto</span>): <span class="propDesc markdown">
<p>contact groups</p>
</span>,</div>
<div><span class="propName ">firstName</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>first name</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>last name</p>
</span>,</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email address</p>
</span>,</div>
<div><span class="propName ">contactTitle</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">nickname</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>nickname</p>
</span>,</div>
<div><span class="propName ">landline</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>landline phone number</p>
</span>,</div>
<div><span class="propName ">fax</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fax</p>
</span>,</div>
<div><span class="propName ">birthday</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>birthday</p>
</span>,</div>
<div><span class="propName ">homepage</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>homepage</p>
</span>,</div>
<div><span class="propName ">instantMessenger</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>instant messenger user</p>
</span>,</div>
<div><span class="propName ">skype</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skype</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>street</p>
</span>,</div>
<div><span class="propName ">zipCode</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>zip code</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>city</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>country</p>
</span>,</div>
<div><span class="propName ">company</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">department</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>department</p>
</span>,</div>
<div><span class="propName ">bureau</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bureau</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">jobTitle</span> (<span class="propType">AppletOptInConfigurationComponentContactFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>job title</p>
</span>,</div>
<div><span class="propName required">msisdn</span> (<span class="propType">AppletOptInConfigurationComponentMsisdnRequestDto</span>): <span class="propDesc markdown">
<p>msisdn</p>
</span>,</div>
<div><span class="propName ">logo</span> (<span class="propType">AppletOptInConfigurationComponentAttachmentRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>logo</p>
</span>,</div>
<div><span class="propName ">appletTitle</span> (<span class="propType">AppletOptInConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>applet title</p>
</span>,</div>
<div><span class="propName ">companyName</span> (<span class="propType">AppletOptInConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">labelChannelSelection</span> (<span class="propType">AppletOptInConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>label channel selection</p>
</span>,</div>
<div><span class="propName ">labelContactGroupSelection</span> (<span class="propType">AppletOptInConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>label contact group selection</p>
</span>,</div>
<div><span class="propName ">labelWhatsappMsisdn</span> (<span class="propType">AppletOptInConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>label whatsapp msisdn</p>
</span>,</div>
<div><span class="propName ">titleMsisdnVerificationSuccessful</span> (<span class="propType">AppletOptInConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title msisdn verification successful</p>
</span>,</div>
<div><span class="propName ">descriptionMsisdnVerificationSuccessful</span> (<span class="propType">AppletOptInConfigurationComponentTextareaRequestDto</span>, <span class="propOptKey">optional</span>): <span
class="propDesc markdown">
<p>description msisdn verification successful</p>
</span>,</div>
<div><span class="propName ">termsAndConditions</span> (<span class="propType">AppletOptInConfigurationComponentTermsAndConditionsRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>terms and conditions</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationMessagesRequestDto {</span>
<div><span class="propName required">pinSms</span> (<span class="propType">AppletOptInConfigurationMessageRequestDto</span>): <span class="propDesc markdown">
<p>pin sms</p>
</span>,</div>
<div><span class="propName ">welcomeSms</span> (<span class="propType">AppletOptInConfigurationActivatableMessageRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome sms</p>
</span>,</div>
<div><span class="propName ">welcomeWhatsapp</span> (<span class="propType">AppletOptInConfigurationActivatableMessageRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome whatsapp</p>
</span>,</div>
<div><span class="propName ">isBlacklisted</span> (<span class="propType">AppletOptInConfigurationActivatableMessageRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is blacklisted</p>
</span>,</div>
<div><span class="propName ">whatsappMsisdn</span> (<span class="propType">AppletOptInConfigurationActivatableMessageRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whatsapp msisdn sms</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationComponentFieldRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationComponentTextareaRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationComponentContactGroupsRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group ids</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationComponentContactFieldRequestDto {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span>,</div>
<div><span class="propName ">required</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>required</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationComponentMsisdnRequestDto {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">optinChannels</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>opt in channels</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationComponentAttachmentRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">attachmentId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attachment id</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>9223372036854776000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">attachmentMimeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attachment mime type</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationComponentTermsAndConditionsRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span>,</div>
<div><span class="propName ">required</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>required</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationMessageRequestDto {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptInConfigurationActivatableMessageRequestDto {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span>,</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>active</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">components</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">intro</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">contactGroups</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">firstName</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">lastName</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">contactTitle</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">nickname</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">landline</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">fax</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">birthday</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">homepage</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">instantMessenger</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">skype</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">street</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">zipCode</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">city</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">country</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">company</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">department</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">bureau</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">jobTitle</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">msisdn</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">optinChannels</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">logo</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentMimeType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">appletTitle</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">companyName</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">labelChannelSelection</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">labelContactGroupSelection</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">labelWhatsappMsisdn</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">titleMsisdnVerificationSuccessful</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">descriptionMsisdnVerificationSuccessful</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">termsAndConditions</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span>
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">messages</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">pinSms</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">welcomeSms</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">welcomeWhatsapp</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">isBlacklisted</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">whatsappMsisdn</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span>
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">kioskMode</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5982357449401008">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5982357449401008" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.23603309238228398">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.23603309238228398" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.9715061768550943">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9715061768550943"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6731238274500029">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6731238274500029">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletOptOutConfigurationRequestDto {</span>
<div><span class="propName ">components</span> (<span class="propType">AppletOptOutConfigurationComponentsRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>components</p>
</span>,</div>
<div><span class="propName ">messages</span> (<span class="propType">AppletOptOutConfigurationMessagesRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messages</p>
</span>,</div>
<div><span class="propName ">kioskMode</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>kiosk mode</p>
</span>,</div>
<div><span class="propName ">blacklisting</span> (<span class="propType">AppletOptOutConfigurationBlacklistRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>blacklisting</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptOutConfigurationComponentsRequestDto {</span>
<div><span class="propName ">title</span> (<span class="propType">AppletOptOutConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">intro</span> (<span class="propType">AppletOptOutConfigurationComponentTextareaRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>intro</p>
</span>,</div>
<div><span class="propName required">msisdn</span> (<span class="propType">AppletOptOutConfigurationComponentMsisdnRequestDto</span>): <span class="propDesc markdown">
<p>msisdn</p>
</span>,</div>
<div><span class="propName required">contactGroups</span> (<span class="propType">AppletOptOutConfigurationComponentContactGroupsRequestDto</span>): <span class="propDesc markdown">
<p>contact groups</p>
</span>,</div>
<div><span class="propName ">logo</span> (<span class="propType">AppletOptOutConfigurationComponentAttachmentRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>logo</p>
</span>,</div>
<div><span class="propName ">appletTitle</span> (<span class="propType">AppletOptOutConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>applet title</p>
</span>,</div>
<div><span class="propName ">labelContactGroupSelection</span> (<span class="propType">AppletOptOutConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>label contact group selection</p>
</span>,</div>
<div><span class="propName ">titleOptOutSuccessful</span> (<span class="propType">AppletOptOutConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title opt out successful</p>
</span>,</div>
<div><span class="propName ">descriptionOptOutSuccessful</span> (<span class="propType">AppletOptOutConfigurationComponentTextareaRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>description opt out successful</p>
</span>,</div>
<div><span class="propName ">companyName</span> (<span class="propType">AppletOptOutConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptOutConfigurationMessagesRequestDto {</span>
<div><span class="propName required">pinSms</span> (<span class="propType">AppletOptOutConfigurationMessageRequestDto</span>): <span class="propDesc markdown">
<p>pin sms</p>
</span>,</div>
<div><span class="propName ">goodbyeSms</span> (<span class="propType">AppletOptOutConfigurationActivatableMessageRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye sms</p>
</span>,</div>
<div><span class="propName ">goodbyeWhatsapp</span> (<span class="propType">AppletOptOutConfigurationActivatableMessageRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye whatsapp</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptOutConfigurationBlacklistRequestDto {</span>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">contentCategories</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">AppletOptOutConfigurationComponentFieldRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptOutConfigurationComponentTextareaRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptOutConfigurationComponentMsisdnRequestDto {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptOutConfigurationComponentContactGroupsRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group ids</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptOutConfigurationComponentAttachmentRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">attachmentId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attachment id</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>9223372036854776000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">attachmentMimeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attachment mime type</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptOutConfigurationMessageRequestDto {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletOptOutConfigurationActivatableMessageRequestDto {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span>,</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>active</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">components</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">intro</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">msisdn</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">contactGroups</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">logo</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentMimeType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">appletTitle</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">labelContactGroupSelection</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">titleOptOutSuccessful</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">descriptionOptOutSuccessful</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">companyName</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">messages</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">pinSms</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">goodbyeSms</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">goodbyeWhatsapp</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span>
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">kioskMode</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">blacklisting</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategories</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]
}</span></span>
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3255915149414086">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3255915149414086" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3501393419715009">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3501393419715009" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8196530402111286">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8196530402111286"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4211476140510646">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4211476140510646">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AppletWatDeviceSubscriptionConfigurationRequestDto {</span>
<div><span class="propName ">components</span> (<span class="propType">AppletWatDeviceSubscriptionConfigurationComponentsRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>components</p>
</span>,</div>
<div><span class="propName ">messages</span> (<span class="propType">AppletWatDeviceSubscriptionConfigurationMessagesRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messages</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>mode</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(redirect|manual)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">AppletWatDeviceSubscriptionConfigurationComponentsRequestDto {</span>
<div><span class="propName ">title</span> (<span class="propType">AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">intro</span> (<span class="propType">AppletWatDeviceSubscriptionConfigurationComponentTextareaRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>intro</p>
</span>,</div>
<div><span class="propName ">logo</span> (<span class="propType">AppletWatDeviceSubscriptionConfigurationComponentAttachmentRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>logo</p>
</span>,</div>
<div><span class="propName ">termsAndConditions</span> (<span class="propType">AppletWatDeviceSubscriptionConfigurationComponentTermsAndConditionsRequestDto</span>, <span class="propOptKey">optional</span>): <span
class="propDesc markdown">
<p>terms and conditions</p>
</span>,</div>
<div><span class="propName ">companyName</span> (<span class="propType">AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">appletTitle</span> (<span class="propType">AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>applet title</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletWatDeviceSubscriptionConfigurationMessagesRequestDto {</span>
<div><span class="propName required">prefilledWhatsappMessage</span> (<span class="propType">AppletWatDeviceSubscriptionConfigurationMessageRequestDto</span>): <span class="propDesc markdown">
<p>prefilled whatsapp message</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletWatDeviceSubscriptionConfigurationComponentTextareaRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletWatDeviceSubscriptionConfigurationComponentAttachmentRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">attachmentId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attachment id</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>9223372036854776000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">attachmentMimeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attachment mime type</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletWatDeviceSubscriptionConfigurationComponentTermsAndConditionsRequestDto {</span>
<div><span class="propName ">visible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>visible</p>
</span>,</div>
<div><span class="propName ">position</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>position</p>
</span>,</div>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span>,</div>
<div><span class="propName ">required</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>required</p>
</span></div><span class="strong">}</span><br><span class="strong">AppletWatDeviceSubscriptionConfigurationMessageRequestDto {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">components</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">intro</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">logo</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentMimeType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">termsAndConditions</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">required</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">companyName</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">appletTitle</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">visible</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">position</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">messages</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">prefilledWhatsappMessage</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">mode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.04321446072277757">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.04321446072277757" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.4999475561931719">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.4999475561931719" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.0022970181098207476">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.0022970181098207476" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8521893539658749">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8521893539658749" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.9346523530876125">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.9346523530876125" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.05724338483658009">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.05724338483658009" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.7813734040010007">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.7813734040010007" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.9390485032319076">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.9390485032319076" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.10692881135142396">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.10692881135142396" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.34213977264418527">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.34213977264418527" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9085178612108371">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9085178612108371"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.43684397082352455">Parameter content type:</label>
<select name="parameterContentType" id="pct0.43684397082352455">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.15752454803877325">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.15752454803877325">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.7860465938271664">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.7860465938271664" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.2894452926097433">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.2894452926097433" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.662033861345307">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.662033861345307" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.965009875094714">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.965009875094714" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.7099228976985485">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.7099228976985485" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.17882083368251034">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.17882083368251034" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.20165585698252597">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.20165585698252597" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.47752498178282843">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.47752498178282843" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.9025986861159809">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.9025986861159809" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.13817795563362667">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.13817795563362667" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.16423692570490522">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.16423692570490522" type="text" value="-sentOn">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.7539333001010373">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.7539333001010373" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9672252032542732">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9672252032542732" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6509893031142657">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6509893031142657" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6425909244666714">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6425909244666714" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.4589334219369128">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4589334219369128"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3012468174467591">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3012468174467591">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6464795954932467">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6464795954932467" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.5389153229992003">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.5389153229992003" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8991465183197118">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8991465183197118" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mformat0.5699640881362638">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.5699640881362638" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.9224257056058449">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.9224257056058449" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.48533003507626815">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.48533003507626815" type="text" value="-sentOn">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.3914574443711105">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.3914574443711105" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.7688664692831306">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.7688664692831306" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.050296849576419334">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.050296849576419334" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.2920579810123136">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.2920579810123136" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.07393899882823018">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.07393899882823018" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9541171086278555">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9541171086278555" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.3108021022681826">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3108021022681826"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9501959119876975">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9501959119876975">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.8800989825372545">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.8800989825372545">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9985345851742926">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9985345851742926" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.0986605743321578">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.0986605743321578" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9931270444642051">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9931270444642051" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.3553251067948988">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.3553251067948988" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5479900258960879">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5479900258960879" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.5364125617876649">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.5364125617876649" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.21614445869380416">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.21614445869380416" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.4151965472597354">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.4151965472597354" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.3350100756879495">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.3350100756879495" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6667367037186165">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6667367037186165"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.17332655250207796">Parameter content type:</label>
<select name="parameterContentType" id="pct0.17332655250207796">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.07042391084438937">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.07042391084438937">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.5015186965818683">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.5015186965818683" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.9094937286693596">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.9094937286693596" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mfile0.7058565131086276">file</label></td>
<td>
<input type="file" name="file" id="mfile0.7058565131086276">
<div class="parameter-content-type"></div>
</td>
<td class="markdown"></td>
<td>formData</td>
<td>
<span class="model-signature">undefined</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9280514809561948">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9280514809561948" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.018259195994871247">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.018259195994871247" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6496422233353054">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6496422233353054" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.4278945304580828">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.4278945304580828" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9969449739073557">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9969449739073557" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.08372216264680232">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.08372216264680232" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.8164347190095502">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8164347190095502" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6273367777801653">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6273367777801653" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7512784783867084">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7512784783867084"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5137426749486893">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5137426749486893">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ImportRecipientBlacklistRequestDto {</span>
<div><span class="propName ">importFileId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>import file id</p>
</span>,</div>
<div><span class="propName ">fieldMapping</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fields to import file column mapping</p>
</span>,</div>
<div><span class="propName ">contentCategories</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">charset</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>override detected charset</p>
</span>,</div>
<div><span class="propName ">delimiter</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>override detected delimiter</p>
</span>,</div>
<div><span class="propName ">skipFirstRow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skip first row</p>
</span>,</div>
<div><span class="propName ">continueOnError</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>continue on error</p>
</span>,</div>
<div><span class="propName ">ignoreExistingRecipientBlacklists</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>don't touch existing recipientBlacklists</p>
</span>,</div>
<div><span class="propName ">dryRun</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>dry run</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">importFileId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">fieldMapping</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">contentCategories</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">charset</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">delimiter</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">skipFirstRow</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">continueOnError</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">ignoreExistingRecipientBlacklists</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">dryRun</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.8765128421153894">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.8765128421153894">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.15147838756131748">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.15147838756131748" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.863597283418742">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.863597283418742" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9116877147224269">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9116877147224269" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.09430067046822899">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.09430067046822899" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9897676729160514">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9897676729160514" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="msearch0.6016347964547093">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.6016347964547093" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.7394799546872479">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.7394799546872479" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6960832699445656">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6960832699445656" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.4936455573509606">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4936455573509606"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7972346588234496">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7972346588234496">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AddRecipientBlacklistsRequestDto {</span>
<div><span class="propName ">recipients</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>recipient list</p>
</span>,</div>
<div><span class="propName ">contentCategories</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>recipient list</p>
</span>,</div>
<div><span class="propName ">comment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>comment</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">recipients</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contentCategories</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">comment</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5162528648441436">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5162528648441436" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6912132132068631">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6912132132068631" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.11329608489011478">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.11329608489011478"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.46961077740059">Parameter content type:</label>
<select name="parameterContentType" id="pct0.46961077740059">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RecipientBlacklistRequest {</span>
<div><span class="propWrap"><span class="propName ">recipient</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>recipient</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+?[1-9][0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content category (personal, advertisement or informational</p>
</span>,</div>
<div><span class="propName ">comment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>comment</p>
</span>,</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>active</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">recipient</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">comment</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">304</td>
<td class="markdown">
<p>Not modified</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mformat0.8692384704259486">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.8692384704259486" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.3514270217065436">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.3514270217065436" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.1665465330170126">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.1665465330170126" type="text" value="-sentOn">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.33508201967345297">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.33508201967345297" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.06850982283940721">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.06850982283940721" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.39488096880347423">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.39488096880347423" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.06648248184837735">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.06648248184837735" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.7851466925358661">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.7851466925358661" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.6326389044731335">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.6326389044731335" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6220418569079298">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6220418569079298" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9859187284240583">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9859187284240583"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.09441012292164763">Parameter content type:</label>
<select name="parameterContentType" id="pct0.09441012292164763">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RecipientBlacklistRequest {</span>
<div><span class="propWrap"><span class="propName ">recipient</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>recipient</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+?[1-9][0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content category (personal, advertisement or informational</p>
</span>,</div>
<div><span class="propName ">comment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>comment</p>
</span>,</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>active</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">recipient</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">comment</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.5682706819210916">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5682706819210916"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4883242930995715">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4883242930995715">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">InboxConfigurationRequest {</span>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>inbox enabled?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7521556769060773">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7521556769060773"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2447619706319175">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2447619706319175">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ArchiveConfigurationRequest {</span>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>archive enabled?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.45822096561939496">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.45822096561939496"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5129096161985884">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5129096161985884">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">LocaleConfigurationRequest {</span>
<div><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Default account locale</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.24939791131748135">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.24939791131748135"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.21737369371652315">Parameter content type:</label>
<select name="parameterContentType" id="pct0.21737369371652315">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UrlshorteningDefaultDomainConfigurationRequest {</span>
<div><span class="propName ">domainPart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>urlshortening default domain part</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">urlScheme</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>urlshortening default url scheme</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(http|https)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">domainPart</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">urlScheme</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.08617738034069289">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.08617738034069289"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4574998819487144">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4574998819487144">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UrlshorteningTypeConfigurationRequest {</span>
<div><span class="propName ">urlshorteningType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>urlshortening type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">urlshorteningType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.42763775450595976">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.42763775450595976"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8564011194426171">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8564011194426171">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UrlshorteningTypeConfigurationRequest {</span>
<div><span class="propName ">urlshorteningType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>urlshortening type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">urlshorteningType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.5394405774492104">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5394405774492104"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.40779108660345775">Parameter content type:</label>
<select name="parameterContentType" id="pct0.40779108660345775">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ForwardingConfigurationRequest {</span>
<div><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs)</p>
</span>,</div>
<div><span class="propName ">target</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target URL/address</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">target</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.23567100321510348">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.23567100321510348"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4893758433186022">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4893758433186022">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DlrSmsForwardingConfigurationRequest {</span>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled?</p>
</span>,</div>
<div><span class="propName ">bpwebappType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bpwebapp type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)</p>
</span>,</div>
<div><span class="propName ">bpwebappTarget</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bpwebapp target URL/address</p>
</span>,</div>
<div><span class="propName ">otherType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>other type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)</p>
</span>,</div>
<div><span class="propName ">legacyXmlType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>legacyXml type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)</p>
</span>,</div>
<div><span class="propName ">legacyXmlTarget</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>legacyXml target URL/address</p>
</span>,</div>
<div><span class="propName ">atmsType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>atms type</p>
</span>,</div>
<div><span class="propName ">atmsTarget</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>atms target URL/address</p>
</span>,</div>
<div><span class="propName ">simplesmsType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>simple sms type</p>
</span>,</div>
<div><span class="propName ">simplesmsTarget</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>simple sms target URL/address</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">bpwebappType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bpwebappTarget</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">otherType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">legacyXmlType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">legacyXmlTarget</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">atmsType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">atmsTarget</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">simplesmsType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">simplesmsTarget</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7749274462919045">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7749274462919045"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9184133588335228">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9184133588335228">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DlrWhatsappForwardingConfigurationRequest {</span>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled?</p>
</span>,</div>
<div><span class="propName ">bpwebappType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bpwebapp type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)</p>
</span>,</div>
<div><span class="propName ">bpwebappTarget</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bpwebapp target URL/address</p>
</span>,</div>
<div><span class="propName ">otherType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>other type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)</p>
</span>,</div>
<div><span class="propName ">apiRestType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>apiRest type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)</p>
</span>,</div>
<div><span class="propName ">apiRestTarget</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>apiRest target URL/address</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">bpwebappType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bpwebappTarget</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">otherType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">apiRestType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">apiRestTarget</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7096472826694551">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7096472826694551"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.916070419016991">Parameter content type:</label>
<select name="parameterContentType" id="pct0.916070419016991">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContentCategoryConfigurationRequest {</span>
<div><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentCategory (personal, advertisement, informational)</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7662306713975613">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7662306713975613"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6637981615909854">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6637981615909854">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">BlacklistConfigurationRequest {</span>
<div><span class="propName ">blacklistedConfirmationMessageSmsContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>blacklisted confirmation message sms content</p>
</span>,</div>
<div><span class="propName ">blacklistedConfirmationMessageSmsActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is lacklisted confirmation message sms active?</p>
</span>,</div>
<div><span class="propName ">blacklistedConfirmationMessageWhatsappContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>blacklisted confirmation message whatsapp content</p>
</span>,</div>
<div><span class="propName ">blacklistedConfirmationMessageWhatsappActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is blacklisted confirmation message whatsapp active?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">blacklistedConfirmationMessageSmsContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">blacklistedConfirmationMessageSmsActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">blacklistedConfirmationMessageWhatsappContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">blacklistedConfirmationMessageWhatsappActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.910273950374717">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.910273950374717" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6573345052813773">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6573345052813773" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.1989305731414306">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.1989305731414306"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.06868759488116893">Parameter content type:</label>
<select name="parameterContentType" id="pct0.06868759488116893">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhitelistEntryRequest {</span>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">value</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5508951540497038">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5508951540497038" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.23351318316357483">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.23351318316357483" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8755149108567555">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8755149108567555" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6358190527960057">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6358190527960057"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.10306455972876671">Parameter content type:</label>
<select name="parameterContentType" id="pct0.10306455972876671">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhitelistEntryRequest {</span>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">value</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">304</td>
<td class="markdown">
<p>Not modified</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.22395903738771916">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.22395903738771916"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4264386770480295">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4264386770480295">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ChangePasswordRequest {</span>
<div><span class="propName required">oldPassword</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>old password</p>
</span>,</div>
<div><span class="propName required">newPassword</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>new password</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">oldPassword</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">newPassword</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.937871772729705">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.937871772729705"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.47674568788491234">Parameter content type:</label>
<select name="parameterContentType" id="pct0.47674568788491234">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MessagingAuthenticationRequest {</span>
<div><span class="propName ">password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>password</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">password</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.7326098198405766">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.7326098198405766" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.882398051467177">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.882398051467177" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5930505060276177">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5930505060276177" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8592854541942976">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8592854541942976" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.8713605094682282">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8713605094682282"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.17716645206229575">Parameter content type:</label>
<select name="parameterContentType" id="pct0.17716645206229575">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmppAuthenticationRequest {</span>
<div><span class="propName ">password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>password</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">password</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.0459035189686412">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.0459035189686412"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8605739604391589">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8605739604391589">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OnboardingConfigurationRequest {</span>
<div><span class="propName ">onboardingStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>onboardingStatus</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">onboardingStatus</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.04586560895903613">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.04586560895903613" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.689919724485476">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.689919724485476" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.3535674383460383">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.3535674383460383" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.8438519613873039">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8438519613873039" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9437865295703856">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9437865295703856" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.8198682182723722">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8198682182723722"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1008576733816986">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1008576733816986">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelRequestDto {</span>
<div><span class="propWrap"><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>255</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(whatsapp)$</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8682959765714915">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8682959765714915" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.0006081476306434297">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.0006081476306434297"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.25649215139506665">Parameter content type:</label>
<select name="parameterContentType" id="pct0.25649215139506665">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">InitiatePhoneNumberProvisioningRequest {</span>
<div><span class="propName ">metaPhoneNumberId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>the external (meta) phoneNumberId</p>
</span>,</div>
<div><span class="propName ">wabaId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>the external (meta) wabaId</p>
</span>,</div>
<div><span class="propName ">metaAccessToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>the external (meta) temp access token provided by metas embedded signup</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">provider</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>the provider the phone number should be registered through (e.g. LINK, WHATSAPP, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^(?i)(link_mobility|internal)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">metaPhoneNumberId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">wabaId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">metaAccessToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">provider</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.44199359609928246">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.44199359609928246" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mtoken0.7439356967030788">token</label></td>
<td>
<input class="parameter" minlength="0" name="token" placeholder="" id="mtoken0.7439356967030788" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mbody0.8924171208857508">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8924171208857508"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5343187232347331">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5343187232347331">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">LinkWhatsappProvisioningResultDto {</span>
<div><span class="propName ">success</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">cpaasClient</span> (<span class="propType">CpaasClient</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">phoneNumberId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">wabaId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">CpaasClient {</span>
<div><span class="propName ">clientId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">secret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">iv</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">success</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">cpaasClient</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">clientId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">iv</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">phoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">phoneNumberId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">wabaId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9661214172300541">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9661214172300541" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6771999691481989">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6771999691481989" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.18078401666662325">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.18078401666662325"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.05519421253313017">Parameter content type:</label>
<select name="parameterContentType" id="pct0.05519421253313017">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelRequestDto {</span>
<div><span class="propWrap"><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>255</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(whatsapp)$</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcustomer_channel_id0.4210373389711184">customer_channel_id</label></td>
<td>
<input class="parameter required" minlength="1" name="customer_channel_id" placeholder="(required)" id="mcustomer_channel_id0.4210373389711184" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcustomer_channel_id0.8678975922120518">customer_channel_id</label></td>
<td>
<input class="parameter required" minlength="1" name="customer_channel_id" placeholder="(required)" id="mcustomer_channel_id0.8678975922120518" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.4871362978927001">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4871362978927001"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.16290909309613455">Parameter content type:</label>
<select name="parameterContentType" id="pct0.16290909309613455">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelAgentRequestDto {</span>
<div><span class="propName required">accountId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>account id</p>
</span>,</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>active</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">accountId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcustomer_channel_id0.29387678766813186">customer_channel_id</label></td>
<td>
<input class="parameter required" minlength="1" name="customer_channel_id" placeholder="(required)" id="mcustomer_channel_id0.29387678766813186" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="magent_id0.13539702325455027">agent_id</label></td>
<td>
<input class="parameter required" minlength="1" name="agent_id" placeholder="(required)" id="magent_id0.13539702325455027" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcustomer_channel_id0.5627383431831794">customer_channel_id</label></td>
<td>
<input class="parameter required" minlength="1" name="customer_channel_id" placeholder="(required)" id="mcustomer_channel_id0.5627383431831794" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="magent_id0.622307851247444">agent_id</label></td>
<td>
<input class="parameter required" minlength="1" name="agent_id" placeholder="(required)" id="magent_id0.622307851247444" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcustomer_channel_id0.054354052845656975">customer_channel_id</label></td>
<td>
<input class="parameter required" minlength="1" name="customer_channel_id" placeholder="(required)" id="mcustomer_channel_id0.054354052845656975" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="magent_id0.7430682375235613">agent_id</label></td>
<td>
<input class="parameter required" minlength="1" name="agent_id" placeholder="(required)" id="magent_id0.7430682375235613" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.3246092393723543">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3246092393723543"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6661055969136465">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6661055969136465">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelAgentRequestDto {</span>
<div><span class="propName required">accountId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>account id</p>
</span>,</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>active</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">accountId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcustomer_channel_id0.06196034373202841">customer_channel_id</label></td>
<td>
<input class="parameter required" minlength="1" name="customer_channel_id" placeholder="(required)" id="mcustomer_channel_id0.06196034373202841" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.09066839545897376">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.09066839545897376"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7655921975712732">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7655921975712732">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OptInRequestDto {</span>
<div><span class="propName ">showAllGroups</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>show all groups?</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group id list</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">showAllGroups</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5780077956136136">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5780077956136136" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.09204952670997768">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.09204952670997768" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6047797341404371">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6047797341404371" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mdeviceType0.08574953774747773">deviceType</label></td>
<td>
<input class="parameter" minlength="0" name="deviceType" placeholder="" id="mdeviceType0.08574953774747773" type="text" value="">
</td>
<td class="markdown">
<p>DeviceType (optional)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mbody0.018416686197091137">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.018416686197091137"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7772234154378874">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7772234154378874">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DevicesExportRequest {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName ">search</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Search</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">search</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.7628571991882942">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.7628571991882942">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7291930857460203">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7291930857460203" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.25410474560628216">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.25410474560628216" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.24046458461864684">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.24046458461864684" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.41670671698412454">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.41670671698412454"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.10032998429491524">Parameter content type:</label>
<select name="parameterContentType" id="pct0.10032998429491524">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DisableDevicesRequest {</span>
<div><span class="propWrap"><span class="propName ">deviceTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>device types list</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>10</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">deviceTypes</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.3096362171948124">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3096362171948124"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9131179047620355">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9131179047620355">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SearchExistingDevicesRequest {</span>
<div><span class="propWrap"><span class="propName ">msisdn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+?[1-9][0-9]{1,15}</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">msisdn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mdeviceType0.8553812559689642">deviceType</label></td>
<td>
<input class="parameter" minlength="0" name="deviceType" placeholder="" id="mdeviceType0.8553812559689642" type="text" value="">
</td>
<td class="markdown">
<p>DeviceType (optional)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mformat0.573310810514666">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.573310810514666" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.8087675232340183">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.8087675232340183" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.04043099137152195">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.04043099137152195" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.36006195386467277">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.36006195386467277" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.5313919266417402">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.5313919266417402" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6025049260293938">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6025049260293938" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mdeviceType0.1095011520252005">deviceType</label></td>
<td>
<input class="parameter" minlength="0" name="deviceType" placeholder="" id="mdeviceType0.1095011520252005" type="text" value="">
</td>
<td class="markdown">
<p>DeviceType (optional)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.622497373426341">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.622497373426341" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.7196015195797847">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.7196015195797847" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.8838524836008854">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.8838524836008854" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.082068831467488">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.082068831467488" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.1184762258867822">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.1184762258867822" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5577912994818546">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5577912994818546" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.7653680115689938">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.7653680115689938" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.15553552950826077">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.15553552950826077" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.8076570637572322">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.8076570637572322" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.49621568500698743">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.49621568500698743" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.4520510493794778">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.4520510493794778" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.5776744468749986">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.5776744468749986" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.8216084208252716">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.8216084208252716" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.10171630538814402">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.10171630538814402" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.032674297171179756">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.032674297171179756" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.25597380619149623">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.25597380619149623" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.17655072338659772">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.17655072338659772" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.3788889758818599">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.3788889758818599" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.21625250733222878">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.21625250733222878"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.09719788808934116">Parameter content type:</label>
<select name="parameterContentType" id="pct0.09719788808934116">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.9098742936334121">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.9098742936334121">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.252037545980089">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.252037545980089" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.4843584091993085">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4843584091993085" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.5960306037097123">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.5960306037097123" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.16291123945554764">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.16291123945554764" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.6306114397210949">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.6306114397210949" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.9243691562566392">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.9243691562566392" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.7283436357384434">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.7283436357384434" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.19193584597586621">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.19193584597586621" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.01663621338434429">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.01663621338434429" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.18955843806275618">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.18955843806275618" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.5910368285910488">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.5910368285910488" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.13504867419616806">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.13504867419616806" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8771550044802914">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8771550044802914" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.994552094558184">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.994552094558184" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8779761142185711">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8779761142185711"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.19950684583168776">Parameter content type:</label>
<select name="parameterContentType" id="pct0.19950684583168776">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactRequest {</span>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>first name</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>last name</p>
</span>,</div>
<div><span class="propName ">nickname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>nickname</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mobile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>mobile phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">landline</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>landline phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,20}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">fax</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fax number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,20}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email address</p>
</span>,</div>
<div><span class="propName ">birthday</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>birthday</p>
</span>,</div>
<div><span class="propName ">homepage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>homepage</p>
</span>,</div>
<div><span class="propName ">instantMessenger</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>instant messenger user</p>
</span>,</div>
<div><span class="propName ">skype</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skype name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>street</p>
</span>,</div>
<div><span class="propName ">zipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>zip code</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>city</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>country</p>
</span>,</div>
<div><span class="propName ">company</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">department</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>department</p>
</span>,</div>
<div><span class="propName ">bureau</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bureau</p>
</span>,</div>
<div><span class="propName ">jobTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>job title</p>
</span>,</div>
<div><span class="propName ">remoteSmsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS enabled?</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">whatsapp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whatsapp recipient</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">firstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">lastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">nickname</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">landline</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">fax</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthday</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">homepage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">instantMessenger</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">skype</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">street</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">zipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">city</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">country</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">company</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">department</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bureau</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">jobTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.21977442715618545">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.21977442715618545" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.4037894141386389">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4037894141386389" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.5991087521038216">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.5991087521038216" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.88490782153015">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.88490782153015" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.9792707855716678">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.9792707855716678" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.020468084373607365">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.020468084373607365" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.3657652563096354">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3657652563096354"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.026343387284764486">Parameter content type:</label>
<select name="parameterContentType" id="pct0.026343387284764486">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactRequest {</span>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>first name</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>last name</p>
</span>,</div>
<div><span class="propName ">nickname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>nickname</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mobile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>mobile phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">landline</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>landline phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,20}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">fax</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fax number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,20}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email address</p>
</span>,</div>
<div><span class="propName ">birthday</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>birthday</p>
</span>,</div>
<div><span class="propName ">homepage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>homepage</p>
</span>,</div>
<div><span class="propName ">instantMessenger</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>instant messenger user</p>
</span>,</div>
<div><span class="propName ">skype</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skype name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>street</p>
</span>,</div>
<div><span class="propName ">zipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>zip code</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>city</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>country</p>
</span>,</div>
<div><span class="propName ">company</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">department</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>department</p>
</span>,</div>
<div><span class="propName ">bureau</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bureau</p>
</span>,</div>
<div><span class="propName ">jobTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>job title</p>
</span>,</div>
<div><span class="propName ">remoteSmsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS enabled?</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">whatsapp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whatsapp recipient</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">firstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">lastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">nickname</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">landline</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">fax</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthday</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">homepage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">instantMessenger</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">skype</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">street</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">zipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">city</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">country</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">company</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">department</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bureau</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">jobTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.3742939630304849">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.3742939630304849" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.18073011028852903">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.18073011028852903"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.06453839124817717">Parameter content type:</label>
<select name="parameterContentType" id="pct0.06453839124817717">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.857073704460122">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.857073704460122" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.985281002198541">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.985281002198541" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mfile0.120751517915765">file</label></td>
<td>
<input type="file" name="file" id="mfile0.120751517915765">
<div class="parameter-content-type"></div>
</td>
<td class="markdown"></td>
<td>formData</td>
<td>
<span class="model-signature">undefined</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.26998083326313904">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.26998083326313904" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.8056255457950963">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8056255457950963" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.583526754680654">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.583526754680654" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.5456469215978168">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5456469215978168" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.9695780041561937">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.9695780041561937" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.7593046949070172">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7593046949070172" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.49391698734634737">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.49391698734634737" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8564608516242225">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8564608516242225" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.908942881612794">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.908942881612794" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.9908119009360954">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9908119009360954" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.54261080062457">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.54261080062457" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.031083354693474563">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.031083354693474563" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.20893040428855647">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.20893040428855647" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.7918680146520753">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.7918680146520753" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.4390871816963322">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4390871816963322"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3159350924759108">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3159350924759108">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ImportContactRequestDto {</span>
<div><span class="propName ">importFileId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>import file id</p>
</span>,</div>
<div><span class="propName ">fieldMapping</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fields to import file column mapping</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact groups to assign</p>
</span>,</div>
<div><span class="propName ">charset</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>override detected charset</p>
</span>,</div>
<div><span class="propName ">delimiter</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>override detected delimiter</p>
</span>,</div>
<div><span class="propName ">skipFirstRow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skip first row</p>
</span>,</div>
<div><span class="propName ">continueOnError</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>continue on error</p>
</span>,</div>
<div><span class="propName ">ignoreExistingContacts</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>don't touch existing contacts</p>
</span>,</div>
<div><span class="propName ">ignoreEmptyContacts</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>don't import empty contacts (containing no recipients</p>
</span>,</div>
<div><span class="propName ">mergeContactGroupIds</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whether to merge or delete existing group membership</p>
</span>,</div>
<div><span class="propName ">dryRun</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>dry run</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">duplicateCheckField</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whether to check for mobile or whatsapp duplicates</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^(?i)(mobile|whatsapp)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">importFileId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">fieldMapping</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">charset</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">delimiter</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">skipFirstRow</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">continueOnError</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">ignoreExistingContacts</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">ignoreEmptyContacts</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">mergeContactGroupIds</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">dryRun</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">duplicateCheckField</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.7083768350151181">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.7083768350151181">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.8293137714363705">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.8293137714363705" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.8941998230246584">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.8941998230246584" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.42863484712280076">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.42863484712280076" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.3961541896325491">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.3961541896325491" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.38112120511971126">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.38112120511971126" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8142261082801325">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8142261082801325" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.20465063557211693">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.20465063557211693" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.7421996069776629">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7421996069776629" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.7439163116916643">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.7439163116916643" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.35340777098742393">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.35340777098742393" type="text" value="+name">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.7301865554607343">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.7301865554607343" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.1768566012531967">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.1768566012531967" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.5132575293610342">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.5132575293610342" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.8219864766028375">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8219864766028375" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.7506624415459733">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.7506624415459733" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.7618529087372847">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7618529087372847" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.8614428325582879">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.8614428325582879" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.8296035268444915">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8296035268444915" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.8840402650081554">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8840402650081554" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.195599318887562">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.195599318887562" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.5673300947235895">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.5673300947235895" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.014453991762688467">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.014453991762688467" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.18164258488539708">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.18164258488539708" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.015107354441376009">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.015107354441376009" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.8574545684695343">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8574545684695343" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.8124356730923401">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8124356730923401" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5740619329220258">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5740619329220258" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.10457670546327047">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.10457670546327047" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.162122530339039">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.162122530339039" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.7530648787897234">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7530648787897234"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.04786088542771871">Parameter content type:</label>
<select name="parameterContentType" id="pct0.04786088542771871">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.6523439192826916">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.6523439192826916">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.7631992629803566">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.7631992629803566" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.8292426176284287">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8292426176284287" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.7492563671012733">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.7492563671012733" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.5453823187987576">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.5453823187987576" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.3540800058436504">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3540800058436504" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.09301612145388294">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.09301612145388294" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.8690897622352383">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.8690897622352383" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.5789299964795547">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.5789299964795547" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.673453293897111">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.673453293897111" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.28902385061231395">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.28902385061231395" type="text" value="+name">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.428903897999263">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.428903897999263" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.42419025117302267">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.42419025117302267" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.6719721878228972">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.6719721878228972" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.729496777975913">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.729496777975913"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3802452444384068">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3802452444384068">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactGroupRequest {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>group name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">birthdayTemplateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message template used for birthday messages</p>
</span>,</div>
<div><span class="propName ">remoteSmsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS enabled?</p>
</span>,</div>
<div><span class="propName ">remoteSmsShortcut</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS shortcut</p>
</span>,</div>
<div><span class="propName ">remoteSmsTemplateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message template used for remote SMS</p>
</span>,</div>
<div><span class="propName ">welcomeSmsContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome sms content</p>
</span>,</div>
<div><span class="propName ">welcomeSmsActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome sms active?</p>
</span>,</div>
<div><span class="propName ">goodbyeSmsContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye sms content</p>
</span>,</div>
<div><span class="propName ">goodbyeSmsActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye sms active?</p>
</span>,</div>
<div><span class="propName ">welcomeWhatsappContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome whatsapp content</p>
</span>,</div>
<div><span class="propName ">welcomeWhatsappActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome whatsapp active?</p>
</span>,</div>
<div><span class="propName ">goodbyeWhatsappContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye whatsapp content</p>
</span>,</div>
<div><span class="propName ">goodbyeWhatsappActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye whatsapp active?</p>
</span>,</div>
<div><span class="propName ">mobile</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is sms/voice/push group?</p>
</span>,</div>
<div><span class="propName ">whatsapp</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is whatsapp group?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthdayTemplateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsShortcut</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsTemplateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeSmsContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeSmsActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeSmsContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeSmsActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeWhatsappContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeWhatsappActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeWhatsappContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeWhatsappActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.45604771300725444">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.45604771300725444" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.37126929993700286">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.37126929993700286" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.012750138934296995">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.012750138934296995" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.5179635942454173">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.5179635942454173" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.14351032475696535">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.14351032475696535" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.17893779880098326">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.17893779880098326" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.6578268353377614">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6578268353377614" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.7538982761495332">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7538982761495332"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5961933343462114">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5961933343462114">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactGroupRequest {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>group name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">birthdayTemplateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message template used for birthday messages</p>
</span>,</div>
<div><span class="propName ">remoteSmsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS enabled?</p>
</span>,</div>
<div><span class="propName ">remoteSmsShortcut</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS shortcut</p>
</span>,</div>
<div><span class="propName ">remoteSmsTemplateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message template used for remote SMS</p>
</span>,</div>
<div><span class="propName ">welcomeSmsContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome sms content</p>
</span>,</div>
<div><span class="propName ">welcomeSmsActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome sms active?</p>
</span>,</div>
<div><span class="propName ">goodbyeSmsContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye sms content</p>
</span>,</div>
<div><span class="propName ">goodbyeSmsActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye sms active?</p>
</span>,</div>
<div><span class="propName ">welcomeWhatsappContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome whatsapp content</p>
</span>,</div>
<div><span class="propName ">welcomeWhatsappActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome whatsapp active?</p>
</span>,</div>
<div><span class="propName ">goodbyeWhatsappContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye whatsapp content</p>
</span>,</div>
<div><span class="propName ">goodbyeWhatsappActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye whatsapp active?</p>
</span>,</div>
<div><span class="propName ">mobile</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is sms/voice/push group?</p>
</span>,</div>
<div><span class="propName ">whatsapp</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is whatsapp group?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthdayTemplateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsShortcut</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsTemplateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeSmsContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeSmsActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeSmsContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeSmsActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeWhatsappContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeWhatsappActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeWhatsappContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeWhatsappActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.1256065046895356">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.1256065046895356" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.10356006579891486">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.10356006579891486" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.43309927065346443">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.43309927065346443" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.6721926076664262">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.6721926076664262" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.15798990436939953">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.15798990436939953" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.061983611734267585">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.061983611734267585" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.6363740225532026">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.6363740225532026" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.7896540174068891">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7896540174068891"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.12571746259923455">Parameter content type:</label>
<select name="parameterContentType" id="pct0.12571746259923455">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.11063747344437203">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.11063747344437203" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.78965708736767">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.78965708736767" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.8732454281331834">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.8732454281331834" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.5305749984691781">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5305749984691781" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.05191649795225617">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.05191649795225617"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2514176228552636">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2514176228552636">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PurgeContactGroupRequest {</span>
<div><span class="propName ">exclusiveOnly</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>delete only contacts exclusive in this group</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">exclusiveOnly</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.9054319156391368">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.9054319156391368" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.09889432924270136">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.09889432924270136" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.14467228910468077">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.14467228910468077" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.44393970375797">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.44393970375797" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.9004256950200056">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.9004256950200056" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.19041304337959075">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.19041304337959075" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.011790350550487938">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.011790350550487938" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.24344445231927558">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.24344445231927558" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.30261538840879765">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.30261538840879765" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.5500081979200033">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.5500081979200033" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.4501495898552945">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4501495898552945" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.3905714024582265">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.3905714024582265" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.07197169554242033">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.07197169554242033" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.8246301885220813">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8246301885220813" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.659796879456525">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.659796879456525" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.8583440342441253">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.8583440342441253" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.5870037051437424">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.5870037051437424" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.4385341397674356">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.4385341397674356" type="text" value="-id">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.8905970111117862">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8905970111117862" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8721445902237843">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8721445902237843" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.9756746816172073">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.9756746816172073" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.12345108242156333">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.12345108242156333"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5857485313358315">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5857485313358315">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactGroupMembershipRequest {</span>
<div><span class="propName required">contactGroupId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>contact group id</p>
</span>,</div>
<div><span class="propName required">contactId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>contact id</p>
</span>,</div>
<div><span class="propName ">mobile</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is sms/voice/push group?</p>
</span>,</div>
<div><span class="propName ">whatsapp</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is whatsapp group?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contactGroupId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.2375978356110604">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.2375978356110604" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.3596727506290207">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3596727506290207"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.38180774698269127">Parameter content type:</label>
<select name="parameterContentType" id="pct0.38180774698269127">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CopyContactGroupMembershipsRequest {</span>
<div><span class="propName ">sourceIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>source contact group ids</p>
</span>,</div>
<div><span class="propName ">targetId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target contact group id</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">sourceIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">targetId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.08092710117328528">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.08092710117328528" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.12886106868595015">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.12886106868595015" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.5575121360035176">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.5575121360035176" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.6659092440552152">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6659092440552152" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.5357189254237766">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.5357189254237766" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.7592334938170537">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7592334938170537" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.5896316243287687">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5896316243287687"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4334702655834619">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4334702655834619">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactGroupMembershipRequest {</span>
<div><span class="propName required">contactGroupId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>contact group id</p>
</span>,</div>
<div><span class="propName required">contactId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>contact id</p>
</span>,</div>
<div><span class="propName ">mobile</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is sms/voice/push group?</p>
</span>,</div>
<div><span class="propName ">whatsapp</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is whatsapp group?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contactGroupId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.6627435941581257">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.6627435941581257" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.3949302957156102">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3949302957156102" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.4725995792054576">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4725995792054576"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.948170667405529">Parameter content type:</label>
<select name="parameterContentType" id="pct0.948170667405529">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PurgeContactGroupMembershipRequest {</span>
<div><span class="propName ">exclusiveOnly</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>delete only contacts exclusive in this group</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">exclusiveOnly</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.2873951481402772">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.2873951481402772" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.384325562610613">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.384325562610613"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4655970649710568">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4655970649710568">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AddContactGroupMembershipsRequest {</span>
<div><span class="propName ">contactIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>source contact ids</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target contact group id</p>
</span>,</div>
<div><span class="propName ">deleteExisting</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whether to delete exiting memberships for the contacts</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contactIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">deleteExisting</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdirectorySelector0.8460361383071691">directorySelector</label></td>
<td>
<input class="parameter required" minlength="1" name="directorySelector" placeholder="(required)" id="mdirectorySelector0.8460361383071691" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.9523735590958693">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9523735590958693"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8694032965992828">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8694032965992828">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6660998778490135">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6660998778490135" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6203945045758534">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6203945045758534" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9143708388743763">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9143708388743763" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.35737918295319737">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.35737918295319737"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.25983064951878276">Parameter content type:</label>
<select name="parameterContentType" id="pct0.25983064951878276">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExceptionRoutingRequest {</span>
<div><span class="propWrap"><span class="propName ">msisdn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>msisdn</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+?[1-9][0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">regionCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>active</p>
</span>,</div>
<div><span class="propName ">routeProfile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>routeProfile</p>
</span>,</div>
<div><span class="propName ">sender</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sender</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">msisdn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">regionCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">routeProfile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sender</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.6887111812811841">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.6887111812811841" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.9286828162239398">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.9286828162239398" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.8223430132038392">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.8223430132038392" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.1483882282518607">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.1483882282518607" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6795448420130323">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6795448420130323" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.029863244385004428">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.029863244385004428"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.024622723941776226">Parameter content type:</label>
<select name="parameterContentType" id="pct0.024622723941776226">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExceptionRoutingRequest {</span>
<div><span class="propWrap"><span class="propName ">msisdn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>msisdn</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+?[1-9][0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">regionCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>active</p>
</span>,</div>
<div><span class="propName ">routeProfile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>routeProfile</p>
</span>,</div>
<div><span class="propName ">sender</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sender</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">msisdn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">regionCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">active</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">routeProfile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sender</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.33309889518113533">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.33309889518113533" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.18297192104003224">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.18297192104003224"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7467843972932835">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7467843972932835">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExceptionRoutingTestMessageRequest {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.532499695270078">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.532499695270078" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.4250103493062716">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.4250103493062716" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.5388564562629767">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.5388564562629767" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.8455964746850622">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8455964746850622" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8095857109387294">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8095857109387294" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3760799924281977">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3760799924281977" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtest_message_log_id0.3228814293441864">test_message_log_id</label></td>
<td>
<input class="parameter required" minlength="1" name="test_message_log_id" placeholder="(required)" id="mtest_message_log_id0.3228814293441864" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.364557857983439">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.364557857983439" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.3725252522309681">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.3725252522309681" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.7025606226093186">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.7025606226093186" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.316398730361519">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.316398730361519" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6274957550377589">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6274957550377589"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.007024061656365488">Parameter content type:</label>
<select name="parameterContentType" id="pct0.007024061656365488">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HlrLookupRequest {</span>
<div><span class="propWrap"><span class="propName ">msisdn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>msisdn</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+?[1-9][0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">msisdn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8905202996424286">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8905202996424286" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.029220775141964195">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.029220775141964195" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.04207617532347596">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.04207617532347596" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5884798127365665">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5884798127365665" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.11499602934487507">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.11499602934487507"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8814016942922913">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8814016942922913">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.7231647101921757">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.7231647101921757">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.052621233777041754">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.052621233777041754" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.8999024778476743">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.8999024778476743" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.3172856647672735">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.3172856647672735" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.05872089391356661">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.05872089391356661" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.5191857614198172">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.5191857614198172" type="text" value="-receivedOn">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.024287702532391542">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.024287702532391542" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.027454964379395985">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.027454964379395985" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9006548122745923">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9006548122745923" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8703100146687894">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8703100146687894" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.32656355131466785">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.32656355131466785"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.942206378708248">Parameter content type:</label>
<select name="parameterContentType" id="pct0.942206378708248">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mformat0.6994623403035598">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.6994623403035598" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.030960037753829495">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.030960037753829495" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.9190388669018454">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.9190388669018454" type="text" value="-receivedOn">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.5300685486940275">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.5300685486940275" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.7130557557577022">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.7130557557577022" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3182655817681146">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3182655817681146" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7393004852555014">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7393004852555014" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="msize0.9248346874470017">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9248346874470017" type="text" value="10">
</td>
<td class="markdown">
<p>The preferred amount of conversation items</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.5262600678896194">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.5262600678896194" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.2634078894867036">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.2634078894867036" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.26039323070405396">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.26039323070405396" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.8887922822546868">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8887922822546868" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9849141466853755">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9849141466853755" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcontactGroupId0.21777200380697836">contactGroupId</label></td>
<td>
<input class="parameter" minlength="0" name="contactGroupId" placeholder="" id="mcontactGroupId0.21777200380697836" type="text" value="">
</td>
<td class="markdown">
<p>Filters results by contact group ids</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6425931402550038">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6425931402550038"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7868261308817688">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7868261308817688">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactSubscriptionReport {</span>
<div><span class="propWrap"><span class="propName ">emailRecipients</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email recipient list</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>100</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">weekdays</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>weekdays</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">emailRecipients</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">weekdays</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6999588401465355">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6999588401465355" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7078158859943395">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7078158859943395" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.41344495239821777">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.41344495239821777"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.13479425999221406">Parameter content type:</label>
<select name="parameterContentType" id="pct0.13479425999221406">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactSubscriptionReport {</span>
<div><span class="propWrap"><span class="propName ">emailRecipients</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email recipient list</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>100</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">weekdays</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>weekdays</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">emailRecipients</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">weekdays</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3998277028046686">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3998277028046686" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.7548269499136593">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.7548269499136593" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.5634293820630456">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5634293820630456" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.8316644256525745">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.8316644256525745" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.58819250058987">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.58819250058987" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.2139899208474183">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.2139899208474183" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.13975025339851066">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.13975025339851066" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.7019101139165855">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.7019101139165855" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.4136668952579263">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4136668952579263" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.6962618382109862">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.6962618382109862" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mfile0.3358674803302011">file</label></td>
<td>
<input type="file" name="file" id="mfile0.3358674803302011">
<div class="parameter-content-type"></div>
</td>
<td class="markdown"></td>
<td>formData</td>
<td>
<span class="model-signature">undefined</span>
</td>
</tr>
<tr>
<td class="code"><label for="mattachmentType0.35895279952415504">attachmentType</label></td>
<td>
<input class="parameter" minlength="0" name="attachmentType" placeholder="" id="mattachmentType0.35895279952415504" type="text" value="">
</td>
<td class="markdown"></td>
<td>formData</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.6705816204058543">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.6705816204058543" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.05016985372097915">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.05016985372097915" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.9162573429352174">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.9162573429352174" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.25111673589463157">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.25111673589463157" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.45665124527292855">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.45665124527292855" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.6858163303780576">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.6858163303780576" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8193660182257114">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8193660182257114"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9793453221103559">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9793453221103559">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.5343397426148642">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.5343397426148642">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.40808727742187356">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.40808727742187356" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.8883593919473163">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.8883593919473163" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.16565965256179904">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.16565965256179904" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.8772666574448236">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.8772666574448236" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.4128689163463033">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.4128689163463033" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.07838504724622397">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.07838504724622397" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="msize0.9403653296554155">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9403653296554155" type="text" value="10">
</td>
<td class="markdown">
<p>The preferred amount of messages</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.38458949823767696">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.38458949823767696" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.6204175277351194">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.6204175277351194" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.3019433887767835">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.3019433887767835" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.6639074008374557">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.6639074008374557" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.42038029795426435">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.42038029795426435" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.5013003754617023">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.5013003754617023" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.3786363100015915">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.3786363100015915" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.11371227682692209">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.11371227682692209" type="text" value="-timestamp">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.9894738562833019">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.9894738562833019" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5308034413806431">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5308034413806431" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.9058986086991434">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.9058986086991434" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.20392676137919263">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.20392676137919263" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.4988348263443849">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.4988348263443849" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.9937643374541394">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.9937643374541394" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5922394191004794">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5922394191004794" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.465482511220046">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.465482511220046" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.6187486632120087">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.6187486632120087" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.7495771454569533">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7495771454569533" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.7071030466615345">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.7071030466615345" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.35709461444235746">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.35709461444235746" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.5695281572612558">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.5695281572612558" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.24588990723349835">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.24588990723349835" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.6788123763201801">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.6788123763201801" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.7806560930879851">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.7806560930879851" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5916686305677159">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5916686305677159" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.7414076990172134">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.7414076990172134" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.9291243166731469">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.9291243166731469" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.7137709837519597">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.7137709837519597" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.9273269078428881">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.9273269078428881" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.0951934802375527">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.0951934802375527" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.40853631760291775">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.40853631760291775" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.2623391149074299">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.2623391149074299"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4042233156805637">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4042233156805637">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.11267998467337992">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.11267998467337992">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.9004554530986295">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.9004554530986295" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.11388617764019582">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.11388617764019582" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.054560389831052936">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.054560389831052936" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.17838130690450482">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.17838130690450482" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.11211104158715024">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.11211104158715024" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.03521843652800105">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.03521843652800105" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.489396521146084">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.489396521146084" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6521916901335629">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6521916901335629" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.5127306290331866">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.5127306290331866" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.7297517059566296">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7297517059566296" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.6228593026885327">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.6228593026885327" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6104914192410242">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6104914192410242" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.608324623601735">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.608324623601735" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.46389111658977966">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.46389111658977966" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.0421694995664581">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.0421694995664581" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.19236565291642904">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.19236565291642904" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.10591290963629674">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.10591290963629674" type="text" value="-sentOn">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.08280816964629811">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.08280816964629811" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8308464087203169">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8308464087203169" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.5876466689275701">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.5876466689275701" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.4201754589708364">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4201754589708364" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.16035439514205163">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.16035439514205163" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.5955016268594995">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5955016268594995" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.8424031091110358">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.8424031091110358" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.06037195691566666">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.06037195691566666"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7455587122769178">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7455587122769178">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.028885397396318124">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.028885397396318124" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.709676732874934">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.709676732874934" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.06910642730528238">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.06910642730528238" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.23110848601656864">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.23110848601656864" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.06836157286054934">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.06836157286054934" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.5987726573134355">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.5987726573134355" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.7654529627203683">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.7654529627203683" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.2053867237183471">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.2053867237183471" type="text" value="-sentOn">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.9514683978771423">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.9514683978771423" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.24029326959540187">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.24029326959540187" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.2535847377682434">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.2535847377682434" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.504198069682086">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.504198069682086" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.44904361989466235">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.44904361989466235" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5848326844975933">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5848326844975933" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.7748321050190736">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.7748321050190736" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.11957219004772734">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.11957219004772734" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.4702349435237829">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4702349435237829"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.03987724300236928">Parameter content type:</label>
<select name="parameterContentType" id="pct0.03987724300236928">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.5084876941840752">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.5084876941840752">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.8447810101962114">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.8447810101962114" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.7038709394363445">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7038709394363445" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.956418952065899">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.956418952065899" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.2269354236316643">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.2269354236316643" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.018199617746979868">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.018199617746979868" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.2895795514517958">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.2895795514517958" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.5948181760470379">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.5948181760470379" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.8760433664042593">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8760433664042593" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.6916414737625487">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.6916414737625487" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.8834427003288277">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.8834427003288277" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.12504451567925168">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.12504451567925168" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.6487499488153128">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.6487499488153128" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.6305844928812758">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.6305844928812758" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.5585043234102376">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.5585043234102376" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.142581725319332">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.142581725319332" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.3850553329008093">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.3850553329008093" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.2616402565121312">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.2616402565121312" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.0892882236477539">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.0892882236477539" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6188786147833061">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6188786147833061"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5988008486033585">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5988008486033585">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MessageArchiveUrlshortenerStatisticExportRequest {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Start date</p>
</span>,</div>
<div><span class="propName ">to</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>End date</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">from</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">to</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.25515070858155386">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.25515070858155386">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.7963171179820798">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.7963171179820798" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.8914412532324432">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.8914412532324432" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.823598767115775">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.823598767115775" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.03882141007472528">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.03882141007472528" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.6625154111240488">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.6625154111240488" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.4044515113524163">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.4044515113524163" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.25218402189373923">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.25218402189373923" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.2615608407305239">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.2615608407305239" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.5023244098502342">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.5023244098502342" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.0981646635604736">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.0981646635604736" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.04352469906321477">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.04352469906321477" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.8628925143541439">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.8628925143541439" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.11522603367390838">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.11522603367390838" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.38142742238382055">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.38142742238382055" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.64222180346004">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.64222180346004" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.8947797741434409">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.8947797741434409" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.33941427357768417">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.33941427357768417" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.9548083380337915">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.9548083380337915" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.4082402609885889">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4082402609885889" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.41682459240559355">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.41682459240559355" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6839207367362641">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6839207367362641" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.53649471769346">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.53649471769346" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.8018156495458848">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8018156495458848" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.8222197626463388">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8222197626463388" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.7532411693554404">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.7532411693554404" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.7072157515067738">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.7072157515067738" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.08133588100686828">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.08133588100686828" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.426972482862398">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.426972482862398" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.27543970336994317">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.27543970336994317" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.6386719036457018">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.6386719036457018" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.41739769073086297">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.41739769073086297" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.24570963960222603">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.24570963960222603" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.4215353045951824">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.4215353045951824" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8149492289378517">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8149492289378517"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3332467832340771">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3332467832340771">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OutboxMessageRequest {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message content</p>
</span>,</div>
<div><span class="propName ">subject</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>subject</p>
</span>,</div>
<div><span class="propName ">recipients</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>recipient list</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group id list</p>
</span>,</div>
<div><span class="propName ">selectors</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>selectors</p>
</span>,</div>
<div><span class="propName ">sendOn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>send on (now if not specified)</p>
</span>,</div>
<div><span class="propName ">timeSpread</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>time spread in hours</p>
</span>,</div>
<div><span class="propName ">repeat</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat period (hourly, daily, weekly, monthly, yearly)</p>
</span>,</div>
<div><span class="propName ">repeatInterval</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat interval</p>
</span>,</div>
<div><span class="propName ">repeatIterations</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat iterations</p>
</span>,</div>
<div><span class="propName ">repeatEndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat end datetime</p>
</span>,</div>
<div><span class="propName ">deliveryReport</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>request delivery report?</p>
</span>,</div>
<div><span class="propName ">smsType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>SMS type (0 = default, 1 = flash, 2 = both)</p>
</span>,</div>
<div><span class="propName ">predictedSmsCount</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>predicted SMS count</p>
</span>,</div>
<div><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content category (personal, advertisement or informational</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">messageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message type (default, sms, voice, whatsapp</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^(?i)(default|voice|whatsapp)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">attachmentId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attachment id</p>
</span>,</div>
<div><span class="propName ">urlshorteningType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>urlshortening type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">subject</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">recipients</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">selectors</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">sendOn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.755Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timeSpread</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeat</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatInterval</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatIterations</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatEndDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.755Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">deliveryReport</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">smsType</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">predictedSmsCount</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">urlshorteningType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.05067276304185708">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.05067276304185708" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.1801238111691843">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.1801238111691843" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.9489603613137179">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.9489603613137179" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.3198295766602126">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3198295766602126" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.892205800392649">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.892205800392649" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.3041776046655904">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3041776046655904" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.28237441822251097">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.28237441822251097"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7418225694156317">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7418225694156317">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OutboxMessageRequest {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message content</p>
</span>,</div>
<div><span class="propName ">subject</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>subject</p>
</span>,</div>
<div><span class="propName ">recipients</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>recipient list</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group id list</p>
</span>,</div>
<div><span class="propName ">selectors</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>selectors</p>
</span>,</div>
<div><span class="propName ">sendOn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>send on (now if not specified)</p>
</span>,</div>
<div><span class="propName ">timeSpread</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>time spread in hours</p>
</span>,</div>
<div><span class="propName ">repeat</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat period (hourly, daily, weekly, monthly, yearly)</p>
</span>,</div>
<div><span class="propName ">repeatInterval</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat interval</p>
</span>,</div>
<div><span class="propName ">repeatIterations</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat iterations</p>
</span>,</div>
<div><span class="propName ">repeatEndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat end datetime</p>
</span>,</div>
<div><span class="propName ">deliveryReport</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>request delivery report?</p>
</span>,</div>
<div><span class="propName ">smsType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>SMS type (0 = default, 1 = flash, 2 = both)</p>
</span>,</div>
<div><span class="propName ">predictedSmsCount</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>predicted SMS count</p>
</span>,</div>
<div><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content category (personal, advertisement or informational</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">messageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message type (default, sms, voice, whatsapp</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^(?i)(default|voice|whatsapp)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">attachmentId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attachment id</p>
</span>,</div>
<div><span class="propName ">urlshorteningType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>urlshortening type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">subject</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">recipients</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">selectors</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">sendOn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.756Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timeSpread</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeat</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatInterval</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatIterations</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatEndDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.756Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">deliveryReport</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">smsType</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">predictedSmsCount</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">urlshorteningType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.8405120151174243">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.8405120151174243" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.4085535796021813">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4085535796021813"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.653159694560377">Parameter content type:</label>
<select name="parameterContentType" id="pct0.653159694560377">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.41876262772693074">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.41876262772693074" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.9965829202039578">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9965829202039578" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.8820306217460157">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8820306217460157" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6862030771429428">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6862030771429428" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.968291272093688">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.968291272093688" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.9564593832296611">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.9564593832296611" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.8543570293701266">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.8543570293701266" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.06908201684810766">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.06908201684810766" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.5901784705318271">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.5901784705318271" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.33689164956086204">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.33689164956086204" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.5685738453828835">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.5685738453828835" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.5909612652839131">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.5909612652839131" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9767146824697506">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9767146824697506" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.7129931703269665">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.7129931703269665" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.9240154720512357">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9240154720512357"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9376534010338662">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9376534010338662">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.6026859911215039">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.6026859911215039">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.20359959272117556">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.20359959272117556" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.04107831248824789">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.04107831248824789" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.5597655446361769">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.5597655446361769" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.6101259449831775">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.6101259449831775" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.7420487312308945">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.7420487312308945" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.9089546863429061">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.9089546863429061" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.7313356000551958">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.7313356000551958" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.7658041456142906">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.7658041456142906" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.6200625632172683">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.6200625632172683" type="text" value="-receivedOn">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.9911528194406118">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.9911528194406118" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5531586293908546">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5531586293908546" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.26896571045663253">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.26896571045663253" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.17082136896393463">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.17082136896393463" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.2516213551819022">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.2516213551819022" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.1523692053956478">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.1523692053956478" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.5088459331498476">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.5088459331498476" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8742135644606643">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8742135644606643"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.17930272649275647">Parameter content type:</label>
<select name="parameterContentType" id="pct0.17930272649275647">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.9077730786589029">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.9077730786589029" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.13340772918795518">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.13340772918795518" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.6036365779144703">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.6036365779144703" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.6670323874297643">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.6670323874297643" type="text" value="-receivedOn">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.35334516527298065">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.35334516527298065" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.226645445479013">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.226645445479013" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.3500342836836521">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.3500342836836521" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.5732190833065289">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5732190833065289" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.10522415215269265">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.10522415215269265" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mid0.07144464547745244">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.07144464547745244" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="msize0.7670299731515076">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.7670299731515076" type="text" value="10">
</td>
<td class="markdown">
<p>The preferred amount of conversation items</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmailboxSelector0.8749577632763483">mailboxSelector</label></td>
<td>
<input class="parameter required" minlength="1" name="mailboxSelector" placeholder="(required)" id="mmailboxSelector0.8749577632763483" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.041265630661565966">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.041265630661565966" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mfile0.04298011274131586">file</label></td>
<td>
<input type="file" name="file" id="mfile0.04298011274131586">
<div class="parameter-content-type"></div>
</td>
<td class="markdown">
<p>The file to upload.</p>
</td>
<td>formData</td>
<td>
<span class="model-signature">undefined</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7449236708453486">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7449236708453486"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.40250791524992646">Parameter content type:</label>
<select name="parameterContentType" id="pct0.40250791524992646">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">VoiceMessageSendRequest {</span>
<div><span class="propName required">recipientAddressList</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>List of recipients (E164 formatted MSISDNs - see Wikipedia en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The list of recipients may contain a maximum of 1000 entries.</p>
</span>,</div>
<div><span class="propName ">senderAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Address of the sender (assigned to the account) from which the message is sent.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">senderAddressType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> The sender address type. The following address types are supported: <code>national</code>, <code>international</code>, <code>alphanumeric</code> or <code>shortcode</code>).</p>
</span> = <span class="propVals">['national', 'international', 'alphanumeric', 'shortcode']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"national", "international", "alphanumeric", "shortcode"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> The content category that is used to categorize the message (used for blacklisting). The following content categories are supported: <code>informational</code> or <code>advertisement</code>. If no
content category is provided, the default setting is used (may be changed inside the onlinesms web interface).</p>
</span> = <span class="propVals">['informational', 'advertisement']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"informational", "advertisement"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">notificationCallbackUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> When setting a notificationCallbackUrl all delivery reports are forwarded to this URL.</p>
</span>,</div>
<div><span class="propName ">clientMessageId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> May contain a freely definable message id.</p>
</span>,</div>
<div><span class="propName ">priority</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Priority of the message. Must not exceed the value configured for the account used to send the message. For more information please contact our customer service.</p>
</span>,</div>
<div><span class="propName ">test</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> <code>true</code>: The transmission is only simulated, no SMS is sent. Depending on the number of recipients the status code 2000 or 2001 is returned. <code>false</code> (default): No simulation is
done. The SMS is sent via the SMS Gateway.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">validityPeriode</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Specifies the validity periode (in seconds) in which the message is tried to be delivered to the recipient. A minimum of 1 minute and a maximum of 3 days are allowed.</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>60</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>259200</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">messageContent</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">maxSmsPerMessage</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">recipientAddressList</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"[\"436991234567\"]"</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"4369912345678"</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddressType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"international"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"informational"</span></span></span></span>,
"<span class="attribute"><span class="attribute">notificationCallbackUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"https://user:pass@myservice.com/myservice/"</span></span></span></span>,
"<span class="attribute"><span class="attribute">clientMessageId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"myUniqueId"</span></span></span></span>,
"<span class="attribute"><span class="attribute">priority</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">5</span></span></span></span>,
"<span class="attribute"><span class="attribute">test</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriode</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">300</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">maxSmsPerMessage</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">2000</td>
<td class="markdown">
<p>OK - Accepted. The request has been accepted by the network operator.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">2001</td>
<td class="markdown">
<p>OK - Queued. Request with multiple recipients has been queued for immediate delivery.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4001</td>
<td class="markdown">
<p>ERR - Invalid Credentials. Inactive account or customer.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4002</td>
<td class="markdown">
<p>ERR - Invalid Recipients. One or more recipients are not in the correct format or contain invalid msisdns (i.e: 436761234567).</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4003</td>
<td class="markdown">
<p>ERR - Invalid Sender. Sender address or type is invalid.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4008</td>
<td class="markdown">
<p>ERR - Invalid clientMessageId.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4009</td>
<td class="markdown">
<p>ERR - Message text (messageContent) is invalid</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4013</td>
<td class="markdown">
<p>ERR - Message limit is reached.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4014</td>
<td class="markdown">
<p>ERR - Sender IP address is not authorized.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4015</td>
<td class="markdown">
<p>ERR - Invalid message priority.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4016</td>
<td class="markdown">
<p>ERR - Invalid COD ReturnAddress (notificationCallbackUrl)</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4019</td>
<td class="markdown">
<p>ERR - A required parameter was not given. The parameter name is shown in the statusMessage</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4021</td>
<td class="markdown">
<p>ERR - Invalid account.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4022</td>
<td class="markdown">
<p>ERR - Access to the API was denied.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4023</td>
<td class="markdown">
<p>ERR - Request limit exceeded for this IP address</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4025</td>
<td class="markdown">
<p>ERR - Recipients amount over limit. A maximum of 50 recipients per message is allowed in a single request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4026</td>
<td class="markdown">
<p>ERR - MaxSmsPerMessage exceeded. SMS amount limit per message was hit.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4040</td>
<td class="markdown">
<p>ERR - Invalid contentCategory.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4041</td>
<td class="markdown">
<p>ERR - Invalid validityPeriode. A minimum of 60 seconds is allowed</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">5000</td>
<td class="markdown">
<p>ERR - Internal error. Please contact support.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">5003</td>
<td class="markdown">
<p>ERR - The service is currently not available</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.3567231872629837">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.3567231872629837"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.21957583946409054">Parameter content type:</label>
<select name="parameterContentType" id="pct0.21957583946409054">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhatsAppMessageSendRequest {</span>
<div><span class="propName required">messageContent</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p><code>UTF-8</code> encoded message content. May not exceed 10000 characters.</p>
</span>,</div>
<div><span class="propName required">recipientAddressList</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>List of recipients (E164 formatted MSISDNs - see Wikipedia en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The list of recipients may contain a maximum of 1000 entries.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> The content category that is used to categorize the message (used for blacklisting). The following content categories are supported: <code>informational</code> or <code>advertisement</code>. If no
content category is provided, the default setting is used (may be changed inside the onlinesms web interface).</p>
</span> = <span class="propVals">['informational', 'advertisement']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"informational", "advertisement"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">clientMessageId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> May contain a freely definable message id.</p>
</span>,</div>
<div><span class="propName ">priority</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Priority of the message. Must not exceed the value configured for the account used to send the message. For more information please contact our customer service.</p>
</span>,</div>
<div><span class="propName ">test</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> <code>true</code>: The transmission is only simulated, no Whatsapp message is sent. Depending on the number of recipients the status code 2000 or 2001 is returned. <code>false</code> (default): No
simulation is done. The Whatsapp message is sent.</p>
</span>,</div>
<div><span class="propName ">attachmentId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> May contain an attachmentId. Attachments can be created by using <code>POST /whatsapp/attachment</code></p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">validityPeriode</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Specifies the validity periode (in seconds) in which the message is tried to be delivered to the recipient. A minimum of 1 minute and a maximum of 3 days are allowed.</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>60</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>259200</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"example message content"</span></span></span></span>,
"<span class="attribute"><span class="attribute">recipientAddressList</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"[\"436991234567\"]"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"informational"</span></span></span></span>,
"<span class="attribute"><span class="attribute">clientMessageId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"myUniqueId"</span></span></span></span>,
"<span class="attribute"><span class="attribute">priority</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">5</span></span></span></span>,
"<span class="attribute"><span class="attribute">test</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">20</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriode</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">300</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.188604108357032">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.188604108357032"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6730874156876281">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6730874156876281">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TextMessageSendRequest {</span>
<div><span class="propName required">recipientAddressList</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>List of recipients (E164 formatted MSISDNs - see Wikipedia en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The list of recipients may contain a maximum of 1000 entries.</p>
</span>,</div>
<div><span class="propName ">senderAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Address of the sender (assigned to the account) from which the message is sent.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">senderAddressType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> The sender address type. The following address types are supported: <code>national</code>, <code>international</code>, <code>alphanumeric</code> or <code>shortcode</code>).</p>
</span> = <span class="propVals">['national', 'international', 'alphanumeric', 'shortcode']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"national", "international", "alphanumeric", "shortcode"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> The content category that is used to categorize the message (used for blacklisting). The following content categories are supported: <code>informational</code> or <code>advertisement</code>. If no
content category is provided, the default setting is used (may be changed inside the onlinesms web interface).</p>
</span> = <span class="propVals">['informational', 'advertisement']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"informational", "advertisement"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">notificationCallbackUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> When setting a notificationCallbackUrl all delivery reports are forwarded to this URL.</p>
</span>,</div>
<div><span class="propName ">clientMessageId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> May contain a freely definable message id.</p>
</span>,</div>
<div><span class="propName ">priority</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Priority of the message. Must not exceed the value configured for the account used to send the message. For more information please contact our customer service.</p>
</span>,</div>
<div><span class="propName ">test</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> <code>true</code>: The transmission is only simulated, no SMS is sent. Depending on the number of recipients the status code 2000 or 2001 is returned. <code>false</code> (default): No simulation is
done. The SMS is sent via the SMS Gateway.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">validityPeriode</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Specifies the validity periode (in seconds) in which the message is tried to be delivered to the recipient. A minimum of 1 minute and a maximum of 3 days are allowed.</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>60</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>259200</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">sendAsFlashSms</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> <code>true</code>: The message is sent as flash SMS (displayed directly on the screen of the mobile phone). <code>false</code> (default): The message is sent as standard text SMS </p>
</span>,</div>
<div><span class="propName required">messageContent</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p><code>UTF-8</code> encoded message content</p>
</span>,</div>
<div><span class="propName ">maxSmsPerMessage</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Specifies the maximum number of SMS to be generated. If the system generates more than this number of SMS, the status code 4026 is returned. The default value of this parameter is <code>0</code>.If set
to <code>0</code>, no limitation is applied.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">messageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Specifies the message type. Allowed values are <code>default</code> and <code>voice</code>. When using the message type <code>default</code>, the outgoing message type is determined based on account
settings. Using the message type <code>voice</code> triggers a voice call.</p>
</span> = <span class="propVals">['default', 'voice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "voice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">pushParameters</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">additionalPushParameters</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">recipientAddressList</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"[\"436991234567\"]"</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"4369912345678"</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddressType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"international"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"informational"</span></span></span></span>,
"<span class="attribute"><span class="attribute">notificationCallbackUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"https://user:pass@myservice.com/myservice/"</span></span></span></span>,
"<span class="attribute"><span class="attribute">clientMessageId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"myUniqueId"</span></span></span></span>,
"<span class="attribute"><span class="attribute">priority</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">5</span></span></span></span>,
"<span class="attribute"><span class="attribute">test</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriode</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">300</span></span></span></span>,
"<span class="attribute"><span class="attribute">sendAsFlashSms</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"example message content"</span></span></span></span>,
"<span class="attribute"><span class="attribute">maxSmsPerMessage</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">1</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"default"</span></span></span></span>,
"<span class="attribute"><span class="attribute">pushParameters</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">additionalPushParameters</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">2000</td>
<td class="markdown">
<p>OK - Accepted. The request has been accepted by the network operator.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">2001</td>
<td class="markdown">
<p>OK - Queued. Request with multiple recipients has been queued for immediate delivery.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4001</td>
<td class="markdown">
<p>ERR - Invalid Credentials. Inactive account or customer.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4002</td>
<td class="markdown">
<p>ERR - Invalid Recipients. One or more recipients are not in the correct format or contain invalid msisdns (i.e: 436761234567).</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4003</td>
<td class="markdown">
<p>ERR - Invalid Sender. Sender address or type is invalid.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4008</td>
<td class="markdown">
<p>ERR - Invalid clientMessageId.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4009</td>
<td class="markdown">
<p>ERR - Message text (messageContent) is invalid</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4013</td>
<td class="markdown">
<p>ERR - Message limit is reached.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4014</td>
<td class="markdown">
<p>ERR - Sender IP address is not authorized.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4015</td>
<td class="markdown">
<p>ERR - Invalid message priority.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4016</td>
<td class="markdown">
<p>ERR - Invalid COD ReturnAddress (notificationCallbackUrl)</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4019</td>
<td class="markdown">
<p>ERR - A required parameter was not given. The parameter name is shown in the statusMessage</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4021</td>
<td class="markdown">
<p>ERR - Invalid account.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4022</td>
<td class="markdown">
<p>ERR - Access to the API was denied.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4023</td>
<td class="markdown">
<p>ERR - Request limit exceeded for this IP address</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4025</td>
<td class="markdown">
<p>ERR - Recipients amount over limit. A maximum of 50 recipients per message is allowed in a single request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4026</td>
<td class="markdown">
<p>ERR - MaxSmsPerMessage exceeded. SMS amount limit per message was hit.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4040</td>
<td class="markdown">
<p>ERR - Invalid contentCategory.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">4041</td>
<td class="markdown">
<p>ERR - Invalid validityPeriode. A minimum of 60 seconds is allowed</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">5000</td>
<td class="markdown">
<p>ERR - Internal error. Please contact support.</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">5003</td>
<td class="markdown">
<p>ERR - The service is currently not available</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.43113079688252376">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.43113079688252376"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7270417614566331">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7270417614566331">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mclientMessageId0.6534889280057481">clientMessageId</label></td>
<td>
<input class="parameter" minlength="0" name="clientMessageId" placeholder="" id="mclientMessageId0.6534889280057481" type="text" value="">
</td>
<td class="markdown">
<p><em>Optional.</em> May contain a freely definable message id.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mmaxSmsPerMessage0.36257506278225726">maxSmsPerMessage</label></td>
<td>
<input class="parameter" minlength="0" name="maxSmsPerMessage" placeholder="" id="mmaxSmsPerMessage0.36257506278225726" type="text" value="1">
</td>
<td class="markdown">
<p><em>Optional.</em> Specifies the maximum number of SMS to be generated. If the system generates more than this number of SMS, the status code 4026 is returned. The default value is <code>0</code>.If set to <code>0</code>, no limitation
is applied.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mnotificationCallbackUrl0.14831939835716024">notificationCallbackUrl</label></td>
<td>
<input class="parameter" minlength="0" name="notificationCallbackUrl" placeholder="" id="mnotificationCallbackUrl0.14831939835716024" type="text" value="">
</td>
<td class="markdown">
<p><em>Optional.</em> When setting a notificationCallbackUrl all delivery reports are forwarded to this URL.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpriority0.0016057667795918995">priority</label></td>
<td>
<input class="parameter" minlength="0" name="priority" placeholder="" id="mpriority0.0016057667795918995" type="text" value="">
</td>
<td class="markdown">
<p><em>Optional.</em> Priority of the message. Must not exceed the value configured for the account used to send the message. For more information please contact our customer service.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msendAsFlashSms0.7394337684540984">sendAsFlashSms</label></td>
<td>
<input class="parameter" minlength="0" name="sendAsFlashSms" placeholder="" id="msendAsFlashSms0.7394337684540984" type="text" value="false">
</td>
<td class="markdown">
<p><em>Optional.</em> <code>true</code>: The message is sent as flash SMS (displayed directly on the screen of the mobile phone). <code>false</code> (default): The message is sent as standard text SMS </p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msenderAddress0.9086787174426807">senderAddress</label></td>
<td>
<input class="parameter" minlength="0" name="senderAddress" placeholder="" id="msenderAddress0.9086787174426807" type="text" value="">
</td>
<td class="markdown">
<p><em>Optional.</em> Address of the sender (assigned to the account) from which the message is sent.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msenderAddressType0.12555279110222384">senderAddressType</label></td>
<td>
<select class="parameter " name="senderAddressType" id="msenderAddressType0.12555279110222384">
<option selected="" value=""></option>
<option value="national"> national </option>
<option value="international"> international </option>
<option value="alphanumeric"> alphanumeric </option>
<option value="shortcode"> shortcode </option>
</select>
</td>
<td class="markdown">
<p><em>Optional.</em> The sender address type. The following address types are supported: <code>national</code>, <code>international</code>, <code>alphanumeric</code> or <code>shortcode</code>).</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mcontentCategory0.5119772823606836">contentCategory</label></td>
<td>
<select class="parameter " name="contentCategory" id="mcontentCategory0.5119772823606836">
<option selected="" value=""></option>
<option value="informational"> informational </option>
<option value="advertisement"> advertisement </option>
</select>
</td>
<td class="markdown">
<p><em>Optional.</em> The content category that is used to categorize the message (used for blacklisting). The following content categories are supported: <code>informational</code> or <code>advertisement</code>. If no content category is
provided, the default setting is used (may be changed inside the onlinesms web interface).</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mtest0.8306426146210035">test</label></td>
<td>
<input class="parameter" minlength="0" name="test" placeholder="" id="mtest0.8306426146210035" type="text" value="false">
</td>
<td class="markdown">
<p><em>Optional.</em> <code>true</code>: The transmission is only simulated, no SMS is sent. Depending on the number of recipients the status code 2000 or 2001 is returned. <code>false</code> (default): No simulation is done. The SMS is
sent via the SMS Gateway.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required"><label for="mrecipientAddressList0.44747053706153195">recipientAddressList</label></td>
<td>
<textarea class="body-textarea required" name="recipientAddressList" id="mrecipientAddressList0.44747053706153195" placeholder="Provide multiple values in new lines (at least one required)."></textarea>
</td>
<td>
<strong><span class="markdown">
<p>List of recipients (E164 formatted MSISDNs - see Wikipedia en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The list of recipients may contains a mamiumum of 1000 entries.</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">Array[string]</span></td>
</tr>
<tr>
<td class="code required"><label for="mmessageContent0.34439537730355085">messageContent</label></td>
<td>
<input class="parameter required" minlength="1" name="messageContent" placeholder="(required)" id="mmessageContent0.34439537730355085" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p><code>Latin1</code> URL-encoded message content</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mmessageType0.9017530259575897">messageType</label></td>
<td>
<select class="parameter " name="messageType" id="mmessageType0.9017530259575897">
<option selected="" value=""></option>
<option value="default"> default </option>
<option value="voice"> voice </option>
</select>
</td>
<td class="markdown">
<p><em>Optional.</em> Specifies the message type. Allowed values are <code>default</code> and <code>voice</code>. When using the message type <code>default</code>, the outgoing message type is determined based on account settings. Using the
message type <code>voice</code> triggers a voice call.</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mvalidityPeriode0.5152714854076035">validityPeriode</label></td>
<td>
<input class="parameter" minlength="0" name="validityPeriode" placeholder="" id="mvalidityPeriode0.5152714854076035" type="text" value="">
</td>
<td class="markdown">
<p><em>Optional.</em> Specifies the validity periode (in seconds) in which the message is tried to be delivered to the recipient. A minimum of 1 minute and a maximum of 3 days are allowed.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.528470856984915">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.528470856984915"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7104639377743798">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7104639377743798">
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mclientMessageId0.7670639711277532">clientMessageId</label></td>
<td>
<input class="parameter" minlength="0" name="clientMessageId" placeholder="" id="mclientMessageId0.7670639711277532" type="text" value="">
</td>
<td class="markdown">
<p><em>Optional.</em> May contain a freely definable message id.</p>
</td>
<td>formData</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mmaxSmsPerMessage0.06256497303991759">maxSmsPerMessage</label></td>
<td>
<input class="parameter" minlength="0" name="maxSmsPerMessage" placeholder="" id="mmaxSmsPerMessage0.06256497303991759" type="text" value="1">
</td>
<td class="markdown">
<p><em>Optional.</em> Specifies the maximum number of SMS to be generated. If the system generates more than this number of SMS, the status code 4026 is returned. The default value is <code>0</code>.If set to <code>0</code>, no limitation
is applied.</p>
</td>
<td>formData</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mnotificationCallbackUrl0.20748613458941567">notificationCallbackUrl</label></td>
<td>
<input class="parameter" minlength="0" name="notificationCallbackUrl" placeholder="" id="mnotificationCallbackUrl0.20748613458941567" type="text" value="">
</td>
<td class="markdown">
<p><em>Optional.</em> When setting a notificationCallbackUrl all delivery reports are forwarded to this URL.</p>
</td>
<td>formData</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpriority0.768876769719828">priority</label></td>
<td>
<input class="parameter" minlength="0" name="priority" placeholder="" id="mpriority0.768876769719828" type="text" value="">
</td>
<td class="markdown">
<p><em>Optional.</em> Priority of the message. Must not exceed the value configured for the account used to send the message. For more information please contact our customer service.</p>
</td>
<td>formData</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msendAsFlashSms0.5191435732514544">sendAsFlashSms</label></td>
<td>
<input class="parameter" minlength="0" name="sendAsFlashSms" placeholder="" id="msendAsFlashSms0.5191435732514544" type="text" value="false">
</td>
<td class="markdown">
<p><em>Optional.</em> <code>true</code>: The message is sent as flash SMS (displayed directly on the screen of the mobile phone). <code>false</code> (default): The message is sent as standard text SMS </p>
</td>
<td>formData</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msenderAddress0.2910152721102437">senderAddress</label></td>
<td>
<input class="parameter" minlength="0" name="senderAddress" placeholder="" id="msenderAddress0.2910152721102437" type="text" value="">
</td>
<td class="markdown">
<p><em>Optional.</em> Address of the sender (assigned to the account) from which the message is sent.</p>
</td>
<td>formData</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msenderAddressType0.6248005238603964">senderAddressType</label></td>
<td>
<select class="parameter " name="senderAddressType" id="msenderAddressType0.6248005238603964">
<option selected="" value=""></option>
<option value="national"> national </option>
<option value="international"> international </option>
<option value="alphanumeric"> alphanumeric </option>
<option value="shortcode"> shortcode </option>
</select>
</td>
<td class="markdown">
<p><em>Optional.</em> The sender address type. The following address types are supported: <code>national</code>, <code>international</code>, <code>alphanumeric</code> or <code>shortcode</code>).</p>
</td>
<td>formData</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mcontentCategory0.9020281173710676">contentCategory</label></td>
<td>
<select class="parameter " name="contentCategory" id="mcontentCategory0.9020281173710676">
<option selected="" value=""></option>
<option value="informational"> informational </option>
<option value="advertisement"> advertisement </option>
</select>
</td>
<td class="markdown">
<p><em>Optional.</em> The content category that is used to categorize the message (used for blacklisting). The following content categories are supported: <code>informational</code> or <code>advertisement</code>. If no content category is
provided, the default setting is used (may be changed inside the onlinesms web interface).</p>
</td>
<td>formData</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mtest0.588057271665205">test</label></td>
<td>
<input class="parameter" minlength="0" name="test" placeholder="" id="mtest0.588057271665205" type="text" value="false">
</td>
<td class="markdown">
<p><em>Optional.</em> <code>true</code>: The transmission is only simulated, no SMS is sent. Depending on the number of recipients the status code 2000 or 2001 is returned. <code>false</code> (default): No simulation is done. The SMS is
sent via the SMS Gateway.</p>
</td>
<td>formData</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required"><label for="mrecipientAddressList0.9475170971785207">recipientAddressList</label></td>
<td>
<textarea class="body-textarea required" name="recipientAddressList" id="mrecipientAddressList0.9475170971785207" placeholder="Provide multiple values in new lines (at least one required)."></textarea>
</td>
<td>
<strong><span class="markdown">
<p>List of recipients (E164 formatted MSISDNs - see Wikipedia en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The list of recipients may contains a mamiumum of 1000 entries.</p>
</span></strong>
</td>
<td>formData</td>
<td><span class="model-signature">Array[string]</span></td>
</tr>
<tr>
<td class="code required"><label for="mmessageContent0.7633730591533949">messageContent</label></td>
<td>
<input class="parameter required" minlength="1" name="messageContent" placeholder="(required)" id="mmessageContent0.7633730591533949" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p><code>Latin1</code> URL-encoded message content</p>
</span></strong>
</td>
<td>formData</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mmessageType0.5913355799501172">messageType</label></td>
<td>
<select class="parameter " name="messageType" id="mmessageType0.5913355799501172">
<option selected="" value=""></option>
<option value="default"> default </option>
<option value="voice"> voice </option>
</select>
</td>
<td class="markdown">
<p><em>Optional.</em> Specifies the message type. Allowed values are <code>default</code> and <code>voice</code>. When using the message type <code>default</code>, the outgoing message type is determined based on account settings. Using the
message type <code>voice</code> triggers a voice call.</p>
</td>
<td>formData</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mvalidityPeriode0.8463050074535603">validityPeriode</label></td>
<td>
<input class="parameter" minlength="0" name="validityPeriode" placeholder="" id="mvalidityPeriode0.8463050074535603" type="text" value="">
</td>
<td class="markdown">
<p><em>Optional.</em> Specifies the validity periode (in seconds) in which the message is tried to be delivered to the recipient. A minimum of 1 minute and a maximum of 3 days are allowed.</p>
</td>
<td>formData</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.679094107253821">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.679094107253821"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4082777147295782">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4082777147295782">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">BinarySmsSendRequest {</span>
<div><span class="propName required">recipientAddressList</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>List of recipients (E164 formatted MSISDNs - see Wikipedia en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The list of recipients may contain a maximum of 1000 entries.</p>
</span>,</div>
<div><span class="propName ">senderAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Address of the sender (assigned to the account) from which the message is sent.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">senderAddressType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> The sender address type. The following address types are supported: <code>national</code>, <code>international</code>, <code>alphanumeric</code> or <code>shortcode</code>).</p>
</span> = <span class="propVals">['national', 'international', 'alphanumeric', 'shortcode']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"national", "international", "alphanumeric", "shortcode"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> The content category that is used to categorize the message (used for blacklisting). The following content categories are supported: <code>informational</code> or <code>advertisement</code>. If no
content category is provided, the default setting is used (may be changed inside the onlinesms web interface).</p>
</span> = <span class="propVals">['informational', 'advertisement']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"informational", "advertisement"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">notificationCallbackUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> When setting a notificationCallbackUrl all delivery reports are forwarded to this URL.</p>
</span>,</div>
<div><span class="propName ">clientMessageId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> May contain a freely definable message id.</p>
</span>,</div>
<div><span class="propName ">priority</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Priority of the message. Must not exceed the value configured for the account used to send the message. For more information please contact our customer service.</p>
</span>,</div>
<div><span class="propName ">test</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> <code>true</code>: The transmission is only simulated, no SMS is sent. Depending on the number of recipients the status code 2000 or 2001 is returned. <code>false</code> (default): No simulation is
done. The SMS is sent via the SMS Gateway.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">validityPeriode</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Specifies the validity periode (in seconds) in which the message is tried to be delivered to the recipient. A minimum of 1 minute and a maximum of 3 days are allowed.</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>60</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>259200</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">sendAsFlashSms</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> <code>true</code>: The message is sent as flash SMS (displayed directly on the screen of the mobile phone). <code>false</code> (default): The message is sent as standard text SMS </p>
</span>,</div>
<div><span class="propName ">messageContent</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Array of <code>Base64</code> encoded binary data. Every element of the array corresponds to a message segment. The binary data is transmitted without being changed (using 8 bit alphabet)</p>
</span>,</div>
<div><span class="propName ">userDataHeaderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> <code>true</code>: Indicates the presence of a user data header in the messageContent property. <code>false</code> (default): Indicates the absence of a user data header in the messageContent property.
</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">recipientAddressList</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"[\"436991234567\"]"</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"4369912345678"</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddressType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"international"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"informational"</span></span></span></span>,
"<span class="attribute"><span class="attribute">notificationCallbackUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"https://user:pass@myservice.com/myservice/"</span></span></span></span>,
"<span class="attribute"><span class="attribute">clientMessageId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"myUniqueId"</span></span></span></span>,
"<span class="attribute"><span class="attribute">priority</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">5</span></span></span></span>,
"<span class="attribute"><span class="attribute">test</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriode</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">300</span></span></span></span>,
"<span class="attribute"><span class="attribute">sendAsFlashSms</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"[\"SGVsbG8gV29ybGQ=\"]"</span></span></span></span>,
"<span class="attribute"><span class="attribute">userDataHeaderPresent</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.024426896630015626">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.024426896630015626"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7812118560191519">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7812118560191519">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TextSmsSendRequest {</span>
<div><span class="propName required">recipientAddressList</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>List of recipients (E164 formatted MSISDNs - see Wikipedia en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The list of recipients may contain a maximum of 1000 entries.</p>
</span>,</div>
<div><span class="propName ">senderAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Address of the sender (assigned to the account) from which the message is sent.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">senderAddressType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> The sender address type. The following address types are supported: <code>national</code>, <code>international</code>, <code>alphanumeric</code> or <code>shortcode</code>).</p>
</span> = <span class="propVals">['national', 'international', 'alphanumeric', 'shortcode']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"national", "international", "alphanumeric", "shortcode"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> The content category that is used to categorize the message (used for blacklisting). The following content categories are supported: <code>informational</code> or <code>advertisement</code>. If no
content category is provided, the default setting is used (may be changed inside the onlinesms web interface).</p>
</span> = <span class="propVals">['informational', 'advertisement']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"informational", "advertisement"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">notificationCallbackUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> When setting a notificationCallbackUrl all delivery reports are forwarded to this URL.</p>
</span>,</div>
<div><span class="propName ">clientMessageId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> May contain a freely definable message id.</p>
</span>,</div>
<div><span class="propName ">priority</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Priority of the message. Must not exceed the value configured for the account used to send the message. For more information please contact our customer service.</p>
</span>,</div>
<div><span class="propName ">test</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> <code>true</code>: The transmission is only simulated, no SMS is sent. Depending on the number of recipients the status code 2000 or 2001 is returned. <code>false</code> (default): No simulation is
done. The SMS is sent via the SMS Gateway.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">validityPeriode</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Specifies the validity periode (in seconds) in which the message is tried to be delivered to the recipient. A minimum of 1 minute and a maximum of 3 days are allowed.</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>60</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>259200</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">sendAsFlashSms</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> <code>true</code>: The message is sent as flash SMS (displayed directly on the screen of the mobile phone). <code>false</code> (default): The message is sent as standard text SMS </p>
</span>,</div>
<div><span class="propName required">messageContent</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p><code>UTF-8</code> encoded message content</p>
</span>,</div>
<div><span class="propName ">maxSmsPerMessage</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Specifies the maximum number of SMS to be generated. If the system generates more than this number of SMS, the status code 4026 is returned. The default value of this parameter is <code>0</code>.If set
to <code>0</code>, no limitation is applied.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">messageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p><em>Optional.</em> Specifies the message type. Allowed values are <code>default</code> and <code>voice</code>. When using the message type <code>default</code>, the outgoing message type is determined based on account
settings. Using the message type <code>voice</code> triggers a voice call.</p>
</span> = <span class="propVals">['default', 'voice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "voice"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">recipientAddressList</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"[\"436991234567\"]"</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"4369912345678"</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddressType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"international"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"informational"</span></span></span></span>,
"<span class="attribute"><span class="attribute">notificationCallbackUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"https://user:pass@myservice.com/myservice/"</span></span></span></span>,
"<span class="attribute"><span class="attribute">clientMessageId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"myUniqueId"</span></span></span></span>,
"<span class="attribute"><span class="attribute">priority</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">5</span></span></span></span>,
"<span class="attribute"><span class="attribute">test</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriode</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">300</span></span></span></span>,
"<span class="attribute"><span class="attribute">sendAsFlashSms</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"example message content"</span></span></span></span>,
"<span class="attribute"><span class="attribute">maxSmsPerMessage</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">1</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"default"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6393368636646579">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6393368636646579"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7671837023572441">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7671837023572441">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiOptInRequest {</span>
<div><span class="propName ">optInToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>optin token</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group ids</p>
</span>,</div>
<div><span class="propName ">secret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>secret</p>
</span>,</div>
<div><span class="propName ">contact</span> (<span class="propType">OptInContactRequest</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact</p>
</span></div><span class="strong">}</span><br><span class="strong">OptInContactRequest {</span>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>first name</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>last name</p>
</span>,</div>
<div><span class="propName ">nickname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>nickname</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">mobile</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>mobile phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">landline</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>landline phone number</p>
</span>,</div>
<div><span class="propName ">fax</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fax number</p>
</span>,</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email address</p>
</span>,</div>
<div><span class="propName ">birthday</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>birthday</p>
</span>,</div>
<div><span class="propName ">homepage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>homepage</p>
</span>,</div>
<div><span class="propName ">instantMessenger</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>instant messenger user</p>
</span>,</div>
<div><span class="propName ">skype</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skype name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>street</p>
</span>,</div>
<div><span class="propName ">zipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>zip code</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>city</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>country</p>
</span>,</div>
<div><span class="propName ">company</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">department</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>department</p>
</span>,</div>
<div><span class="propName ">bureau</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bureau</p>
</span>,</div>
<div><span class="propName ">jobTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>job title</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">optInToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contact</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">firstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">lastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">nickname</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">landline</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">fax</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthday</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.718Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">homepage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">instantMessenger</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">skype</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">street</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">zipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">city</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">country</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">company</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">department</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bureau</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">jobTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.039056943410432865">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.039056943410432865"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2221662550750234">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2221662550750234">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OptOutRequest {</span>
<div><span class="propName ">optInToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>optin token</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group ids</p>
</span>,</div>
<div><span class="propName ">secret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>secret</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">mobile</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>mobile phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">optInToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.4364562861893173">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4364562861893173"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7036155747908031">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7036155747908031">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OptOutRequest {</span>
<div><span class="propName ">optInToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>optin token</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group ids</p>
</span>,</div>
<div><span class="propName ">secret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>secret</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">mobile</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>mobile phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">optInToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.015353708588963677">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.015353708588963677"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9101577266153746">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9101577266153746">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OptInTokenRequest {</span>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group id</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="moptInToken0.4940853508417211">optInToken</label></td>
<td>
<input class="parameter" minlength="0" name="optInToken" placeholder="" id="moptInToken0.4940853508417211" type="text" value="">
</td>
<td class="markdown">
<p>OptInToken</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.48349652216948735">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.48349652216948735"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7466349517511064">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7466349517511064">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiOptInRequest {</span>
<div><span class="propName ">optInToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>optin token</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group ids</p>
</span>,</div>
<div><span class="propName ">secret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>secret</p>
</span>,</div>
<div><span class="propName ">contact</span> (<span class="propType">OptInContactRequest</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact</p>
</span></div><span class="strong">}</span><br><span class="strong">OptInContactRequest {</span>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>first name</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>last name</p>
</span>,</div>
<div><span class="propName ">nickname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>nickname</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">mobile</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>mobile phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">landline</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>landline phone number</p>
</span>,</div>
<div><span class="propName ">fax</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fax number</p>
</span>,</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email address</p>
</span>,</div>
<div><span class="propName ">birthday</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>birthday</p>
</span>,</div>
<div><span class="propName ">homepage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>homepage</p>
</span>,</div>
<div><span class="propName ">instantMessenger</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>instant messenger user</p>
</span>,</div>
<div><span class="propName ">skype</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skype name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>street</p>
</span>,</div>
<div><span class="propName ">zipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>zip code</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>city</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>country</p>
</span>,</div>
<div><span class="propName ">company</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">department</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>department</p>
</span>,</div>
<div><span class="propName ">bureau</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bureau</p>
</span>,</div>
<div><span class="propName ">jobTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>job title</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">optInToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contact</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">firstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">lastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">nickname</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">landline</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">fax</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthday</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.719Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">homepage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">instantMessenger</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">skype</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">street</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">zipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">city</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">country</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">company</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">department</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bureau</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">jobTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.18416152112835538">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.18416152112835538" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.6717326355421191">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.6717326355421191" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.4637997507875793">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.4637997507875793" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.16683621755496247">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.16683621755496247" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.00866891372939782">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.00866891372939782" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.23770612560148074">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.23770612560148074" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.4470348993216562">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.4470348993216562" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.09180914983992738">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.09180914983992738" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.8782145602911742">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.8782145602911742" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.14808747005210043">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.14808747005210043" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8467547595705889">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8467547595705889" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9337161014730946">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9337161014730946"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.16044753172441073">Parameter content type:</label>
<select name="parameterContentType" id="pct0.16044753172441073">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OutboxMessageRequest {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message content</p>
</span>,</div>
<div><span class="propName ">subject</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>subject</p>
</span>,</div>
<div><span class="propName ">recipients</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>recipient list</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group id list</p>
</span>,</div>
<div><span class="propName ">selectors</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>selectors</p>
</span>,</div>
<div><span class="propName ">sendOn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>send on (now if not specified)</p>
</span>,</div>
<div><span class="propName ">timeSpread</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>time spread in hours</p>
</span>,</div>
<div><span class="propName ">repeat</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat period (hourly, daily, weekly, monthly, yearly)</p>
</span>,</div>
<div><span class="propName ">repeatInterval</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat interval</p>
</span>,</div>
<div><span class="propName ">repeatIterations</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat iterations</p>
</span>,</div>
<div><span class="propName ">repeatEndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat end datetime</p>
</span>,</div>
<div><span class="propName ">deliveryReport</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>request delivery report?</p>
</span>,</div>
<div><span class="propName ">smsType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>SMS type (0 = default, 1 = flash, 2 = both)</p>
</span>,</div>
<div><span class="propName ">predictedSmsCount</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>predicted SMS count</p>
</span>,</div>
<div><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content category (personal, advertisement or informational</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">messageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message type (default, sms, voice, whatsapp</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^(?i)(default|voice|whatsapp)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">attachmentId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attachment id</p>
</span>,</div>
<div><span class="propName ">urlshorteningType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>urlshortening type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">subject</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">recipients</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">selectors</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">sendOn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.751Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timeSpread</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeat</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatInterval</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatIterations</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatEndDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.751Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">deliveryReport</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">smsType</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">predictedSmsCount</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">urlshorteningType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7353066741128136">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7353066741128136" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.13234067602486865">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.13234067602486865" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.4138644529545108">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4138644529545108" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.3419982877881864">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3419982877881864"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.40065951542380707">Parameter content type:</label>
<select name="parameterContentType" id="pct0.40065951542380707">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OutboxMessageRequest {</span>
<div><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message content</p>
</span>,</div>
<div><span class="propName ">subject</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>subject</p>
</span>,</div>
<div><span class="propName ">recipients</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>recipient list</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group id list</p>
</span>,</div>
<div><span class="propName ">selectors</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>selectors</p>
</span>,</div>
<div><span class="propName ">sendOn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>send on (now if not specified)</p>
</span>,</div>
<div><span class="propName ">timeSpread</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>time spread in hours</p>
</span>,</div>
<div><span class="propName ">repeat</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat period (hourly, daily, weekly, monthly, yearly)</p>
</span>,</div>
<div><span class="propName ">repeatInterval</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat interval</p>
</span>,</div>
<div><span class="propName ">repeatIterations</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat iterations</p>
</span>,</div>
<div><span class="propName ">repeatEndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>repeat end datetime</p>
</span>,</div>
<div><span class="propName ">deliveryReport</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>request delivery report?</p>
</span>,</div>
<div><span class="propName ">smsType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>SMS type (0 = default, 1 = flash, 2 = both)</p>
</span>,</div>
<div><span class="propName ">predictedSmsCount</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>predicted SMS count</p>
</span>,</div>
<div><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content category (personal, advertisement or informational</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">messageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message type (default, sms, voice, whatsapp</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^(?i)(default|voice|whatsapp)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">attachmentId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attachment id</p>
</span>,</div>
<div><span class="propName ">urlshorteningType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>urlshortening type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">subject</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">recipients</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">selectors</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">sendOn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.751Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timeSpread</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeat</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatInterval</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatIterations</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">repeatEndDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.751Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">deliveryReport</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">smsType</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">predictedSmsCount</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">attachmentId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">urlshorteningType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.2090664237405666">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.2090664237405666"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3870718794982235">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3870718794982235">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.40505945306968405">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.40505945306968405" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.007016798184390272">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.007016798184390272" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.008818541850706518">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.008818541850706518" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9163163173575546">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9163163173575546"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.09502046018378385">Parameter content type:</label>
<select name="parameterContentType" id="pct0.09502046018378385">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CcPaymentAuthorizationRequest {</span>
<div><span class="propWrap"><span class="propName ">provider</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(saferpay)$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">frameAncestor</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>frameAncestor</p>
</span>,</div>
<div><span class="propName ">successRedirectUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>successRedirectUrl</p>
</span>,</div>
<div><span class="propName ">failRedirectUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>failRedirectUrl</p>
</span>,</div>
<div><span class="propName ">cancelRedirectUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>cancelRedirectUrl</p>
</span>,</div>
<div><span class="propName ">attempThreeD</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>attempThreeD</p>
</span>,</div>
<div><span class="propName ">spaForward</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>spaForward</p>
</span>,</div>
<div><span class="propName ">shoppingCart</span> (<span class="propType">ShoppingCartRequest</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>shopping cart</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">flow</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>flow</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(bpwebreg|contract_payment|contract_upgrade)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">orderId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>orderId</p>
</span>,</div>
<div><span class="propName ">siteId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>site id (1 = Austria, 2 = Germany, 3 = Switzerland, 4 = Italy, 5 = Linkmobility Germany, 6 = Linkmobility SSU Germany, 7 = Linkmobility SSU Austria, 8 = Linkmobility SSU Switzerland</p>
</span>,</div>
<div><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">payload</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>payload</p>
</span>,</div>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>firstName</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>lastName</p>
</span>,</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>emailAddress</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>city</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>country</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>street</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>postalCode</p>
</span>,</div>
<div><span class="propName ">saferpayFieldsToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>saferpayFieldsToken</p>
</span></div><span class="strong">}</span><br><span class="strong">ShoppingCartRequest {</span>
<div><span class="propWrap"><span class="propName ">basePackage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>base package</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">addonPackages</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>addon packages</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">paymentPlan</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(yearly|monthly|null)$</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">provider</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">frameAncestor</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">successRedirectUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">failRedirectUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">cancelRedirectUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">attempThreeD</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">spaForward</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">shoppingCart</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">basePackage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">addonPackages</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">paymentPlan</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">flow</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">orderId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">siteId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">payload</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">firstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">lastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">city</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">country</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">street</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">postalCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">saferpayFieldsToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.242483620296446">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.242483620296446"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.0154167501598228">Parameter content type:</label>
<select name="parameterContentType" id="pct0.0154167501598228">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CcPaymentRetrieveRequest {</span>
<div><span class="propName ">token</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">nonce</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">token</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">nonce</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mredirectToken0.824457308865667">redirectToken</label></td>
<td>
<input class="parameter" minlength="0" name="redirectToken" placeholder="" id="mredirectToken0.824457308865667" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>successful operation</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mredirectToken0.4608206400874888">redirectToken</label></td>
<td>
<input class="parameter" minlength="0" name="redirectToken" placeholder="" id="mredirectToken0.4608206400874888" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>successful operation</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7295232520009218">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7295232520009218" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.052809249261971614">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.052809249261971614" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.732491809914702">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.732491809914702" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.513853391485789">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.513853391485789"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7563217279671748">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7563217279671748">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.8008728693594771">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.8008728693594771">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.22146799226654168">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.22146799226654168" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.17309452793629077">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.17309452793629077" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.7029346568975254">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.7029346568975254" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.43589245801149357">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.43589245801149357" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.9084814995174657">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.9084814995174657" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.5037674983483447">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.5037674983483447" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.8485128095520917">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8485128095520917" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.560757258213137">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.560757258213137" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.25163604027151165">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.25163604027151165"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.17135605622217764">Parameter content type:</label>
<select name="parameterContentType" id="pct0.17135605622217764">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactRequest {</span>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>first name</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>last name</p>
</span>,</div>
<div><span class="propName ">nickname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>nickname</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mobile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>mobile phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">landline</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>landline phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,20}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">fax</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fax number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,20}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email address</p>
</span>,</div>
<div><span class="propName ">birthday</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>birthday</p>
</span>,</div>
<div><span class="propName ">homepage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>homepage</p>
</span>,</div>
<div><span class="propName ">instantMessenger</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>instant messenger user</p>
</span>,</div>
<div><span class="propName ">skype</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skype name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>street</p>
</span>,</div>
<div><span class="propName ">zipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>zip code</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>city</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>country</p>
</span>,</div>
<div><span class="propName ">company</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">department</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>department</p>
</span>,</div>
<div><span class="propName ">bureau</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bureau</p>
</span>,</div>
<div><span class="propName ">jobTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>job title</p>
</span>,</div>
<div><span class="propName ">remoteSmsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS enabled?</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">whatsapp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whatsapp recipient</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">firstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">lastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">nickname</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">landline</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">fax</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthday</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">homepage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">instantMessenger</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">skype</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">street</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">zipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">city</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">country</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">company</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">department</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bureau</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">jobTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3565177927162684">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3565177927162684" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.36091422730469125">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.36091422730469125" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9296707404880988">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9296707404880988" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.11075428896836037">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.11075428896836037"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5112847385979866">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5112847385979866">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactRequest {</span>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>first name</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>last name</p>
</span>,</div>
<div><span class="propName ">nickname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>nickname</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mobile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>mobile phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">landline</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>landline phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,20}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">fax</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fax number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,20}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email address</p>
</span>,</div>
<div><span class="propName ">birthday</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>birthday</p>
</span>,</div>
<div><span class="propName ">homepage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>homepage</p>
</span>,</div>
<div><span class="propName ">instantMessenger</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>instant messenger user</p>
</span>,</div>
<div><span class="propName ">skype</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skype name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>street</p>
</span>,</div>
<div><span class="propName ">zipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>zip code</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>city</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>country</p>
</span>,</div>
<div><span class="propName ">company</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">department</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>department</p>
</span>,</div>
<div><span class="propName ">bureau</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bureau</p>
</span>,</div>
<div><span class="propName ">jobTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>job title</p>
</span>,</div>
<div><span class="propName ">remoteSmsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS enabled?</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">whatsapp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whatsapp recipient</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">firstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">lastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">nickname</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">landline</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">fax</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthday</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">homepage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">instantMessenger</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">skype</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">street</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">zipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">city</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">country</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">company</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">department</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bureau</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">jobTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.24916690192071878">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.24916690192071878"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6432507416186874">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6432507416186874">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mfile0.4362879307137606">file</label></td>
<td>
<input type="file" name="file" id="mfile0.4362879307137606">
<div class="parameter-content-type"></div>
</td>
<td class="markdown"></td>
<td>formData</td>
<td>
<span class="model-signature">undefined</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.45805744055321873">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.45805744055321873" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6638839608768285">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6638839608768285" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.20587919018946188">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.20587919018946188" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.16034096679380427">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.16034096679380427" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8489072441007308">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8489072441007308" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3425750365247999">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3425750365247999" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.38182684554433055">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.38182684554433055" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5206353543864242">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5206353543864242" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.38092901080213326">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.38092901080213326"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9068823270476583">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9068823270476583">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ImportContactRequestDto {</span>
<div><span class="propName ">importFileId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>import file id</p>
</span>,</div>
<div><span class="propName ">fieldMapping</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fields to import file column mapping</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact groups to assign</p>
</span>,</div>
<div><span class="propName ">charset</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>override detected charset</p>
</span>,</div>
<div><span class="propName ">delimiter</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>override detected delimiter</p>
</span>,</div>
<div><span class="propName ">skipFirstRow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skip first row</p>
</span>,</div>
<div><span class="propName ">continueOnError</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>continue on error</p>
</span>,</div>
<div><span class="propName ">ignoreExistingContacts</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>don't touch existing contacts</p>
</span>,</div>
<div><span class="propName ">ignoreEmptyContacts</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>don't import empty contacts (containing no recipients</p>
</span>,</div>
<div><span class="propName ">mergeContactGroupIds</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whether to merge or delete existing group membership</p>
</span>,</div>
<div><span class="propName ">dryRun</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>dry run</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">duplicateCheckField</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whether to check for mobile or whatsapp duplicates</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^(?i)(mobile|whatsapp)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">importFileId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">fieldMapping</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">charset</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">delimiter</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">skipFirstRow</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">continueOnError</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">ignoreExistingContacts</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">ignoreEmptyContacts</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">mergeContactGroupIds</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">dryRun</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">duplicateCheckField</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.16703231792602424">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.16703231792602424">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mformat0.42321645195628776">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.42321645195628776" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.1340925214953217">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.1340925214953217" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.42752688549111273">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.42752688549111273" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.07791013620721343">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.07791013620721343" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.4118984494986564">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.4118984494986564" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.17177213335845454">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.17177213335845454" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.8733190410068981">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.8733190410068981" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.9049726915333844">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.9049726915333844" type="text" value="+name">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.8587553051185615">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8587553051185615" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5322285176111026">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5322285176111026" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6909537315242433">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6909537315242433" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8526133819139299">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8526133819139299" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.4376880066412496">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4376880066412496" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.06975464239359175">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.06975464239359175" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5489653969176587">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5489653969176587" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.2901838004969852">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.2901838004969852" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.1371420138005186">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.1371420138005186" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.059333022162500804">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.059333022162500804" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.6019021968971323">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.6019021968971323" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9778617123064872">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9778617123064872" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.2855624448192353">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.2855624448192353" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.9783378926815949">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9783378926815949"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7442749614468669">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7442749614468669">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.7561383868723843">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.7561383868723843">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.036637506891191496">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.036637506891191496" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.0281974387974">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.0281974387974" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9086785424677657">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9086785424677657" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.9258105621805164">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.9258105621805164" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.14037340425950284">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.14037340425950284" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.044955162177349406">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.044955162177349406" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.5572669356866267">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.5572669356866267" type="text" value="+name">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.0010620005806836197">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.0010620005806836197" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.17638620197408117">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.17638620197408117" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.5871439116285837">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5871439116285837"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5190978780743933">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5190978780743933">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactGroupRequest {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>group name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">birthdayTemplateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message template used for birthday messages</p>
</span>,</div>
<div><span class="propName ">remoteSmsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS enabled?</p>
</span>,</div>
<div><span class="propName ">remoteSmsShortcut</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS shortcut</p>
</span>,</div>
<div><span class="propName ">remoteSmsTemplateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message template used for remote SMS</p>
</span>,</div>
<div><span class="propName ">welcomeSmsContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome sms content</p>
</span>,</div>
<div><span class="propName ">welcomeSmsActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome sms active?</p>
</span>,</div>
<div><span class="propName ">goodbyeSmsContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye sms content</p>
</span>,</div>
<div><span class="propName ">goodbyeSmsActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye sms active?</p>
</span>,</div>
<div><span class="propName ">welcomeWhatsappContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome whatsapp content</p>
</span>,</div>
<div><span class="propName ">welcomeWhatsappActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome whatsapp active?</p>
</span>,</div>
<div><span class="propName ">goodbyeWhatsappContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye whatsapp content</p>
</span>,</div>
<div><span class="propName ">goodbyeWhatsappActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye whatsapp active?</p>
</span>,</div>
<div><span class="propName ">mobile</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is sms/voice/push group?</p>
</span>,</div>
<div><span class="propName ">whatsapp</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is whatsapp group?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthdayTemplateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsShortcut</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsTemplateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeSmsContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeSmsActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeSmsContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeSmsActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeWhatsappContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeWhatsappActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeWhatsappContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeWhatsappActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.13456920561018793">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.13456920561018793" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.10945477098787282">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.10945477098787282" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.46047154927481726">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.46047154927481726" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.5837488374898856">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5837488374898856"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3862524312209781">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3862524312209781">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactGroupRequest {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>group name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">birthdayTemplateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message template used for birthday messages</p>
</span>,</div>
<div><span class="propName ">remoteSmsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS enabled?</p>
</span>,</div>
<div><span class="propName ">remoteSmsShortcut</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS shortcut</p>
</span>,</div>
<div><span class="propName ">remoteSmsTemplateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message template used for remote SMS</p>
</span>,</div>
<div><span class="propName ">welcomeSmsContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome sms content</p>
</span>,</div>
<div><span class="propName ">welcomeSmsActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome sms active?</p>
</span>,</div>
<div><span class="propName ">goodbyeSmsContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye sms content</p>
</span>,</div>
<div><span class="propName ">goodbyeSmsActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye sms active?</p>
</span>,</div>
<div><span class="propName ">welcomeWhatsappContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome whatsapp content</p>
</span>,</div>
<div><span class="propName ">welcomeWhatsappActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>welcome whatsapp active?</p>
</span>,</div>
<div><span class="propName ">goodbyeWhatsappContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye whatsapp content</p>
</span>,</div>
<div><span class="propName ">goodbyeWhatsappActive</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>goodbye whatsapp active?</p>
</span>,</div>
<div><span class="propName ">mobile</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is sms/voice/push group?</p>
</span>,</div>
<div><span class="propName ">whatsapp</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is whatsapp group?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthdayTemplateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsShortcut</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsTemplateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeSmsContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeSmsActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeSmsContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeSmsActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeWhatsappContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">welcomeWhatsappActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeWhatsappContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">goodbyeWhatsappActive</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9883601813281886">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9883601813281886" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mquery0.6498507894639929">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.6498507894639929" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.11233766945002044">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.11233766945002044" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.035528222222039885">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.035528222222039885" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.31738071549369984">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.31738071549369984" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.3720013845248471">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3720013845248471"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.33444242605722607">Parameter content type:</label>
<select name="parameterContentType" id="pct0.33444242605722607">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8897501652748414">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8897501652748414" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.48852142476031823">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.48852142476031823" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.04433379763958323">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.04433379763958323"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4540369288449533">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4540369288449533">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PurgeContactGroupRequest {</span>
<div><span class="propName ">exclusiveOnly</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>delete only contacts exclusive in this group</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">exclusiveOnly</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6569915808097877">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6569915808097877" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.7391368784603667">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.7391368784603667" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mquery0.01668821878124338">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.01668821878124338" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.6693127661992395">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.6693127661992395" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.4354022711481986">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.4354022711481986" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8963861312216137">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8963861312216137" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.7411808934489208">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.7411808934489208" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.9562210413853023">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.9562210413853023" type="text" value="-id">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.538669252659691">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.538669252659691" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.7275094457156932">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.7275094457156932" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.955916317429724">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.955916317429724"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.15174493937254607">Parameter content type:</label>
<select name="parameterContentType" id="pct0.15174493937254607">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactGroupMembershipRequest {</span>
<div><span class="propName required">contactGroupId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>contact group id</p>
</span>,</div>
<div><span class="propName required">contactId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>contact id</p>
</span>,</div>
<div><span class="propName ">mobile</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is sms/voice/push group?</p>
</span>,</div>
<div><span class="propName ">whatsapp</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is whatsapp group?</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contactGroupId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7229039006311764">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7229039006311764"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.16914170804760387">Parameter content type:</label>
<select name="parameterContentType" id="pct0.16914170804760387">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CopyContactGroupMembershipsRequest {</span>
<div><span class="propName ">sourceIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>source contact group ids</p>
</span>,</div>
<div><span class="propName ">targetId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target contact group id</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">sourceIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">targetId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.27527239248056556">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.27527239248056556" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.07468660217381928">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.07468660217381928" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5531490755437987">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5531490755437987" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.19247154650644682">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.19247154650644682"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4343357945185575">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4343357945185575">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PurgeContactGroupMembershipRequest {</span>
<div><span class="propName ">exclusiveOnly</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>delete only contacts exclusive in this group</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">exclusiveOnly</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7874373554977585">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7874373554977585"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.47460822507561695">Parameter content type:</label>
<select name="parameterContentType" id="pct0.47460822507561695">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AddContactGroupMembershipsRequest {</span>
<div><span class="propName ">contactIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>source contact ids</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target contact group id</p>
</span>,</div>
<div><span class="propName ">deleteExisting</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whether to delete exiting memberships for the contacts</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contactIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">deleteExisting</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9903846270913292">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9903846270913292"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.10593605299401831">Parameter content type:</label>
<select name="parameterContentType" id="pct0.10593605299401831">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.3974508107661554">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.3974508107661554" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mcompanyName0.8728755936219443">companyName</label></td>
<td>
<input class="parameter" minlength="0" name="companyName" placeholder="" id="mcompanyName0.8728755936219443" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mmsisdn0.1453737618639217">msisdn</label></td>
<td>
<input class="parameter" minlength="0" name="msisdn" placeholder="" id="mmsisdn0.1453737618639217" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfileName0.9279828303714068">fileName</label></td>
<td>
<input class="parameter" minlength="0" name="fileName" placeholder="" id="mfileName0.9279828303714068" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.8398927981623792">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.8398927981623792" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.95878128320061">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.95878128320061"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.010233582090255933">Parameter content type:</label>
<select name="parameterContentType" id="pct0.010233582090255933">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RequestIdentityTokenRequestDto {</span>
<div><span class="propWrap"><span class="propName ">identityType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>identity type</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(msisdn)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>value (e.g. msisdn)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+?[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">identityType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">value</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.3706723437470987">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.3706723437470987" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6532692309809953">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6532692309809953"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9758768434522529">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9758768434522529">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConfirmIdentityTokenRequestDto {</span>
<div><span class="propName ">identityToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>identity token</p>
</span>,</div>
<div><span class="propName ">secret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>secret</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">identityToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.3288913912631217">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.3288913912631217" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8462987594240385">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8462987594240385"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2661420829755168">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2661420829755168">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">InitiateOptInRequestDto {</span>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group ids</p>
</span>,</div>
<div><span class="propName ">contact</span> (<span class="propType">InitiateOptInContactRequest</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact</p>
</span>,</div>
<div><span class="propName ">optinChannels</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>channels</p>
</span>,</div>
<div><span class="propName ">termsAndConditions</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>terms and conditions</p>
</span>,</div>
<div><span class="propName ">acceptTermsAndConditions</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>accept terms and conditions?</p>
</span></div><span class="strong">}</span><br><span class="strong">InitiateOptInContactRequest {</span>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>title</p>
</span>,</div>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>first name</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>last name</p>
</span>,</div>
<div><span class="propName ">nickname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>nickname</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">mobile</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>mobile phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+?[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">landline</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>landline phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,20}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">fax</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fax number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,20}</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email address</p>
</span>,</div>
<div><span class="propName ">birthday</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>birthday</p>
</span>,</div>
<div><span class="propName ">homepage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>homepage</p>
</span>,</div>
<div><span class="propName ">instantMessenger</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>instant messenger user</p>
</span>,</div>
<div><span class="propName ">skype</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>skype name</p>
</span>,</div>
<div><span class="propName ">remarks</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>custom remarks</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>street</p>
</span>,</div>
<div><span class="propName ">zipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>zip code</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>city</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>country</p>
</span>,</div>
<div><span class="propName ">company</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">department</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>department</p>
</span>,</div>
<div><span class="propName ">bureau</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bureau</p>
</span>,</div>
<div><span class="propName ">jobTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>job title</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">whatsapp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>whatsapp recipient</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+?[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contact</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">firstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">lastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">nickname</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">landline</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">fax</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthday</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.726Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">homepage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">instantMessenger</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">skype</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">remarks</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">street</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">zipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">city</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">country</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">company</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">department</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bureau</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">jobTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">optinChannels</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">termsAndConditions</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">acceptTermsAndConditions</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.9003818231157179">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.9003818231157179" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.3892572402311185">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.3892572402311185" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="moptInId0.39245945364672696">optInId</label></td>
<td>
<input class="parameter required" minlength="1" name="optInId" placeholder="(required)" id="moptInId0.39245945364672696" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.038809361644652984">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.038809361644652984"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5184386248093145">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5184386248093145">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UpdateSmsOptInRequestDto {</span>
<div><span class="propWrap"><span class="propName required">mobile</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>mobile phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+?[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.8542273960036959">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.8542273960036959" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="moptInId0.7483359358842057">optInId</label></td>
<td>
<input class="parameter required" minlength="1" name="optInId" placeholder="(required)" id="moptInId0.7483359358842057" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.4614003219438434">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4614003219438434"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7142658716890782">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7142658716890782">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UpdateWhatsappOptInRequestDto {</span>
<div><span class="propWrap"><span class="propName required">whatsapp</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>whatsapp number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+?[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">whatsapp</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.03020241536857249">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.03020241536857249" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="moptInId0.32359966800106066">optInId</label></td>
<td>
<input class="parameter required" minlength="1" name="optInId" placeholder="(required)" id="moptInId0.32359966800106066" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="midentitytoken0.44081403821177845">identitytoken</label></td>
<td>
<input class="parameter required" minlength="1" name="identitytoken" placeholder="(required)" id="midentitytoken0.44081403821177845" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.5701467146034382">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.5701467146034382" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.13180668163306564">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.13180668163306564"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.44831281466902584">Parameter content type:</label>
<select name="parameterContentType" id="pct0.44831281466902584">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RequestIdentityTokenRequestDto {</span>
<div><span class="propWrap"><span class="propName ">identityType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>identity type</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(msisdn)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>value (e.g. msisdn)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+?[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">identityType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">value</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.11336372618356516">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.11336372618356516" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.5814836647674702">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5814836647674702"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.26348827586484114">Parameter content type:</label>
<select name="parameterContentType" id="pct0.26348827586484114">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConfirmIdentityTokenRequestDto {</span>
<div><span class="propName ">identityToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>identity token</p>
</span>,</div>
<div><span class="propName ">secret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>secret</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">identityToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.2944964197253863">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.2944964197253863" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.7880946455458644">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7880946455458644"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3262473440308473">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3262473440308473">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConfirmOptOutRequestDto {</span>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code required"><label for="midentitytoken0.42583274435209906">identitytoken</label></td>
<td>
<input class="parameter required" minlength="1" name="identitytoken" placeholder="(required)" id="midentitytoken0.42583274435209906" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.34203937786584904">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.34203937786584904" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="midentitytoken0.7996069047295651">identitytoken</label></td>
<td>
<input class="parameter required" minlength="1" name="identitytoken" placeholder="(required)" id="midentitytoken0.7996069047295651" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.828970145399899">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.828970145399899" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mhashId0.6789423826298622">hashId</label></td>
<td>
<input class="parameter required" minlength="1" name="hashId" placeholder="(required)" id="mhashId0.6789423826298622" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.4006850372171702">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.4006850372171702" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.4553121544201726">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.4553121544201726" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.9301244007276386">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.9301244007276386" type="text" value="+name">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.8822198513418547">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8822198513418547" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9333057623844148">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9333057623844148" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.25043333366648746">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.25043333366648746"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.07914363317010276">Parameter content type:</label>
<select name="parameterContentType" id="pct0.07914363317010276">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MessageTemplateRequest {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>message template name</p>
</span>,</div>
<div><span class="propName required">content</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>message template content</p>
</span>,</div>
<div><span class="propName required">deliveryReport</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>request delivery report?</p>
</span>,</div>
<div><span class="propName ">remoteSmsShortcut</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS shortcut</p>
</span>,</div>
<div><span class="propName ">smsType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>SMS type (0 = default, 1 = flash, 2 = both)</p>
</span>,</div>
<div><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content category (personal, advertisement or informational</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">messageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message type (default, sms, voice, whatsapp</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^(?i)(default|voice|whatsapp)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">urlshorteningType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>urlshortening type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">deliveryReport</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsShortcut</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">smsType</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">urlshorteningType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.1269912843586387">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.1269912843586387" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7441751640525913">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7441751640525913" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7408610178316526">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7408610178316526" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.545046818493848">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.545046818493848"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5635677836559587">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5635677836559587">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MessageTemplateRequest {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>message template name</p>
</span>,</div>
<div><span class="propName required">content</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>message template content</p>
</span>,</div>
<div><span class="propName required">deliveryReport</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>request delivery report?</p>
</span>,</div>
<div><span class="propName ">remoteSmsShortcut</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>remote SMS shortcut</p>
</span>,</div>
<div><span class="propName ">smsType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>SMS type (0 = default, 1 = flash, 2 = both)</p>
</span>,</div>
<div><span class="propName ">contentCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>content category (personal, advertisement or informational</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">messageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message type (default, sms, voice, whatsapp</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^(?i)(default|voice|whatsapp)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">urlshorteningType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>urlshortening type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">deliveryReport</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">remoteSmsShortcut</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">smsType</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategory</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">urlshorteningType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6129423799347731">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6129423799347731"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.697225865056494">Parameter content type:</label>
<select name="parameterContentType" id="pct0.697225865056494">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeleteRequest {</span>
<div><span class="propName required">ids</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">ids</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.676358314382498">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.676358314382498" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.3195713379490792">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.3195713379490792" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.859198881000055">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.859198881000055" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.32645561025103254">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.32645561025103254" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.2578429233990993">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.2578429233990993" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.33399959523603706">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.33399959523603706" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.775236126560515">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.775236126560515" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8172763933800791">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8172763933800791" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.3077136748044629">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.3077136748044629" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.44002254876051894">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.44002254876051894" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.22362238380650634">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.22362238380650634" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.7740466818394098">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.7740466818394098" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.08735789410257566">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.08735789410257566"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.841406042978986">Parameter content type:</label>
<select name="parameterContentType" id="pct0.841406042978986">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoSmsTriggerSequenceOrderRequest {</span>
<div><span class="propName ">accountMsisdn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fields to import file column mapping</p>
</span>,</div>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of mosms trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">accountMsisdn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5172268229914445">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5172268229914445" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5315411269644295">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5315411269644295" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.5216987970095761">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5216987970095761"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.08176996523901203">Parameter content type:</label>
<select name="parameterContentType" id="pct0.08176996523901203">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoSmsTriggerSequenceOrderRequest {</span>
<div><span class="propName ">accountMsisdn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>fields to import file column mapping</p>
</span>,</div>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of mosms trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">accountMsisdn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9326842221502301">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9326842221502301"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.09659199394161377">Parameter content type:</label>
<select name="parameterContentType" id="pct0.09659199394161377">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.16607174967616056">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.16607174967616056" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.31801482857931473">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.31801482857931473" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.09676476685092728">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.09676476685092728" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.1328118504006246">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.1328118504006246"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2512359416205572">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2512359416205572">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.11366225206899516">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.11366225206899516" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8489275305110155">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8489275305110155" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.9469007028749805">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9469007028749805"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.43108266253702676">Parameter content type:</label>
<select name="parameterContentType" id="pct0.43108266253702676">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoSmsTriggerConfigurationRequest {</span>
<div><span class="propName ">accountMsisdn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>accountMsisdn</p>
</span>,</div>
<div><span class="propName ">contentConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsEnabled</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsPattern</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsPattern</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>255</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">contentConditionsIgnoreCase</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsIgnoreCase</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsFlag</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsFlag</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsEnabled</p>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsStart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsStart</p>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsEnd</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsEnd</p>
</span>,</div>
<div><span class="propName ">timePlanConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsEnabled</p>
</span>,</div>
<div><span class="propName ">timePlanConditionsWeekdays</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsWeekdays</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsStartTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsStartTime</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsEndTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsEndTime</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsTimeZone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsTimeZone</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(Europe\/Vienna|null)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">accountMsisdn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsPattern</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsIgnoreCase</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsFlag</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsStart</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.729Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsEnd</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.729Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsWeekdays</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsStartTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsEndTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsTimeZone</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.24959133832291802">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.24959133832291802" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6140188366780173">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6140188366780173" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.9288478801742088">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9288478801742088"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.14179914973610797">Parameter content type:</label>
<select name="parameterContentType" id="pct0.14179914973610797">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HttpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">target</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target URL</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">target</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.4895527686130221">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4895527686130221"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8051178079278212">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8051178079278212">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7561476388443826">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7561476388443826" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.10224073738963191">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.10224073738963191" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.1977848445019914">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.1977848445019914"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.10279065702341139">Parameter content type:</label>
<select name="parameterContentType" id="pct0.10279065702341139">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmtpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">targets</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>targets</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>1000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactGroupIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>100</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>10000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">fromType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>from type</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(null|none|distinct_contact|first_contact)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">targets</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">fromType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.24614987200594474">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.24614987200594474" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.2734286358800815">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.2734286358800815" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.021890586323352057">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.021890586323352057" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5077443139228233">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5077443139228233" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.36174460437357303">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.36174460437357303" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.4698630761717417">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.4698630761717417" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.19226956106547144">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.19226956106547144"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5576215306746541">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5576215306746541">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.8080605370367995">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8080605370367995"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.04782492999101917">Parameter content type:</label>
<select name="parameterContentType" id="pct0.04782492999101917">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6348851045244475">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6348851045244475"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9516354482389295">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9516354482389295">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.977468557126596">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.977468557126596"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.03136699892048078">Parameter content type:</label>
<select name="parameterContentType" id="pct0.03136699892048078">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6694843814727485">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6694843814727485"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.18165280336378498">Parameter content type:</label>
<select name="parameterContentType" id="pct0.18165280336378498">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.31811710155685047">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.31811710155685047"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3468252271257608">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3468252271257608">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.2937128861805869">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.2937128861805869"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.0745354963489182">Parameter content type:</label>
<select name="parameterContentType" id="pct0.0745354963489182">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9059216740706406">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9059216740706406"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8457695278332147">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8457695278332147">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5425441452534132">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5425441452534132" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.45725560731563">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.45725560731563" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6685809038518862">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6685809038518862"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.40073931868221635">Parameter content type:</label>
<select name="parameterContentType" id="pct0.40073931868221635">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AmazonSqsForwardActionConfigurationRequest {</span>
<div><span class="propName ">target</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target URL</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">target</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.41314633639387566">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.41314633639387566" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7557474367322969">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7557474367322969" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.48924091012498483">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.48924091012498483"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7938307803953586">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7938307803953586">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmsForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">targets</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>targets</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>1000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactGroupIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>100</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>10000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">prefixWithSender</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>prefixWithSender</p>
</span>,</div>
<div><span class="propName ">respectSegmentCount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>respectSegmentCount</p>
</span>,</div>
<div><span class="propName ">senderAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>senderAddress</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">targets</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">prefixWithSender</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">respectSegmentCount</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.35924258596255054">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.35924258596255054" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.536103384898672">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.536103384898672" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.053840716940945166">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.053840716940945166" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7520349811302469">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7520349811302469" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.2374584024585371">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.2374584024585371" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.17569767431031846">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.17569767431031846" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.795874362326177">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.795874362326177" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.19630600855277436">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.19630600855277436" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6585522004862792">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6585522004862792"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.07704596226910088">Parameter content type:</label>
<select name="parameterContentType" id="pct0.07704596226910088">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmsAnswerActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span>,</div>
<div><span class="propName ">templateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>templateId</p>
</span>,</div>
<div><span class="propName ">senderAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>senderAddress</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">templateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.753839126009938">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.753839126009938" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8472538485925267">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8472538485925267" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6943557103137303">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6943557103137303"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.027153374564224286">Parameter content type:</label>
<select name="parameterContentType" id="pct0.027153374564224286">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmsAutoResponseActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span>,</div>
<div><span class="propName ">contentCategories</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategories</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.13188175609552766">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.13188175609552766" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7461913543953838">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7461913543953838" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.9900924392694357">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9900924392694357"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.691357639041043">Parameter content type:</label>
<select name="parameterContentType" id="pct0.691357639041043">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmsRecipientBlacklistActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span>,</div>
<div><span class="propName ">templateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>templateId</p>
</span>,</div>
<div><span class="propName ">contentCategories</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">templateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategories</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.746385493554897">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.746385493554897"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3095533462497779">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3095533462497779">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.28752352180753427">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.28752352180753427" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7537790129830335">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7537790129830335" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.4465124078272744">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4465124078272744"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.807068646004734">Parameter content type:</label>
<select name="parameterContentType" id="pct0.807068646004734">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">VoiceForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">targets</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>targets</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>1000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactGroupIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>100</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>10000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">prefixWithSender</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>prefixWithSender</p>
</span>,</div>
<div><span class="propName ">respectSegmentCount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>respectSegmentCount</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">targets</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">prefixWithSender</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">respectSegmentCount</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.36051304036234155">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.36051304036234155" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.10066560996360141">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.10066560996360141" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6190105204514378">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6190105204514378" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3366502610377089">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3366502610377089" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.02603447318303931">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.02603447318303931" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.10687997170548824">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.10687997170548824" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.17426824604227464">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.17426824604227464"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1171945533948866">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1171945533948866">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoWhatsappTriggerSequenceOrderRequest {</span>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of mosms trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.17909325063752024">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.17909325063752024"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.803003849988565">Parameter content type:</label>
<select name="parameterContentType" id="pct0.803003849988565">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoMessengerTriggerSequenceOrderRequest {</span>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of momessenger trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.36589222202787286">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.36589222202787286" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.01673271375652452">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.01673271375652452" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8909999781479088">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8909999781479088"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.39016067089981266">Parameter content type:</label>
<select name="parameterContentType" id="pct0.39016067089981266">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoWhatsappTriggerSequenceOrderRequest {</span>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of mosms trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.8731342660299726">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8731342660299726"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.49661326876421263">Parameter content type:</label>
<select name="parameterContentType" id="pct0.49661326876421263">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.20117024404749406">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.20117024404749406" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6121450811231284">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6121450811231284" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.1677946661300378">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.1677946661300378" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.758836276946961">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.758836276946961"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3998597100896917">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3998597100896917">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.13845572334679468">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.13845572334679468" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.42628471333047147">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.42628471333047147" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.060959795427901975">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.060959795427901975"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6766023727995389">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6766023727995389">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoWhatsappTriggerConfigurationRequest {</span>
<div><span class="propName ">contentConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsEnabled</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsPattern</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsPattern</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>255</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">contentConditionsIgnoreCase</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsIgnoreCase</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsFlag</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsFlag</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsHasAttachment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsHasAttachment</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(yes|no|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsEnabled</p>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsStart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsStart</p>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsEnd</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsEnd</p>
</span>,</div>
<div><span class="propName ">timePlanConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsEnabled</p>
</span>,</div>
<div><span class="propName ">timePlanConditionsWeekdays</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsWeekdays</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsStartTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsStartTime</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsEndTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsEndTime</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsTimeZone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsTimeZone</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(Europe\/Vienna|null)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contentConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsPattern</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsIgnoreCase</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsFlag</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsHasAttachment</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsStart</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.733Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsEnd</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.733Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsWeekdays</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsStartTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsEndTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsTimeZone</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.1455520450368175">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.1455520450368175" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9079943009802747">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9079943009802747" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.15105865619708236">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.15105865619708236"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.42178432345517924">Parameter content type:</label>
<select name="parameterContentType" id="pct0.42178432345517924">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HttpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">target</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target URL</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">target</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.24911655650089926">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.24911655650089926"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.839785768909161">Parameter content type:</label>
<select name="parameterContentType" id="pct0.839785768909161">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.003334696956205807">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.003334696956205807" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6114105671221002">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6114105671221002" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8523068219287677">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8523068219287677"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.26097083714562697">Parameter content type:</label>
<select name="parameterContentType" id="pct0.26097083714562697">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmtpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">targets</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>targets</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>1000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactGroupIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>100</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>10000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">fromType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>from type</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(null|none|distinct_contact|first_contact)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">targets</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">fromType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3750605336876649">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3750605336876649" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.9211050893334995">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.9211050893334995" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.37687429203538403">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.37687429203538403" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.1435573356484665">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.1435573356484665" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.030134629652347034">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.030134629652347034" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.2711202647474511">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.2711202647474511" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9853474744148589">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9853474744148589"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.22961795817115416">Parameter content type:</label>
<select name="parameterContentType" id="pct0.22961795817115416">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.006585492543819793">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.006585492543819793"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2832451387214725">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2832451387214725">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.5193721063469732">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5193721063469732"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.27164257158342564">Parameter content type:</label>
<select name="parameterContentType" id="pct0.27164257158342564">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.22401462748717416">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.22401462748717416"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7698038098946807">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7698038098946807">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7622680000360875">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7622680000360875"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7150324598862876">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7150324598862876">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.5698050147311708">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5698050147311708"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9427997628115574">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9427997628115574">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6461909000067871">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6461909000067871"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9792438953673117">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9792438953673117">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.037919570711473005">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.037919570711473005" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.11019526429318804">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.11019526429318804" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.14840698962222287">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.14840698962222287"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7824221677426695">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7824221677426695">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AmazonSqsForwardActionConfigurationRequest {</span>
<div><span class="propName ">target</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target URL</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">target</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8861964049040512">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8861964049040512" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.08844703496063122">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.08844703496063122" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.2599681980890729">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.2599681980890729"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7959697931173979">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7959697931173979">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhatsappForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">targets</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>targets</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>1000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactGroupIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>100</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>10000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">prefixWithSender</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>prefixWithSender</p>
</span>,</div>
<div><span class="propName ">respectSegmentCount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>respectSegmentCount</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">targets</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">prefixWithSender</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">respectSegmentCount</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9986700372769446">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9986700372769446" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.16385340088802458">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.16385340088802458" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9806916497553506">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9806916497553506" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5973538982155555">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5973538982155555" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.9657720331140769">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.9657720331140769" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.09925401195637229">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.09925401195637229" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9361834790181627">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9361834790181627" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.04287540244137289">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.04287540244137289" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.903422920219439">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.903422920219439"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7130296230730313">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7130296230730313">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhatsappAnswerActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span>,</div>
<div><span class="propName ">templateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>templateId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">templateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6778672391473302">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6778672391473302" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5556057196426745">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5556057196426745" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.12008411117066675">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.12008411117066675"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1198097586313549">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1198097586313549">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhatsappMessengerAnswerActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.032216220911918114">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.032216220911918114" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.04177264887049703">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.04177264887049703" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.08059015887323229">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.08059015887323229"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2560670428842424">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2560670428842424">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmsAnswerActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span>,</div>
<div><span class="propName ">templateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>templateId</p>
</span>,</div>
<div><span class="propName ">senderAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>senderAddress</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">templateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6150018749949782">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6150018749949782" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.23966267445065226">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.23966267445065226" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8737153351258637">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8737153351258637"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9430613215190933">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9430613215190933">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhatsappAutoResponseActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span>,</div>
<div><span class="propName ">templateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>templateId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">templateId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8174676700726087">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8174676700726087" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9348127519984315">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9348127519984315" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.7009178014760533">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7009178014760533"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5175792903406831">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5175792903406831">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoMessengerTriggerSequenceOrderRequest {</span>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of momessenger trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.32122612365143177">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.32122612365143177" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.1393968477137435">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.1393968477137435" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.28035139393491937">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.28035139393491937" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.5852031648281386">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5852031648281386"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.736936453895862">Parameter content type:</label>
<select name="parameterContentType" id="pct0.736936453895862">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8951632928094888">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8951632928094888" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5690726082691404">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5690726082691404" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.1475246440483986">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.1475246440483986"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3738430323420816">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3738430323420816">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoMessengerTriggerConfigurationRequest {</span>
<div><span class="propName ">contentConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsEnabled</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsPattern</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsPattern</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>255</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">contentConditionsIgnoreCase</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsIgnoreCase</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsFlag</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsFlag</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsHasAttachment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsHasAttachment</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(yes|no|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsEnabled</p>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsStart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsStart</p>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsEnd</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsEnd</p>
</span>,</div>
<div><span class="propName ">timePlanConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsEnabled</p>
</span>,</div>
<div><span class="propName ">timePlanConditionsWeekdays</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsWeekdays</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsStartTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsStartTime</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsEndTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsEndTime</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsTimeZone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsTimeZone</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(Europe\/Vienna|null)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contentConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsPattern</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsIgnoreCase</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsFlag</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsHasAttachment</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsStart</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.737Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsEnd</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.737Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsWeekdays</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsStartTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsEndTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsTimeZone</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.44640636906066944">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.44640636906066944"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.04193560634266991">Parameter content type:</label>
<select name="parameterContentType" id="pct0.04193560634266991">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9712901619890597">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9712901619890597" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6349259626074015">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6349259626074015" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8429503252637307">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8429503252637307"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8943807566104158">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8943807566104158">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmtpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">targets</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>targets</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>1000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactGroupIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>100</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>10000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">fromType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>from type</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(null|none|distinct_contact|first_contact)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">targets</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">fromType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.43995269386830516">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.43995269386830516"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.16809646786713062">Parameter content type:</label>
<select name="parameterContentType" id="pct0.16809646786713062">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.4619019088058125">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4619019088058125"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7960679442050942">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7960679442050942">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9313526512884303">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9313526512884303" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6003795577242121">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6003795577242121" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6679299978540107">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6679299978540107"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5412832495159765">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5412832495159765">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhatsappMessengerAutoResponseActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7441388519393743">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7441388519393743"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6305029446242216">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6305029446242216">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8571525243678879">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8571525243678879" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7108292295775991">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7108292295775991" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.29858540310841497">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.29858540310841497"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.06804779272350925">Parameter content type:</label>
<select name="parameterContentType" id="pct0.06804779272350925">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HttpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">target</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target URL</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">target</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.8207609062944146">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8207609062944146"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.06734902842312707">Parameter content type:</label>
<select name="parameterContentType" id="pct0.06734902842312707">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoWabCustomerChannelTriggerSequenceOrderRequest {</span>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span>,</div>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of mowab identifier trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.14055289407282556">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.14055289407282556" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9547813144165362">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9547813144165362" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6416679708212178">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6416679708212178"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2791909733150899">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2791909733150899">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoWabCustomerChannelTriggerSequenceOrderRequest {</span>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span>,</div>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of mowab identifier trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3379348465994947">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3379348465994947" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.47040916152955714">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.47040916152955714" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.953018791911332">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.953018791911332" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.2530753300507209">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.2530753300507209"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.644270053090966">Parameter content type:</label>
<select name="parameterContentType" id="pct0.644270053090966">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.34074210478047084">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.34074210478047084" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.33669919206436427">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.33669919206436427" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.2670710418889759">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.2670710418889759" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5893812271149386">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5893812271149386" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.15747422765612717">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.15747422765612717" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.25790820891083377">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.25790820891083377" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.42989600235923264">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.42989600235923264"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.036455899584877605">Parameter content type:</label>
<select name="parameterContentType" id="pct0.036455899584877605">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoWabCustomerChannelTriggerConfigurationRequest {</span>
<div><span class="propName ">contentConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsEnabled</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsPattern</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsPattern</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>255</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">contentConditionsIgnoreCase</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsIgnoreCase</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsFlag</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsFlag</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsHasAttachment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsHasAttachment</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(yes|no|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsEnabled</p>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsStart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsStart</p>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsEnd</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsEnd</p>
</span>,</div>
<div><span class="propName ">timePlanConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsEnabled</p>
</span>,</div>
<div><span class="propName ">timePlanConditionsWeekdays</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsWeekdays</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsStartTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsStartTime</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsEndTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsEndTime</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsTimeZone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsTimeZone</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(Europe\/Vienna|null)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contentConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsPattern</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsIgnoreCase</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsFlag</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsHasAttachment</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsStart</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.739Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsEnd</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.739Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsWeekdays</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsStartTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsEndTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsTimeZone</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.629366171022339">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.629366171022339"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.17594459489959768">Parameter content type:</label>
<select name="parameterContentType" id="pct0.17594459489959768">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.731557745307285">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.731557745307285" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.02880979697958641">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.02880979697958641" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.586709806932423">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.586709806932423"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.0661885156656794">Parameter content type:</label>
<select name="parameterContentType" id="pct0.0661885156656794">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmtpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">targets</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>targets</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>1000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactGroupIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>100</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>10000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">fromType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>from type</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(null|none|distinct_contact|first_contact)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">targets</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">fromType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.041679388946465945">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.041679388946465945"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8718387791777491">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8718387791777491">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3778002919811996">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3778002919811996" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.4181961414668136">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4181961414668136" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.532877189320079">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.532877189320079"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4856062890815198">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4856062890815198">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhatsappMessengerAnswerActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.38994563120954906">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.38994563120954906"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8833355404555447">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8833355404555447">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.825019844663224">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.825019844663224" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.34308030906316955">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.34308030906316955" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8035897597562951">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8035897597562951"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.011111398130207117">Parameter content type:</label>
<select name="parameterContentType" id="pct0.011111398130207117">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhatsappMessengerAutoResponseActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.024760334709570397">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.024760334709570397"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5085872695827933">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5085872695827933">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.0035287156905832173">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.0035287156905832173" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.700037650474626">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.700037650474626" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6757810607644765">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6757810607644765"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6184805952938193">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6184805952938193">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhatsappRecipientBlacklistActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span>,</div>
<div><span class="propName ">contentCategories</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategories</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.589264465398943">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.589264465398943"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.10288776447268777">Parameter content type:</label>
<select name="parameterContentType" id="pct0.10288776447268777">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.013836257898405258">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.013836257898405258" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.4580466607301179">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4580466607301179" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.1156023819021279">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.1156023819021279"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8428129788041347">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8428129788041347">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HttpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">target</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target URL</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">target</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.3543578863499759">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3543578863499759"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.917313906836472">Parameter content type:</label>
<select name="parameterContentType" id="pct0.917313906836472">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DlrWabCustomerChannelTriggerSequenceOrderRequestDto {</span>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span>,</div>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of dlrwab identifier trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6301233979147891">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6301233979147891" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.806178173520705">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.806178173520705" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.5137404017018918">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5137404017018918"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1400244507275823">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1400244507275823">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DlrWabCustomerChannelTriggerSequenceOrderRequestDto {</span>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span>,</div>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of dlrwab identifier trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5447029938243724">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5447029938243724" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.1635290880478224">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.1635290880478224" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.41416554922176574">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.41416554922176574" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.22264615323909442">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.22264615323909442"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7161502316840473">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7161502316840473">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5165609658018435">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5165609658018435" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.4583196089333985">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4583196089333985" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.48344141848640176">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.48344141848640176"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.17764256375581722">Parameter content type:</label>
<select name="parameterContentType" id="pct0.17764256375581722">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DlrWabCustomerChannelTriggerConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">sourceMessageOrigin</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sourceMessageOrigin</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(null)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">sourceMessageOrigin</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6096013306495873">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6096013306495873"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6078654749922636">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6078654749922636">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.825748772502553">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.825748772502553" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.2504615259886338">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.2504615259886338" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.3350321583759188">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3350321583759188"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.14480949409803112">Parameter content type:</label>
<select name="parameterContentType" id="pct0.14480949409803112">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HttpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">target</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target URL</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">target</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.23382247344699336">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.23382247344699336"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3350973588420325">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3350973588420325">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.279638550819038">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.279638550819038" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5361974843878043">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5361974843878043" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8454565383165653">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8454565383165653"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6457117009712088">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6457117009712088">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmtpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">targets</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>targets</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>1000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactGroupIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>100</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contactIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contactIds</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Items:</td>
<td>10000</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">fromType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>from type</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(null|none|distinct_contact|first_contact)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">targets</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">contactIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">fromType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.45450052697145127">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.45450052697145127"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3203899661640699">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3203899661640699">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoRcsCustomerChannelTriggerSequenceOrderRequest {</span>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span>,</div>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of morcs identifier trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6960684649586153">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6960684649586153" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9924561507009646">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9924561507009646" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.22603897116111993">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.22603897116111993"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7114055279785327">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7114055279785327">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoRcsCustomerChannelTriggerSequenceOrderRequest {</span>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span>,</div>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of morcs identifier trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.37902257828435304">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.37902257828435304" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.44276008614941653">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.44276008614941653" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7330868252763139">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7330868252763139" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.7427133380149111">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7427133380149111"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.25302779296935785">Parameter content type:</label>
<select name="parameterContentType" id="pct0.25302779296935785">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8403764833722864">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8403764833722864" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9978337319465254">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9978337319465254" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.1602318814060335">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.1602318814060335"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2853009436770819">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2853009436770819">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MoRcsCustomerChannelTriggerConfigurationRequest {</span>
<div><span class="propName ">contentConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsEnabled</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsPattern</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsPattern</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>255</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">contentConditionsIgnoreCase</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsIgnoreCase</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsFlag</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsFlag</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">contentConditionsHasAttachment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contentConditionsHasAttachment</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(yes|no|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsEnabled</p>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsStart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsStart</p>
</span>,</div>
<div><span class="propName ">validityPeriodConditionsEnd</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>validityPeriodConditionsEnd</p>
</span>,</div>
<div><span class="propName ">timePlanConditionsEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsEnabled</p>
</span>,</div>
<div><span class="propName ">timePlanConditionsWeekdays</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsWeekdays</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsStartTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsStartTime</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsEndTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsEndTime</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">timePlanConditionsTimeZone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>timePlanConditionsTimeZone</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(Europe\/Vienna|null)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">contentConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsPattern</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsIgnoreCase</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsFlag</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentConditionsHasAttachment</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsStart</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.742Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">validityPeriodConditionsEnd</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-06-20T13:22:50.742Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsWeekdays</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsStartTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsEndTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timePlanConditionsTimeZone</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.08106749948329184">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.08106749948329184"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1971955313136975">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1971955313136975">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3508547967592439">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3508547967592439" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.17901893684935666">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.17901893684935666" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.7311541360422888">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7311541360422888"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7328776088983793">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7328776088983793">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RcsAnswerActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7334989084344128">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7334989084344128"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5737241389908401">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5737241389908401">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6614686714285836">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6614686714285836" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9475455227973235">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9475455227973235" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8529338196252938">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8529338196252938"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.17092021516073963">Parameter content type:</label>
<select name="parameterContentType" id="pct0.17092021516073963">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RcsAutoResponseActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.15864257790703173">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.15864257790703173"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.830025983194757">Parameter content type:</label>
<select name="parameterContentType" id="pct0.830025983194757">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.18727255775132745">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.18727255775132745" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5603793608163559">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5603793608163559" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.21631914104071392">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.21631914104071392"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6651822771498179">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6651822771498179">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SmsAutoResponseActionConfigurationRequest {</span>
<div><span class="propName ">messageContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>messageContent</p>
</span>,</div>
<div><span class="propName ">contentCategories</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">messageContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">contentCategories</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7046769674477096">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7046769674477096"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3277723943299269">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3277723943299269">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6200063973914873">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6200063973914873" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.4291918682382214">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4291918682382214" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.9506528850470481">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9506528850470481"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.38166921305465573">Parameter content type:</label>
<select name="parameterContentType" id="pct0.38166921305465573">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HttpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">target</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target URL</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">target</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9161661771909828">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9161661771909828"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5904417620791862">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5904417620791862">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DlrRcsCustomerChannelTriggerSequenceOrderRequestDto {</span>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span>,</div>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of dlrrcs identifier trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.4666332830990063">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4666332830990063" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9919630722095814">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9919630722095814" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.9554719319171172">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9554719319171172"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8199621820576262">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8199621820576262">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DlrRcsCustomerChannelTriggerSequenceOrderRequestDto {</span>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span>,</div>
<div><span class="propName required">order</span> (<span class="propType">Array[integer]</span>): <span class="propDesc markdown">
<p>sequence order of dlrrcs identifier trigger</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">order</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.4666023854446626">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4666023854446626" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.829798616245025">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.829798616245025" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5926548149481017">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5926548149481017" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.25243714381873184">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.25243714381873184"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.04963584498020257">Parameter content type:</label>
<select name="parameterContentType" id="pct0.04963584498020257">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9901310639249643">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9901310639249643" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.15767013454006262">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.15767013454006262" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.2695317272555102">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.2695317272555102"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2729294809513354">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2729294809513354">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DlrRcsCustomerChannelTriggerConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">sourceMessageOrigin</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sourceMessageOrigin</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(null)$</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">sourceMessageOrigin</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.10240473289525043">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.10240473289525043"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9334706675576567">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9334706675576567">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerChannelTriggerRequest {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>name</p>
</span>,</div>
<div><span class="propName ">enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>enabled</p>
</span>,</div>
<div><span class="propName ">customerChannelId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>customerChannelId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">name</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">enabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">customerChannelId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.4556409974943578">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4556409974943578" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7127755894959364">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7127755894959364" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.44769237224746994">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.44769237224746994"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9465888238481328">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9465888238481328">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HttpForwardActionConfigurationRequest {</span>
<div><span class="propWrap"><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>format (json, xml, ...)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(json|xml|xml_legacy|customer_channel_default)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">target</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>target URL</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">target</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9497975118002946">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9497975118002946" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="msecret0.5058626660762131">secret</label></td>
<td>
<input class="parameter" minlength="0" name="secret" placeholder="" id="msecret0.5058626660762131" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5957674285245462">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5957674285245462" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.5065442359364292">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5065442359364292"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6207793959308521">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6207793959308521">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConfirmRegistrationVerificationRequest {</span>
<div><span class="propName required">secret</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>secret</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.2967356782603483">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.2967356782603483" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9097209299723257">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9097209299723257"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.378028156179105">Parameter content type:</label>
<select name="parameterContentType" id="pct0.378028156179105">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AuthorizeRequest {</span>
<div><span class="propName ">redirectUri</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Redirect URI</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">redirectUri</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>successful operation</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.5550008720148114">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5550008720148114"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6375850451764233">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6375850451764233">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AuthorizeRequest {</span>
<div><span class="propName ">redirectUri</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Redirect URI</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">redirectUri</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>successful operation</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="msiteId0.34524496295999385">siteId</label></td>
<td>
<input class="parameter" minlength="0" name="siteId" placeholder="" id="msiteId0.34524496295999385" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlocale0.9768822128376091">locale</label></td>
<td>
<input class="parameter" minlength="0" name="locale" placeholder="" id="mlocale0.9768822128376091" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8272519083638925">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8272519083638925" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8618639120560185">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8618639120560185" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.40911796963074076">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.40911796963074076"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4160060823170759">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4160060823170759">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RegistrationRequest {</span>
<div><span class="propName ">siteId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>site id (0 = Unknown/Autodetect, 1 = Austria, 2 = Germany, 3 = Switzerland, 4 = Italy, 5 = Linkmobility Germany, 6 = Linkmobility SSU Germany, 7 = Linkmobility SSU Austria, 8 = Linkmobility SSU Switzerland</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">resellerId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>reseller id</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>2147483647</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">mainContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email address</p>
</span>,</div>
<div><span class="propName ">mainContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>first name</p>
</span>,</div>
<div><span class="propName ">mainContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>last name</p>
</span>,</div>
<div><span class="propName ">password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>password</p>
</span>,</div>
<div><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>locale</p>
</span>,</div>
<div><span class="propName ">trial</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is trial light registration</p>
</span>,</div>
<div><span class="propName ">companyName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">companyStreet</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company street</p>
</span>,</div>
<div><span class="propName ">companyZipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company zip code</p>
</span>,</div>
<div><span class="propName ">companyCity</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company city</p>
</span>,</div>
<div><span class="propName ">companyCountry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company country</p>
</span>,</div>
<div><span class="propName ">vatId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>vat id</p>
</span>,</div>
<div><span class="propName ">companySectorIndustryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sector industry id</p>
</span>,</div>
<div><span class="propName ">companyUseCaseId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company use case id</p>
</span>,</div>
<div><span class="propName ">companyUseCase</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company use case other text</p>
</span>,</div>
<div><span class="propName ">companySizeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company size id</p>
</span>,</div>
<div><span class="propName ">mainContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact title</p>
</span>,</div>
<div><span class="propName ">mainContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact salutation</p>
</span>,</div>
<div><span class="propName ">mainContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact phone number</p>
</span>,</div>
<div><span class="propName ">commercialContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact salutation</p>
</span>,</div>
<div><span class="propName ">commercialContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact title</p>
</span>,</div>
<div><span class="propName ">commercialContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact first name</p>
</span>,</div>
<div><span class="propName ">commercialContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact last name</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company name</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyStreet</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company street</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyZipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company zip code</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyCity</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company city</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyCountry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company country</p>
</span>,</div>
<div><span class="propName ">accountBic</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account bic</p>
</span>,</div>
<div><span class="propName ">accountIban</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account iban</p>
</span>,</div>
<div><span class="propName ">bankAccept</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bank accept debit and bank confirm business</p>
</span>,</div>
<div><span class="propName ">paymentMethod</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>payment method</p>
</span>,</div>
<div><span class="propName ">newsletters</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>accepts newsletters</p>
</span>,</div>
<div><span class="propName ">confirmedAgbRead</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>confirmed agb read</p>
</span>,</div>
<div><span class="propName ">voucherCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>voucher code</p>
</span>,</div>
<div><span class="propName ">origin</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>origin</p>
</span>,</div>
<div><span class="propName ">shoppingCart</span> (<span class="propType">ShoppingCartRequest</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>shopping cart</p>
</span>,</div>
<div><span class="propName ">gaClientId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>gaClientId</p>
</span>,</div>
<div><span class="propName ">eInvoiceEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>einvoice email address</p>
</span></div><span class="strong">}</span><br><span class="strong">ShoppingCartRequest {</span>
<div><span class="propWrap"><span class="propName ">basePackage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>base package</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">addonPackages</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>addon packages</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">paymentPlan</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(yearly|monthly|null)$</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">siteId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">resellerId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">password</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">trial</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyStreet</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyZipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyCity</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyCountry</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">vatId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companySectorIndustryId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyUseCaseId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyUseCase</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companySizeId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyStreet</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyZipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyCity</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyCountry</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountBic</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountIban</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bankAccept</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">paymentMethod</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">newsletters</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">confirmedAgbRead</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">voucherCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">origin</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">shoppingCart</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">basePackage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">addonPackages</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">paymentPlan</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">gaClientId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">eInvoiceEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7695128401053515">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7695128401053515" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.5706029480518513">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5706029480518513"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7210191526018346">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7210191526018346">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">InitiateEmailAddressVerificationRequest {</span>
<div><span class="propName ">clientId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>clientId</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">clientId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.48940680373823">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.48940680373823"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.321375637748303">Parameter content type:</label>
<select name="parameterContentType" id="pct0.321375637748303">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RegistrationRequest {</span>
<div><span class="propName ">siteId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>site id (0 = Unknown/Autodetect, 1 = Austria, 2 = Germany, 3 = Switzerland, 4 = Italy, 5 = Linkmobility Germany, 6 = Linkmobility SSU Germany, 7 = Linkmobility SSU Austria, 8 = Linkmobility SSU Switzerland</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">resellerId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>reseller id</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>2147483647</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">mainContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>email address</p>
</span>,</div>
<div><span class="propName ">mainContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>first name</p>
</span>,</div>
<div><span class="propName ">mainContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>last name</p>
</span>,</div>
<div><span class="propName ">password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>password</p>
</span>,</div>
<div><span class="propName ">locale</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>locale</p>
</span>,</div>
<div><span class="propName ">trial</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>is trial light registration</p>
</span>,</div>
<div><span class="propName ">companyName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>,</div>
<div><span class="propName ">companyStreet</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company street</p>
</span>,</div>
<div><span class="propName ">companyZipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company zip code</p>
</span>,</div>
<div><span class="propName ">companyCity</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company city</p>
</span>,</div>
<div><span class="propName ">companyCountry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company country</p>
</span>,</div>
<div><span class="propName ">vatId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>vat id</p>
</span>,</div>
<div><span class="propName ">companySectorIndustryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sector industry id</p>
</span>,</div>
<div><span class="propName ">companyUseCaseId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company use case id</p>
</span>,</div>
<div><span class="propName ">companyUseCase</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company use case other text</p>
</span>,</div>
<div><span class="propName ">companySizeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company size id</p>
</span>,</div>
<div><span class="propName ">mainContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact title</p>
</span>,</div>
<div><span class="propName ">mainContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact salutation</p>
</span>,</div>
<div><span class="propName ">mainContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact phone number</p>
</span>,</div>
<div><span class="propName ">commercialContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact salutation</p>
</span>,</div>
<div><span class="propName ">commercialContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact title</p>
</span>,</div>
<div><span class="propName ">commercialContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact first name</p>
</span>,</div>
<div><span class="propName ">commercialContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact last name</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company name</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyStreet</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company street</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyZipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company zip code</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyCity</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company city</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyCountry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company country</p>
</span>,</div>
<div><span class="propName ">accountBic</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account bic</p>
</span>,</div>
<div><span class="propName ">accountIban</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account iban</p>
</span>,</div>
<div><span class="propName ">bankAccept</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bank accept debit and bank confirm business</p>
</span>,</div>
<div><span class="propName ">paymentMethod</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>payment method</p>
</span>,</div>
<div><span class="propName ">newsletters</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>accepts newsletters</p>
</span>,</div>
<div><span class="propName ">confirmedAgbRead</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>confirmed agb read</p>
</span>,</div>
<div><span class="propName ">voucherCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>voucher code</p>
</span>,</div>
<div><span class="propName ">origin</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>origin</p>
</span>,</div>
<div><span class="propName ">shoppingCart</span> (<span class="propType">ShoppingCartRequest</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>shopping cart</p>
</span>,</div>
<div><span class="propName ">gaClientId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>gaClientId</p>
</span>,</div>
<div><span class="propName ">eInvoiceEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>einvoice email address</p>
</span></div><span class="strong">}</span><br><span class="strong">ShoppingCartRequest {</span>
<div><span class="propWrap"><span class="propName ">basePackage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>base package</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">addonPackages</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>addon packages</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">paymentPlan</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(yearly|monthly|null)$</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">siteId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">resellerId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">password</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">locale</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">trial</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyStreet</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyZipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyCity</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyCountry</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">vatId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companySectorIndustryId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyUseCaseId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyUseCase</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companySizeId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyStreet</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyZipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyCity</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyCountry</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountBic</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountIban</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bankAccept</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">paymentMethod</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">newsletters</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">confirmedAgbRead</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">voucherCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">origin</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">shoppingCart</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">basePackage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">addonPackages</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">paymentPlan</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">gaClientId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">eInvoiceEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtoken0.32910399162433857">token</label></td>
<td>
<input class="parameter required" minlength="1" name="token" placeholder="(required)" id="mtoken0.32910399162433857" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad Request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.004947861526276576">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.004947861526276576"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.23624948593470485">Parameter content type:</label>
<select name="parameterContentType" id="pct0.23624948593470485">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerUpgradeRequest {</span>
<div><span class="propWrap"><span class="propName required">companyName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>company name</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName required">companyStreet</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>company street</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">companyPostalCode</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>company postal code</p>
</span>,</div>
<div><span class="propName required">companyCity</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>company city</p>
</span>,</div>
<div><span class="propName required">companyCountry</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>company country</p>
</span>,</div>
<div><span class="propName ">vatId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>vat id</p>
</span>,</div>
<div><span class="propName ">companySectorIndustryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sector industry id</p>
</span>,</div>
<div><span class="propName ">companyUseCaseId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company use case id</p>
</span>,</div>
<div><span class="propName ">companyUseCase</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company use case other text</p>
</span>,</div>
<div><span class="propName ">companySizeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company size id</p>
</span>,</div>
<div><span class="propName ">mainContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact title</p>
</span>,</div>
<div><span class="propName required">mainContactSalutation</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>main contact salutation</p>
</span>,</div>
<div><span class="propName required">mainContactFirstName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>main contact first name</p>
</span>,</div>
<div><span class="propName required">mainContactLastName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>contact surname</p>
</span>,</div>
<div><span class="propName required">mainContactEmailAddress</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>main contact email address</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mainContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">commercialContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact salutation</p>
</span>,</div>
<div><span class="propName ">commercialContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact title</p>
</span>,</div>
<div><span class="propName ">commercialContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact first name</p>
</span>,</div>
<div><span class="propName ">commercialContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">invoicingCompanyName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>invoicing company name</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName required">invoicingCompanyStreet</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>invoicing company street</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">invoicingCompanyZipCode</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>invoicing company zip code</p>
</span>,</div>
<div><span class="propName required">invoicingCompanyCity</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>invoicing company city</p>
</span>,</div>
<div><span class="propName required">invoicingCompanyCountry</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>invoicing company country</p>
</span>,</div>
<div><span class="propName required">geteInvoiceEmailAddress</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>einvoice email address</p>
</span>,</div>
<div><span class="propName ">accountBic</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account bic</p>
</span>,</div>
<div><span class="propName ">accountIban</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account iban</p>
</span>,</div>
<div><span class="propName ">bankAccept</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bank accept debit and bank confirm business</p>
</span>,</div>
<div><span class="propName ">bankDataLater</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bank data later</p>
</span>,</div>
<div><span class="propName ">newsletters</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>accepts newsletters</p>
</span>,</div>
<div><span class="propName required">confirmedAgbRead</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>confirmed agb read</p>
</span>,</div>
<div><span class="propName ">voucherCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>voucher code</p>
</span>,</div>
<div><span class="propName ">shoppingCart</span> (<span class="propType">ShoppingCartRequest</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>shopping cart</p>
</span></div><span class="strong">}</span><br><span class="strong">ShoppingCartRequest {</span>
<div><span class="propWrap"><span class="propName ">basePackage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>base package</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">addonPackages</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>addon packages</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">paymentPlan</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(yearly|monthly|null)$</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">companyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyStreet</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyPostalCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyCity</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyCountry</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">vatId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companySectorIndustryId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyUseCaseId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyUseCase</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companySizeId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyStreet</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyZipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyCity</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyCountry</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">geteInvoiceEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountBic</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountIban</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bankAccept</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">bankDataLater</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">newsletters</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">confirmedAgbRead</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">voucherCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">shoppingCart</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">basePackage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">addonPackages</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">paymentPlan</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code required"><label for="mtoken0.9214365290786672">token</label></td>
<td>
<input class="parameter required" minlength="1" name="token" placeholder="(required)" id="mtoken0.9214365290786672" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad Request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.8099766059176214">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8099766059176214"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4496141475101363">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4496141475101363">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PostalCodeValidationRequestDto {</span>
<div><span class="propName ">countryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">countryCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">postalCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.04525203829477631">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.04525203829477631"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.027773607644433707">Parameter content type:</label>
<select name="parameterContentType" id="pct0.027773607644433707">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">IBANValidationRequestDto {</span>
<div><span class="propName ">iban</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">iban</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.31503904742011657">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.31503904742011657"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9159668682555073">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9159668682555073">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">VatValidationRequestDto {</span>
<div><span class="propName ">countryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">vatId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">countryCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">vatId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.008180210694931578">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.008180210694931578"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7055853355738742">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7055853355738742">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">BICValidationRequestDto {</span>
<div><span class="propName ">bic</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">iban</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">bic</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">iban</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.9552820247822889">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.9552820247822889" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.8223247123470883">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.8223247123470883" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.06569924735392996">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.06569924735392996" type="text" value="+useCase">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.21193422952972352">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.21193422952972352" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.46911683050378916">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.46911683050378916" type="text" value="100">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.3731371909586536">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.3731371909586536" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.48266667618021697">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.48266667618021697" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.5464202678473498">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.5464202678473498" type="text" value="+companySize">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.49174696728596534">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.49174696728596534" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8583552217179491">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8583552217179491" type="text" value="100">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.4564737824641243">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.4564737824641243" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.13603508385795648">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.13603508385795648" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.6829668661073933">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.6829668661073933" type="text" value="+iso2">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.046699138354334924">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.046699138354334924" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.43843176847216636">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.43843176847216636" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.33433986879395694">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.33433986879395694" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.37283672600216655">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.37283672600216655" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.939729758622339">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.939729758622339" type="text" value="+sector">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.7104097867578998">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.7104097867578998" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6097082061475791">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6097082061475791" type="text" value="100">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.34728106223076716">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.34728106223076716" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mfilter0.17686939124410817">filter</label></td>
<td>
<input class="parameter" minlength="0" name="filter" placeholder="" id="mfilter0.17686939124410817" type="text" value="">
</td>
<td class="markdown">
<p>Filter</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCode0.6834842998654949">regionCode</label></td>
<td>
<input class="parameter" minlength="0" name="regionCode" placeholder="" id="mregionCode0.6834842998654949" type="text" value="">
</td>
<td class="markdown">
<p>Region Code</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.4503342733784752">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.4503342733784752" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.60292429069655">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.60292429069655" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.49553202019253506">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.49553202019253506" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.14564831293984404">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.14564831293984404" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.3870297303011603">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.3870297303011603" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.025574179760427418">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.025574179760427418" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.2105311067667579">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.2105311067667579" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.8937192570476324">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.8937192570476324" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilters0.6196680131184868">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.6196680131184868" type="text" value="">
</td>
<td class="markdown">
<p>Filters</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCodes0.8538288228692015">regionCodes</label></td>
<td>
<input class="parameter" minlength="0" name="regionCodes" placeholder="" id="mregionCodes0.8538288228692015" type="text" value="">
</td>
<td class="markdown">
<p>Region Codes</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.8294328672374061">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.8294328672374061" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.9405341528018258">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.9405341528018258" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad Request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mformat0.001756020103451661">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.001756020103451661" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.565597788432497">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.565597788432497" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.4235131430419401">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.4235131430419401" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.9517933195807364">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.9517933195807364" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilters0.24215111679756096">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.24215111679756096" type="text" value="">
</td>
<td class="markdown">
<p>Filters</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCodes0.4082260999601608">regionCodes</label></td>
<td>
<input class="parameter" minlength="0" name="regionCodes" placeholder="" id="mregionCodes0.4082260999601608" type="text" value="">
</td>
<td class="markdown">
<p>Region Codes</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.6208367053320709">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.6208367053320709" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.04647393787322196">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.04647393787322196" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.934313502033056">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.934313502033056" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.5854368706547921">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.5854368706547921" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.8321642101918427">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8321642101918427" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.46854741174939174">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.46854741174939174" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.32138433130240895">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.32138433130240895" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.13382450998688689">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.13382450998688689" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.7284218942315406">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.7284218942315406" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.3039802870518311">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.3039802870518311" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.11162011311277009">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.11162011311277009" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.3064750343424132">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3064750343424132"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6996317704262873">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6996317704262873">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeliveryDetailsExportRequestDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Start date</p>
</span>,</div>
<div><span class="propName ">to</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>End date</p>
</span>,</div>
<div><span class="propName ">filters</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Filters</p>
</span>,</div>
<div><span class="propName ">regionCodes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Region Codes</p>
</span>,</div>
<div><span class="propName ">search</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Search</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">from</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">to</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">filters</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">regionCodes</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">search</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.5426780541942617">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.5426780541942617">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.15374381649170554">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.15374381649170554" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.35957587397010404">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.35957587397010404" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.020529685678968956">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.020529685678968956" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.17607981217838997">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.17607981217838997" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.9429750150416227">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9429750150416227"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6291546095526168">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6291546095526168">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.34489834692410626">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.34489834692410626">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.434444149147603">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.434444149147603" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.6238747019008346">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.6238747019008346" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.07635593007741193">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.07635593007741193" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.7475645791855292">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.7475645791855292" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.6185611672474671">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.6185611672474671" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.2180589902739256">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.2180589902739256" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.20432669757319566">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.20432669757319566" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.8723061458896406">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.8723061458896406" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6388065223905341">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6388065223905341" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.3835507900752215">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.3835507900752215" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.5067295210054739">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.5067295210054739" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.0811405695706684">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.0811405695706684" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.01943749366707692">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.01943749366707692"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5496286496602318">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5496286496602318">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerRequest {</span>
<div><span class="propName ">signature</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>signature</p>
</span>,</div>
<div><span class="propName ">optInCssUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>optin css url</p>
</span>,</div>
<div><span class="propName ">optInCssContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>optin css content</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">signature</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">optInCssUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">optInCssContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mfilter0.6075098919944535">filter</label></td>
<td>
<input class="parameter" minlength="0" name="filter" placeholder="" id="mfilter0.6075098919944535" type="text" value="">
</td>
<td class="markdown">
<p>Filter</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCode0.7710204067332915">regionCode</label></td>
<td>
<input class="parameter" minlength="0" name="regionCode" placeholder="" id="mregionCode0.7710204067332915" type="text" value="">
</td>
<td class="markdown">
<p>Region Code</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.059868540397280956">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.059868540397280956" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.5083175744140793">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.5083175744140793" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.3575432145742019">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3575432145742019" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mfilter0.2387868760046561">filter</label></td>
<td>
<input class="parameter" minlength="0" name="filter" placeholder="" id="mfilter0.2387868760046561" type="text" value="">
</td>
<td class="markdown">
<p>Filter</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCode0.790498307202671">regionCode</label></td>
<td>
<input class="parameter" minlength="0" name="regionCode" placeholder="" id="mregionCode0.790498307202671" type="text" value="">
</td>
<td class="markdown">
<p>Region Code</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.855684739900415">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.855684739900415" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.2629353420798337">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.2629353420798337" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.19089275701234243">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.19089275701234243" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.6849428240688111">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.6849428240688111" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5321746796951057">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5321746796951057" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.6838187104774012">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.6838187104774012" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilters0.6101685560593424">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.6101685560593424" type="text" value="">
</td>
<td class="markdown">
<p>Filters</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCodes0.6630329291860959">regionCodes</label></td>
<td>
<input class="parameter" minlength="0" name="regionCodes" placeholder="" id="mregionCodes0.6630329291860959" type="text" value="">
</td>
<td class="markdown">
<p>Region Codes</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.258481869202146">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.258481869202146" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.25052297302213766">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.25052297302213766" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad Request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9184200450705549">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9184200450705549"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4645541912096025">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4645541912096025">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerContactPersonRequest {</span>
<div><span class="propName ">mainContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact salutation</p>
</span>,</div>
<div><span class="propName ">mainContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact title</p>
</span>,</div>
<div><span class="propName ">mainContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact first name</p>
</span>,</div>
<div><span class="propName ">mainContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mainContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">mainContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact email address</p>
</span>,</div>
<div><span class="propName ">techContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>tech contact salutation</p>
</span>,</div>
<div><span class="propName ">techContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>tech contact title</p>
</span>,</div>
<div><span class="propName ">techContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>tech contact first name</p>
</span>,</div>
<div><span class="propName ">techContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">techContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">techContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact email address</p>
</span>,</div>
<div><span class="propName ">adminContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact salutation</p>
</span>,</div>
<div><span class="propName ">adminContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact title</p>
</span>,</div>
<div><span class="propName ">adminContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact first name</p>
</span>,</div>
<div><span class="propName ">adminContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">adminContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">adminContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact email address</p>
</span>,</div>
<div><span class="propName ">commercialContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact salutation</p>
</span>,</div>
<div><span class="propName ">commercialContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact title</p>
</span>,</div>
<div><span class="propName ">commercialContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact first name</p>
</span>,</div>
<div><span class="propName ">commercialContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">commercialContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">commercialContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact email address</p>
</span>,</div>
<div><span class="propName ">marketingContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact salutation</p>
</span>,</div>
<div><span class="propName ">marketingContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact title</p>
</span>,</div>
<div><span class="propName ">marketingContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact first name</p>
</span>,</div>
<div><span class="propName ">marketingContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">marketingContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">marketingContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact email address</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">mainContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Update forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.47052037069389385">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.47052037069389385"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3429160064879273">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3429160064879273">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerContractDetailRequest {</span>
<div><span class="propWrap"><span class="propName ">companyName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">companyStreet</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company street</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">companyZipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company zip code</p>
</span>,</div>
<div><span class="propName ">companyCity</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company city</p>
</span>,</div>
<div><span class="propName ">companyCountry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company country</p>
</span>,</div>
<div><span class="propName ">companySectorIndustryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sector industry id</p>
</span>,</div>
<div><span class="propName ">companySizeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company size id</p>
</span>,</div>
<div><span class="propName ">companyUseCaseId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company use case id</p>
</span>,</div>
<div><span class="propName ">companyUseCase</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company use case other text</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">invoicingCompanyName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company name</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">invoicingCompanyStreet</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company street</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">invoicingCompanyZipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company zip code</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyCity</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company city</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyCountry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company country</p>
</span>,</div>
<div><span class="propName ">accountBic</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account bic</p>
</span>,</div>
<div><span class="propName ">accountIban</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account iban</p>
</span>,</div>
<div><span class="propName ">invoiceRecipient</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoice recipient</p>
</span>,</div>
<div><span class="propName ">geteInvoiceEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>einvoice email address</p>
</span>,</div>
<div><span class="propName ">iseInvoiceEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>einvoice enabled</p>
</span>,</div>
<div><span class="propName ">directDebitEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>direct debit enabled</p>
</span>,</div>
<div><span class="propName ">vatId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>vat id</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">companyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyStreet</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyZipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyCity</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyCountry</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companySectorIndustryId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companySizeId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyUseCaseId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyUseCase</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyStreet</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyZipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyCity</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyCountry</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountBic</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountIban</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoiceRecipient</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">geteInvoiceEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">iseInvoiceEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">directDebitEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">vatId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Update forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.009803204346235495">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.009803204346235495"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.14425125128913074">Parameter content type:</label>
<select name="parameterContentType" id="pct0.14425125128913074">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerContractPaymentRequest {</span>
<div><span class="propName ">paymentMethod</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>payment method</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">paymentMethod</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Update forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.5720167282886031">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5720167282886031"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5429460783417555">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5429460783417555">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SepaPaymentApprovalRequest {</span>
<div><span class="propName ">accountIban</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account iban</p>
</span>,</div>
<div><span class="propName ">accountBic</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account bic</p>
</span>,</div>
<div><span class="propName ">bankAccept</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bank accept debit and bank confirm business</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">accountIban</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountBic</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bankAccept</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Update forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.5578733521064718">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.5578733521064718" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.25652140672040535">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.25652140672040535" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.4308637882934043">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.4308637882934043" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.33360825846758857">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.33360825846758857" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.3294352966602112">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.3294352966602112" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9941353887119013">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9941353887119013"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6305879074928926">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6305879074928926">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">VoucherRequest {</span>
<div><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>voucher type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td class="markdown">
<p>Created</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5448516020676661">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5448516020676661" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.4161399236645271">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.4161399236645271" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.5817964608807931">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.5817964608807931" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.7818380786318">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.7818380786318" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.33958399277270734">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.33958399277270734" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilters0.7748694328731012">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.7748694328731012" type="text" value="">
</td>
<td class="markdown">
<p>Filters</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCodes0.7728307797852201">regionCodes</label></td>
<td>
<input class="parameter" minlength="0" name="regionCodes" placeholder="" id="mregionCodes0.7728307797852201" type="text" value="">
</td>
<td class="markdown">
<p>Region Codes</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.16965743965729518">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.16965743965729518" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.01668558078775262">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.01668558078775262" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8234527796973368">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8234527796973368" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.2952004834714377">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.2952004834714377" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5586035216804808">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5586035216804808" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.786574017167551">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.786574017167551" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.4019437928947418">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4019437928947418"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3992946472945207">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3992946472945207">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeliveryDetailsExportRequestDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Start date</p>
</span>,</div>
<div><span class="propName ">to</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>End date</p>
</span>,</div>
<div><span class="propName ">filters</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Filters</p>
</span>,</div>
<div><span class="propName ">regionCodes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Region Codes</p>
</span>,</div>
<div><span class="propName ">search</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Search</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">from</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">to</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">filters</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">regionCodes</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">search</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.8209416656552444">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.8209416656552444">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8489690485491437">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8489690485491437" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.18751673867220497">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.18751673867220497" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6061009784765723">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6061009784765723"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4260117921912814">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4260117921912814">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">InitiateUpgradeRequest {</span>
<div><span class="propWrap"><span class="propName ">mobile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>mobile</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.58641023486605">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.58641023486605"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.32214720969627453">Parameter content type:</label>
<select name="parameterContentType" id="pct0.32214720969627453">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConfirmUpgradeRequestDto {</span>
<div><span class="propName required">secret</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>secret</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7948572703183439">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7948572703183439"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9679496124006495">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9679496124006495">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AccountRequest {</span>
<div><span class="propName ">signature</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>signature</p>
</span>,</div>
<div><span class="propName ">signatureEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>signature enabled?</p>
</span>,</div>
<div><span class="propName ">defaultMsisdn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>default MSISDN</p>
</span>,</div>
<div><span class="propName ">messageLimit</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message limit for timegap</p>
</span>,</div>
<div><span class="propName ">messageLimitTimegap</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>limit timegap (hour, day, week, month, year)</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">signature</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">signatureEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">defaultMsisdn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageLimit</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">messageLimitTimegap</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6511982945203176">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6511982945203176"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.30345042620728524">Parameter content type:</label>
<select name="parameterContentType" id="pct0.30345042620728524">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ChangePasswordRequest {</span>
<div><span class="propName required">oldPassword</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>old password</p>
</span>,</div>
<div><span class="propName required">newPassword</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>new password</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">oldPassword</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">newPassword</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9540813465892748">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9540813465892748"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6832545958599054">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6832545958599054">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OptInRequestDto {</span>
<div><span class="propName ">showAllGroups</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>show all groups?</p>
</span>,</div>
<div><span class="propName ">contactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact group id list</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">showAllGroups</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">contactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.5769365945433669">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.5769365945433669" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mfilter0.02736063343815376">filter</label></td>
<td>
<input class="parameter" minlength="0" name="filter" placeholder="" id="mfilter0.02736063343815376" type="text" value="">
</td>
<td class="markdown">
<p>Filter</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCode0.5143193204064225">regionCode</label></td>
<td>
<input class="parameter" minlength="0" name="regionCode" placeholder="" id="mregionCode0.5143193204064225" type="text" value="">
</td>
<td class="markdown">
<p>Region Code</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.7268952645143847">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.7268952645143847" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.6083202240677277">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.6083202240677277" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.8257487328912563">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8257487328912563" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9412349134533842">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9412349134533842" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.21678655331986763">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.21678655331986763" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilters0.15561237008212592">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.15561237008212592" type="text" value="">
</td>
<td class="markdown">
<p>Filters</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCodes0.7494596922462922">regionCodes</label></td>
<td>
<input class="parameter" minlength="0" name="regionCodes" placeholder="" id="mregionCodes0.7494596922462922" type="text" value="">
</td>
<td class="markdown">
<p>Region Codes</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.306317973786143">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.306317973786143" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.9156768207326276">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.9156768207326276" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad Request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.7900800957411831">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.7900800957411831" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.430486663174765">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.430486663174765" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9377744075880823">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9377744075880823" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9168624288571485">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9168624288571485" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.8925563786065467">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8925563786065467" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mfile0.3067428765350433">file</label></td>
<td>
<input type="file" name="file" id="mfile0.3067428765350433">
<div class="parameter-content-type"></div>
</td>
<td class="markdown"></td>
<td>formData</td>
<td>
<span class="model-signature">undefined</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9426508226632153">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9426508226632153" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.07505602888071339">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.07505602888071339" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.5185132134631638">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.5185132134631638"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.06694718326552529">Parameter content type:</label>
<select name="parameterContentType" id="pct0.06694718326552529">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConvergedConfigurationRequest {</span>
<div><span class="propName ">senderDisplayName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sender display name</p>
</span>,</div>
<div><span class="propName ">senderDisplayImageUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sender display image URL</p>
</span>,</div>
<div><span class="propName ">failoverTimeout</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>failover time in seconds</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">senderDisplayName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">senderDisplayImageUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">failoverTimeout</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9376615783596132">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9376615783596132"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3789179354177252">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3789179354177252">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">WhatsappConfigurationRequest {</span>
<div><span class="propName ">defaultContactGroupIds</span> (<span class="propType">Array[integer]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>default contact group ids</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">defaultContactGroupIds</span></span>": <span class="value"><span class="value">[
<span class="number"><span class="number">0</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mformat0.8182081118219082">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.8182081118219082" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.7339917890933914">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.7339917890933914" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.16164522912205204">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.16164522912205204" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.583096878347328">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.583096878347328" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilters0.1816579489928012">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.1816579489928012" type="text" value="">
</td>
<td class="markdown">
<p>Filters</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCodes0.38668488458827466">regionCodes</label></td>
<td>
<input class="parameter" minlength="0" name="regionCodes" placeholder="" id="mregionCodes0.38668488458827466" type="text" value="">
</td>
<td class="markdown">
<p>Region Codes</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.06899750360124668">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.06899750360124668" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.8637504290334515">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.8637504290334515" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.38203749716121793">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.38203749716121793" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.0526867502468753">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.0526867502468753" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.793492131036053">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.793492131036053" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5089619357288093">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5089619357288093" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.40016871788530484">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.40016871788530484" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.06183515636305481">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.06183515636305481" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.9023396728331761">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.9023396728331761" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.9610764009800905">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.9610764009800905" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.8822460688168299">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8822460688168299" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.4736608224477057">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.4736608224477057" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.5286258346084838">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.5286258346084838" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.8904891074051724">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8904891074051724"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4338594547492929">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4338594547492929">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.9858996200016275">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.9858996200016275">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.8025715438000356">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8025715438000356" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.5467512619755555">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.5467512619755555" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.8411159947927958">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8411159947927958"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7547950083510098">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7547950083510098">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeliveryDetailsExportRequestDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Start date</p>
</span>,</div>
<div><span class="propName ">to</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>End date</p>
</span>,</div>
<div><span class="propName ">filters</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Filters</p>
</span>,</div>
<div><span class="propName ">regionCodes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Region Codes</p>
</span>,</div>
<div><span class="propName ">search</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Search</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">from</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">to</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">filters</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">regionCodes</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">search</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.08684682861130955">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.08684682861130955">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.9208420952170291">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.9208420952170291" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.7492905115135642">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.7492905115135642" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.4730197449745235">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.4730197449745235" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.8775112215843044">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.8775112215843044" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.7982364490389426">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.7982364490389426" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.9308488114144942">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.9308488114144942" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="midentityId0.5387877610416494">identityId</label></td>
<td>
<input class="parameter required" minlength="1" name="identityId" placeholder="(required)" id="midentityId0.5387877610416494" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7228856012106981">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7228856012106981"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5877926791693306">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5877926791693306">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">JwtRequest {</span>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>base64 encoded JWT</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">value</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.06524935752623473">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.06524935752623473"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5907488900829081">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5907488900829081">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProfileRequest {</span>
<div><span class="propName ">firstname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account profile display firstname</p>
</span>,</div>
<div><span class="propName ">lastname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account profile display lastname</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">msisdn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account profile display msisdn</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^|\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">firstname</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">lastname</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">msisdn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mfile0.2949293781953173">file</label></td>
<td>
<input type="file" name="file" id="mfile0.2949293781953173">
<div class="parameter-content-type"></div>
</td>
<td class="markdown"></td>
<td>formData</td>
<td>
<span class="model-signature">undefined</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.2608631120449385">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.2608631120449385"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7825626032382318">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7825626032382318">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RequestIdentityTokenRequestDto {</span>
<div><span class="propWrap"><span class="propName ">identityType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>identity type</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(?i)(msisdn)$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>value (e.g. msisdn)</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+?[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">identityType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">value</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7294234131219315">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7294234131219315"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3503287461878053">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3503287461878053">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConfirmIdentityTokenRequestDto {</span>
<div><span class="propName ">identityToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>identity token</p>
</span>,</div>
<div><span class="propName ">secret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>secret</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">identityToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.19039925563919602">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.19039925563919602"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5429679654834776">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5429679654834776">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">EnableTwoFactor {</span>
<div><span class="propName ">identityToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">identityToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.9562912679904894">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.9562912679904894"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.42839317950887645">Parameter content type:</label>
<select name="parameterContentType" id="pct0.42839317950887645">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DisableTwoFactor {</span>
<div><span class="propName ">identityToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">identityToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.46695960371943857">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.46695960371943857"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8657267185778195">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8657267185778195">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">LicenceRequest {</span>
<div><span class="propName ">licenceTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>licence type</p>
</span>,</div>
<div><span class="propName ">quantity</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>quantity</p>
</span>,</div>
<div><span class="propName ">startDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>start date</p>
</span>,</div>
<div><span class="propName ">endDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>end date</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">licenceTypeId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">quantity</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">startDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">endDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.19603072271781108">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.19603072271781108" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="msearch0.3595331241196331">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.3595331241196331" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.7878533519840096">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.7878533519840096" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilter0.5921660845470058">filter</label></td>
<td>
<input class="parameter" minlength="0" name="filter" placeholder="" id="mfilter0.5921660845470058" type="text" value="">
</td>
<td class="markdown">
<p>Filter predefined categories (BASE, ADDON, SMS, WAB, …) </p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.052458895073990375">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.052458895073990375"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9129875347422012">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9129875347422012">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">LicenceVerifyRequest {</span>
<div><span class="propName required">licenceType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>licence type</p>
</span>,</div>
<div><span class="propName ">licenceSubType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>optional sub type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">licenceType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">licenceSubType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.030438695774609226">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.030438695774609226" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mfilter0.6874897522295336">filter</label></td>
<td>
<input class="parameter" minlength="0" name="filter" placeholder="" id="mfilter0.6874897522295336" type="text" value="">
</td>
<td class="markdown">
<p>Filter</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCode0.1484870271373595">regionCode</label></td>
<td>
<input class="parameter" minlength="0" name="regionCode" placeholder="" id="mregionCode0.1484870271373595" type="text" value="">
</td>
<td class="markdown">
<p>Region Code</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.3034586544478961">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.3034586544478961" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.5534901354625001">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.5534901354625001" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.9397302559499456">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.9397302559499456" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.5514612786676814">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.5514612786676814" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6503289560565535">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6503289560565535" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.15927661422110662">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.15927661422110662" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.1200324121855112">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.1200324121855112" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.2806527848634217">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.2806527848634217" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilters0.03386870250779306">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.03386870250779306" type="text" value="">
</td>
<td class="markdown">
<p>Filters</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCodes0.2654679810621583">regionCodes</label></td>
<td>
<input class="parameter" minlength="0" name="regionCodes" placeholder="" id="mregionCodes0.2654679810621583" type="text" value="">
</td>
<td class="markdown">
<p>Region Codes</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.11965164474247914">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.11965164474247914" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.5364838847989697">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.5364838847989697" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad Request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mformat0.21064582196383586">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.21064582196383586" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.43622314498661807">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.43622314498661807" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.47586147735823725">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.47586147735823725" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.4555927425111359">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.4555927425111359" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilters0.501588011974361">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.501588011974361" type="text" value="">
</td>
<td class="markdown">
<p>Filters</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCodes0.7216421436917344">regionCodes</label></td>
<td>
<input class="parameter" minlength="0" name="regionCodes" placeholder="" id="mregionCodes0.7216421436917344" type="text" value="">
</td>
<td class="markdown">
<p>Region Codes</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.7058192299210344">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.7058192299210344" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.26348268577391365">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.26348268577391365" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.8660919830051652">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.8660919830051652" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.7859879323142294">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.7859879323142294" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.42354784779088894">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.42354784779088894" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.12041506701015336">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.12041506701015336" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.48225488645058756">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.48225488645058756" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.17639548923701343">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.17639548923701343" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.5482816385388585">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.5482816385388585" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.36317953663741953">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.36317953663741953" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.7865498380728613">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.7865498380728613" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.4367801430260254">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.4367801430260254"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.15264550828463563">Parameter content type:</label>
<select name="parameterContentType" id="pct0.15264550828463563">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeliveryDetailsExportRequestDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Start date</p>
</span>,</div>
<div><span class="propName ">to</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>End date</p>
</span>,</div>
<div><span class="propName ">filters</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Filters</p>
</span>,</div>
<div><span class="propName ">regionCodes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Region Codes</p>
</span>,</div>
<div><span class="propName ">search</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Search</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">from</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">to</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">filters</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">regionCodes</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">search</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.31195772025834856">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.31195772025834856">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.6489574332233028">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.6489574332233028" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.5265150349421426">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.5265150349421426" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.9442047453411817">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.9442047453411817" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.9074278323064267">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.9074278323064267" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.6970644094708378">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6970644094708378"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7730828790611233">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7730828790611233">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ExportResponseDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName required">id</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>id</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">AsyncState</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>state</p>
</span>,</div>
<div><span class="propName ">links</span> (<span class="propType">Array[Link]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>links</p>
</span></div><span class="strong">}</span><br><span class="strong">AsyncState {</span>
<div><span class="propName ">done</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task done?</p>
</span>,</div>
<div><span class="propName ">progress</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>progress in percentage</p>
</span>,</div>
<div><span class="propName ">error</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>task error?</p>
</span></div><span class="strong">}</span><br><span class="strong">Link {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">done</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">progress</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">error</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.5669903637543598">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.5669903637543598">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.3209982663804185">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.3209982663804185" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.12944382788847375">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.12944382788847375" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselector0.9849232435083861">selector</label></td>
<td>
<input class="parameter required" minlength="1" name="selector" placeholder="(required)" id="mselector0.9849232435083861" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.3825835094611627">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.3825835094611627" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.3300822736051354">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.3300822736051354" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.4748864716654444">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.4748864716654444" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.434631999897086">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.434631999897086" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.9574783668834148">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.9574783668834148" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No content</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9257923072801679">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9257923072801679" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.5974728510800924">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.5974728510800924" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.8593056188441868">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.8593056188441868" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.5712839674664296">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.5712839674664296" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.8693315887985229">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.8693315887985229"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3215776385211542">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3215776385211542">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerRequest {</span>
<div><span class="propName ">signature</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>signature</p>
</span>,</div>
<div><span class="propName ">optInCssUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>optin css url</p>
</span>,</div>
<div><span class="propName ">optInCssContent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>optin css content</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">signature</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">optInCssUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">optInCssContent</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mfilter0.9663584460421235">filter</label></td>
<td>
<input class="parameter" minlength="0" name="filter" placeholder="" id="mfilter0.9663584460421235" type="text" value="">
</td>
<td class="markdown">
<p>Filter</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCode0.8516177959864588">regionCode</label></td>
<td>
<input class="parameter" minlength="0" name="regionCode" placeholder="" id="mregionCode0.8516177959864588" type="text" value="">
</td>
<td class="markdown">
<p>Region Code</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.5928901778162468">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.5928901778162468" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.911907321436525">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.911907321436525" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9949531900105568">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9949531900105568" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mfilter0.15420162805745874">filter</label></td>
<td>
<input class="parameter" minlength="0" name="filter" placeholder="" id="mfilter0.15420162805745874" type="text" value="">
</td>
<td class="markdown">
<p>Filter</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCode0.7580652578373284">regionCode</label></td>
<td>
<input class="parameter" minlength="0" name="regionCode" placeholder="" id="mregionCode0.7580652578373284" type="text" value="">
</td>
<td class="markdown">
<p>Region Code</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.028764831042922268">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.028764831042922268" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.726259041395934">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.726259041395934" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.7856479678268962">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.7856479678268962" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.3502513716707578">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.3502513716707578" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.8536523775282565">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.8536523775282565" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.8766756835220779">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.8766756835220779" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilters0.5367254045488967">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.5367254045488967" type="text" value="">
</td>
<td class="markdown">
<p>Filters</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCodes0.2263057971683735">regionCodes</label></td>
<td>
<input class="parameter" minlength="0" name="regionCodes" placeholder="" id="mregionCodes0.2263057971683735" type="text" value="">
</td>
<td class="markdown">
<p>Region Codes</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.0010024678008075938">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.0010024678008075938" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.975254236646149">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.975254236646149" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad Request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6538494041014973">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6538494041014973"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8410099343704989">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8410099343704989">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerContactPersonRequest {</span>
<div><span class="propName ">mainContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact salutation</p>
</span>,</div>
<div><span class="propName ">mainContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact title</p>
</span>,</div>
<div><span class="propName ">mainContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact first name</p>
</span>,</div>
<div><span class="propName ">mainContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mainContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">mainContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>main contact email address</p>
</span>,</div>
<div><span class="propName ">techContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>tech contact salutation</p>
</span>,</div>
<div><span class="propName ">techContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>tech contact title</p>
</span>,</div>
<div><span class="propName ">techContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>tech contact first name</p>
</span>,</div>
<div><span class="propName ">techContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">techContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">techContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>contact email address</p>
</span>,</div>
<div><span class="propName ">adminContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact salutation</p>
</span>,</div>
<div><span class="propName ">adminContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact title</p>
</span>,</div>
<div><span class="propName ">adminContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact first name</p>
</span>,</div>
<div><span class="propName ">adminContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">adminContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">adminContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>admin contact email address</p>
</span>,</div>
<div><span class="propName ">commercialContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact salutation</p>
</span>,</div>
<div><span class="propName ">commercialContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact title</p>
</span>,</div>
<div><span class="propName ">commercialContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact first name</p>
</span>,</div>
<div><span class="propName ">commercialContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">commercialContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">commercialContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>commercial contact email address</p>
</span>,</div>
<div><span class="propName ">marketingContactSalutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact salutation</p>
</span>,</div>
<div><span class="propName ">marketingContactTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact title</p>
</span>,</div>
<div><span class="propName ">marketingContactFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact first name</p>
</span>,</div>
<div><span class="propName ">marketingContactLastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact last name</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">marketingContactPhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact phone number</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>(\+[0-9]{1,15})?</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">marketingContactEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>marketing contact email address</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">mainContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mainContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">techContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">commercialContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactSalutation</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactTitle</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactFirstName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactLastName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactPhoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">marketingContactEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Update forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6556477566159145">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6556477566159145"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.14172784852359221">Parameter content type:</label>
<select name="parameterContentType" id="pct0.14172784852359221">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerContractDetailRequest {</span>
<div><span class="propWrap"><span class="propName ">companyName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company name</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">companyStreet</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company street</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">companyZipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company zip code</p>
</span>,</div>
<div><span class="propName ">companyCity</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company city</p>
</span>,</div>
<div><span class="propName ">companyCountry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company country</p>
</span>,</div>
<div><span class="propName ">companySectorIndustryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>sector industry id</p>
</span>,</div>
<div><span class="propName ">companySizeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company size id</p>
</span>,</div>
<div><span class="propName ">companyUseCaseId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company use case id</p>
</span>,</div>
<div><span class="propName ">companyUseCase</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>company use case other text</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">invoicingCompanyName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company name</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">invoicingCompanyStreet</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company street</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^$|^([^ ]{1,50})( [^ ]{0,50})?$</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">invoicingCompanyZipCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company zip code</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyCity</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company city</p>
</span>,</div>
<div><span class="propName ">invoicingCompanyCountry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoicing company country</p>
</span>,</div>
<div><span class="propName ">accountBic</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account bic</p>
</span>,</div>
<div><span class="propName ">accountIban</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account iban</p>
</span>,</div>
<div><span class="propName ">invoiceRecipient</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>invoice recipient</p>
</span>,</div>
<div><span class="propName ">geteInvoiceEmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>einvoice email address</p>
</span>,</div>
<div><span class="propName ">iseInvoiceEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>einvoice enabled</p>
</span>,</div>
<div><span class="propName ">directDebitEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>direct debit enabled</p>
</span>,</div>
<div><span class="propName ">vatId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>vat id</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">companyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyStreet</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyZipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyCity</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyCountry</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">companySectorIndustryId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companySizeId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyUseCaseId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">companyUseCase</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyStreet</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyZipCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyCity</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoicingCompanyCountry</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountBic</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountIban</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">invoiceRecipient</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">geteInvoiceEmailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">iseInvoiceEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">directDebitEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">vatId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Update forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.13889414122057087">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.13889414122057087"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.07608015442987837">Parameter content type:</label>
<select name="parameterContentType" id="pct0.07608015442987837">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomerContractPaymentRequest {</span>
<div><span class="propName ">paymentMethod</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>payment method</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">paymentMethod</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Update forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.6030384883289597">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.6030384883289597"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.050889251737390895">Parameter content type:</label>
<select name="parameterContentType" id="pct0.050889251737390895">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SepaPaymentApprovalRequest {</span>
<div><span class="propName ">accountIban</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account iban</p>
</span>,</div>
<div><span class="propName ">accountBic</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>account bic</p>
</span>,</div>
<div><span class="propName ">bankAccept</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>bank accept debit and bank confirm business</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">accountIban</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">accountBic</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">bankAccept</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Update forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mquery0.4461526479790694">query</label></td>
<td>
<input class="parameter" minlength="0" name="query" placeholder="" id="mquery0.4461526479790694" type="text" value="">
</td>
<td class="markdown">
<p>FIQL/RSQL query string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.18470967181828946">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.18470967181828946" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.4261608232038254">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.4261608232038254" type="text" value="">
</td>
<td class="markdown">
<p>Sorts response by given fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.4052953612553116">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.4052953612553116" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.596438847058443">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.596438847058443" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7965669808016862">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7965669808016862"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.028284684710980335">Parameter content type:</label>
<select name="parameterContentType" id="pct0.028284684710980335">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">VoucherRequest {</span>
<div><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>voucher type</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">type</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td class="markdown">
<p>Created</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5476335668439138">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5476335668439138" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mformat0.4414833848253157">format</label></td>
<td>
<input class="parameter" minlength="0" name="format" placeholder="" id="mformat0.4414833848253157" type="text" value="">
</td>
<td class="markdown">
<p>Export format (pdf, csv, xsl)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.9570896233915349">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.9570896233915349" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6737519663706679">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6737519663706679" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.8227668635535588">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.8227668635535588" type="text" value="">
</td>
<td class="markdown">
<p>Search string</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilters0.0881808147358738">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.0881808147358738" type="text" value="">
</td>
<td class="markdown">
<p>Filters</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mregionCodes0.8993801450720584">regionCodes</label></td>
<td>
<input class="parameter" minlength="0" name="regionCodes" placeholder="" id="mregionCodes0.8993801450720584" type="text" value="">
</td>
<td class="markdown">
<p>Region Codes</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfrom0.9170692615941565">from</label></td>
<td>
<input class="parameter" minlength="0" name="from" placeholder="" id="mfrom0.9170692615941565" type="text" value="">
</td>
<td class="markdown">
<p>Start date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mto0.8188014418534575">to</label></td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" id="mto0.8188014418534575" type="text" value="">
</td>
<td class="markdown">
<p>End date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.07098462495009672">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.07098462495009672" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.7365579134720877">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.7365579134720877" type="text" value="1">
</td>
<td class="markdown">
<p>Request a specific page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.6679731651039242">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.6679731651039242" type="text" value="10">
</td>
<td class="markdown">
<p>Sets size of a page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.14960383033706992">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.14960383033706992" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mbody0.574056167584279">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.574056167584279"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5475550584421678">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5475550584421678">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeliveryDetailsExportRequestDto {</span>
<div><span class="propName ">query</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>FIQL/RSQL query string</p>
</span>,</div>
<div><span class="propName ">sort</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sorts response by given fields</p>
</span>,</div>
<div><span class="propName ">page</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Request a specific page</p>
</span>,</div>
<div><span class="propName ">size</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets size of a page</p>
</span>,</div>
<div><span class="propName ">format</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Export format (pdf, csv, xsl)</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Start date</p>
</span>,</div>
<div><span class="propName ">to</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>End date</p>
</span>,</div>
<div><span class="propName ">filters</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Filters</p>
</span>,</div>
<div><span class="propName ">regionCodes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Region Codes</p>
</span>,</div>
<div><span class="propName ">search</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Search</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">query</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sort</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">page</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">size</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">format</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">from</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">to</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">filters</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">regionCodes</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">search</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
<tr>
<td class="code"><label for="masync0.9698091627154757">async</label></td>
<td>
<select class="parameter " name="async" id="masync0.9698091627154757">
<option value=""></option>
<option selected="" value="true"> true (default) </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Process request asynchronous</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.6865407435055606">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6865407435055606" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskId0.20872695588707546">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.20872695588707546" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.35626602413235964">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.35626602413235964"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9333788538463925">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9333788538463925">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">InitiateUpgradeRequest {</span>
<div><span class="propWrap"><span class="propName ">mobile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>mobile</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>\+[0-9]{1,15}</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">mobile</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.2055249701574431">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.2055249701574431"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.04522866653618163">Parameter content type:</label>
<select name="parameterContentType" id="pct0.04522866653618163">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConfirmUpgradeRequestDto {</span>
<div><span class="propName required">secret</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>secret</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">secret</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.7193506799903076">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.7193506799903076"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8978474364737652">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8978474364737652">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">FeedbackRequest {</span>
<div><span class="propName required">content</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>content</p>
</span>,</div>
<div><span class="propName ">replyTo</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>reply to (optional)</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">content</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">replyTo</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.03842370909769022">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.03842370909769022"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8098736128037733">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8098736128037733">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">LogRequest {</span>
<div><span class="propName required">level</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>level (debug, info, warn, error)</p>
</span>,</div>
<div><span class="propName ">category</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>category</p>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>message</p>
</span>,</div>
<div><span class="propName ">stacktrace</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message</p>
</span>,</div>
<div><span class="propName ">screenshot</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>screenshot (base64)</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">level</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">category</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stacktrace</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">screenshot</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mbody0.3232391054011843">body</label></td>
<td>
<textarea class="body-textarea" name="body" id="mbody0.3232391054011843"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="pct0.44475967982392195">Parameter content type:</label>
<select name="parameterContentType" id="pct0.44475967982392195">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">LogRequest {</span>
<div><span class="propName required">level</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>level (debug, info, warn, error)</p>
</span>,</div>
<div><span class="propName ">category</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>category</p>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>message</p>
</span>,</div>
<div><span class="propName ">stacktrace</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>message</p>
</span>,</div>
<div><span class="propName ">screenshot</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>screenshot (base64)</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">level</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">category</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stacktrace</span></span>": <span class="value"><span class="value">[
<span class="string"><span class="string">"string"</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">screenshot</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
<th>Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form>Text Content
swagger
Explore
* APPLETS : APPLET API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /V1/APPLETS/{ID}
* Deletes applet
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/APPLETS/{ID}
* Returns applet
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/APPLETS/{ID}
* Updates applet
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
AppletRequest {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/APPLETS/{ID}/OPTIN
* Deletes optin applet
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/APPLETS/{ID}/OPTIN
* Returns optin applet
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/APPLETS/{ID}/OPTIN
* Updates optin applet
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
AppletRequest {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/APPLETS/{ID}/OPTOUT
* Deletes optout applet
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/APPLETS/{ID}/OPTOUT
* Returns optout applet
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/APPLETS/{ID}/OPTOUT
* Updates optout applet
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
AppletRequest {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/APPLETS/{ID}/WAT_DEVICE_SUBSCRIPTION
* Deletes wat_device_subscription applet
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/APPLETS/{ID}/WAT_DEVICE_SUBSCRIPTION
* Returns wat_device_subscription applet
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/APPLETS/{ID}/WAT_DEVICE_SUBSCRIPTION
* Updates wat_device_subscription applet
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
AppletRequest {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/APPLETS
* Returns all applets
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer contactGroupId
Filters results by contact group ids
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/APPLETS
* Adds applet
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
AppletRequest {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/APPLETS/OPTIN
* Adds optin applet
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
AppletRequest {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/APPLETS/OPTOUT
* Adds optout applet
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
AppletRequest {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/APPLETS/WAT_DEVICE_SUBSCRIPTION
* Adds wat_device_subscription applet
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
AppletRequest {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/APPLETS/{ID}/CLONE
* Clones applet
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CloneAppletRequest {
name (string, optional):
name
}
{
"name": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/APPLETS/{ID}/OPTIN/CLONE
* Clones optin applet
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CloneAppletRequest {
name (string, optional):
name
}
{
"name": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/APPLETS/{ID}/OPTOUT/CLONE
* Clones optout applet
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CloneAppletRequest {
name (string, optional):
name
}
{
"name": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/APPLETS/{ID}/WAT_DEVICE_SUBSCRIPTION/CLONE
* Clones wat_device_subscription applet
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
AppletResponse {
type (string, optional):
type (optin, optout)
stringReg. Exp.:^(?i)(optin|optout|wat_device_subscription)$
,
name (string, optional):
name
,
locale (string, optional):
locale
stringReg.
Exp.:^(de|de_DE|de_AT|de_IT|de_CH|it|it_IT|it_CH|en|en_GB|en_US)$
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
stringReg. Exp.:^(websms|light)$
,
id (integer, optional):
applet id
,
url (string, optional):
url
,
uri (string, optional):
uri
,
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"name": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"id": 0,
"url": "string",
"uri": "string",
"lastModifiedBy": "string",
"createdBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CloneAppletRequest {
name (string, optional):
name
}
{
"name": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/APPLETS/{ID}/OPTIN/CONFIGURATION
* Returns optin configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletOptInConfigurationResponseDto {
components (AppletOptInConfigurationComponentsRequestDto, optional):
components
,
messages (AppletOptInConfigurationMessagesRequestDto, optional):
messages
,
kioskMode (boolean, optional):
kiosk mode
,
whatsappAvailable (boolean, optional):
whatsapp available
,
smsAvailable (boolean, optional):
sms available
,
links (Array[Link], optional):
links
}
AppletOptInConfigurationComponentsRequestDto {
title (AppletOptInConfigurationComponentFieldRequestDto, optional):
title
,
intro (AppletOptInConfigurationComponentTextareaRequestDto, optional):
intro
,
contactGroups (AppletOptInConfigurationComponentContactGroupsRequestDto):
contact groups
,
firstName (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
first name
,
lastName (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
last name
,
emailAddress (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
email address
,
contactTitle (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
title
,
nickname (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
nickname
,
landline (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
landline phone number
,
fax (AppletOptInConfigurationComponentContactFieldRequestDto, optional):
fax
,
birthday (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
birthday
,
homepage (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
homepage
,
instantMessenger
(AppletOptInConfigurationComponentContactFieldRequestDto, optional):
instant messenger user
,
skype (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
skype
,
remarks (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
custom remarks
,
street (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
street
,
zipCode (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
zip code
,
city (AppletOptInConfigurationComponentContactFieldRequestDto, optional):
city
,
country (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
country
,
company (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
company name
,
department (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
department
,
bureau (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
bureau
,
position (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
position
,
jobTitle (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
job title
,
msisdn (AppletOptInConfigurationComponentMsisdnRequestDto):
msisdn
,
logo (AppletOptInConfigurationComponentAttachmentRequestDto, optional):
logo
,
appletTitle (AppletOptInConfigurationComponentFieldRequestDto, optional):
applet title
,
companyName (AppletOptInConfigurationComponentFieldRequestDto, optional):
company name
,
labelChannelSelection (AppletOptInConfigurationComponentFieldRequestDto,
optional):
label channel selection
,
labelContactGroupSelection
(AppletOptInConfigurationComponentFieldRequestDto, optional):
label contact group selection
,
labelWhatsappMsisdn (AppletOptInConfigurationComponentFieldRequestDto,
optional):
label whatsapp msisdn
,
titleMsisdnVerificationSuccessful
(AppletOptInConfigurationComponentFieldRequestDto, optional):
title msisdn verification successful
,
descriptionMsisdnVerificationSuccessful
(AppletOptInConfigurationComponentTextareaRequestDto, optional):
description msisdn verification successful
,
termsAndConditions
(AppletOptInConfigurationComponentTermsAndConditionsRequestDto,
optional):
terms and conditions
}
AppletOptInConfigurationMessagesRequestDto {
pinSms (AppletOptInConfigurationMessageRequestDto):
pin sms
,
welcomeSms (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
welcome sms
,
welcomeWhatsapp (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
welcome whatsapp
,
isBlacklisted (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
is blacklisted
,
whatsappMsisdn (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
whatsapp msisdn sms
}
Link {
rel (string, optional),
href (string, optional)
}
AppletOptInConfigurationComponentFieldRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptInConfigurationComponentTextareaRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptInConfigurationComponentContactGroupsRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
contactGroupIds (Array[integer], optional):
contact group ids
}
AppletOptInConfigurationComponentContactFieldRequestDto {
content (string, optional):
content
,
required (boolean, optional):
required
,
position (integer, optional):
position
}
AppletOptInConfigurationComponentMsisdnRequestDto {
content (string, optional):
content
,
position (integer, optional):
position
,
optinChannels (Array[string], optional):
opt in channels
}
AppletOptInConfigurationComponentAttachmentRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
attachmentId (integer, optional):
attachment id
integerMax. Value:9223372036854776000
,
attachmentMimeType (string, optional):
attachment mime type
}
AppletOptInConfigurationComponentTermsAndConditionsRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
,
required (boolean, optional):
required
}
AppletOptInConfigurationMessageRequestDto {
content (string, optional):
content
}
AppletOptInConfigurationActivatableMessageRequestDto {
content (string, optional):
content
,
active (boolean, optional):
active
}
{
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"contactGroups": {
"visible": true,
"position": 0,
"contactGroupIds": [
0
]
},
"firstName": {
"content": "string",
"required": true,
"position": 0
},
"lastName": {
"content": "string",
"required": true,
"position": 0
},
"emailAddress": {
"content": "string",
"required": true,
"position": 0
},
"contactTitle": {
"content": "string",
"required": true,
"position": 0
},
"nickname": {
"content": "string",
"required": true,
"position": 0
},
"landline": {
"content": "string",
"required": true,
"position": 0
},
"fax": {
"content": "string",
"required": true,
"position": 0
},
"birthday": {
"content": "string",
"required": true,
"position": 0
},
"homepage": {
"content": "string",
"required": true,
"position": 0
},
"instantMessenger": {
"content": "string",
"required": true,
"position": 0
},
"skype": {
"content": "string",
"required": true,
"position": 0
},
"remarks": {
"content": "string",
"required": true,
"position": 0
},
"street": {
"content": "string",
"required": true,
"position": 0
},
"zipCode": {
"content": "string",
"required": true,
"position": 0
},
"city": {
"content": "string",
"required": true,
"position": 0
},
"country": {
"content": "string",
"required": true,
"position": 0
},
"company": {
"content": "string",
"required": true,
"position": 0
},
"department": {
"content": "string",
"required": true,
"position": 0
},
"bureau": {
"content": "string",
"required": true,
"position": 0
},
"position": {
"content": "string",
"required": true,
"position": 0
},
"jobTitle": {
"content": "string",
"required": true,
"position": 0
},
"msisdn": {
"content": "string",
"position": 0,
"optinChannels": [
"string"
]
},
"logo": {
"visible": true,
"position": 0,
"attachmentId": 0,
"attachmentMimeType": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
},
"labelChannelSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"labelContactGroupSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"labelWhatsappMsisdn": {
"visible": true,
"position": 0,
"content": "string"
},
"titleMsisdnVerificationSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"descriptionMsisdnVerificationSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"termsAndConditions": {
"visible": true,
"position": 0,
"content": "string",
"required": true
}
},
"messages": {
"pinSms": {
"content": "string"
},
"welcomeSms": {
"content": "string",
"active": true
},
"welcomeWhatsapp": {
"content": "string",
"active": true
},
"isBlacklisted": {
"content": "string",
"active": true
},
"whatsappMsisdn": {
"content": "string",
"active": true
}
},
"kioskMode": true,
"whatsappAvailable": true,
"smsAvailable": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/APPLETS/{ID}/OPTIN/CONFIGURATION
* Updates applet
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletOptInConfigurationResponseDto {
components (AppletOptInConfigurationComponentsRequestDto, optional):
components
,
messages (AppletOptInConfigurationMessagesRequestDto, optional):
messages
,
kioskMode (boolean, optional):
kiosk mode
,
whatsappAvailable (boolean, optional):
whatsapp available
,
smsAvailable (boolean, optional):
sms available
,
links (Array[Link], optional):
links
}
AppletOptInConfigurationComponentsRequestDto {
title (AppletOptInConfigurationComponentFieldRequestDto, optional):
title
,
intro (AppletOptInConfigurationComponentTextareaRequestDto, optional):
intro
,
contactGroups (AppletOptInConfigurationComponentContactGroupsRequestDto):
contact groups
,
firstName (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
first name
,
lastName (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
last name
,
emailAddress (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
email address
,
contactTitle (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
title
,
nickname (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
nickname
,
landline (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
landline phone number
,
fax (AppletOptInConfigurationComponentContactFieldRequestDto, optional):
fax
,
birthday (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
birthday
,
homepage (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
homepage
,
instantMessenger
(AppletOptInConfigurationComponentContactFieldRequestDto, optional):
instant messenger user
,
skype (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
skype
,
remarks (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
custom remarks
,
street (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
street
,
zipCode (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
zip code
,
city (AppletOptInConfigurationComponentContactFieldRequestDto, optional):
city
,
country (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
country
,
company (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
company name
,
department (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
department
,
bureau (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
bureau
,
position (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
position
,
jobTitle (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
job title
,
msisdn (AppletOptInConfigurationComponentMsisdnRequestDto):
msisdn
,
logo (AppletOptInConfigurationComponentAttachmentRequestDto, optional):
logo
,
appletTitle (AppletOptInConfigurationComponentFieldRequestDto, optional):
applet title
,
companyName (AppletOptInConfigurationComponentFieldRequestDto, optional):
company name
,
labelChannelSelection (AppletOptInConfigurationComponentFieldRequestDto,
optional):
label channel selection
,
labelContactGroupSelection
(AppletOptInConfigurationComponentFieldRequestDto, optional):
label contact group selection
,
labelWhatsappMsisdn (AppletOptInConfigurationComponentFieldRequestDto,
optional):
label whatsapp msisdn
,
titleMsisdnVerificationSuccessful
(AppletOptInConfigurationComponentFieldRequestDto, optional):
title msisdn verification successful
,
descriptionMsisdnVerificationSuccessful
(AppletOptInConfigurationComponentTextareaRequestDto, optional):
description msisdn verification successful
,
termsAndConditions
(AppletOptInConfigurationComponentTermsAndConditionsRequestDto,
optional):
terms and conditions
}
AppletOptInConfigurationMessagesRequestDto {
pinSms (AppletOptInConfigurationMessageRequestDto):
pin sms
,
welcomeSms (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
welcome sms
,
welcomeWhatsapp (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
welcome whatsapp
,
isBlacklisted (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
is blacklisted
,
whatsappMsisdn (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
whatsapp msisdn sms
}
Link {
rel (string, optional),
href (string, optional)
}
AppletOptInConfigurationComponentFieldRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptInConfigurationComponentTextareaRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptInConfigurationComponentContactGroupsRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
contactGroupIds (Array[integer], optional):
contact group ids
}
AppletOptInConfigurationComponentContactFieldRequestDto {
content (string, optional):
content
,
required (boolean, optional):
required
,
position (integer, optional):
position
}
AppletOptInConfigurationComponentMsisdnRequestDto {
content (string, optional):
content
,
position (integer, optional):
position
,
optinChannels (Array[string], optional):
opt in channels
}
AppletOptInConfigurationComponentAttachmentRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
attachmentId (integer, optional):
attachment id
integerMax. Value:9223372036854776000
,
attachmentMimeType (string, optional):
attachment mime type
}
AppletOptInConfigurationComponentTermsAndConditionsRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
,
required (boolean, optional):
required
}
AppletOptInConfigurationMessageRequestDto {
content (string, optional):
content
}
AppletOptInConfigurationActivatableMessageRequestDto {
content (string, optional):
content
,
active (boolean, optional):
active
}
{
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"contactGroups": {
"visible": true,
"position": 0,
"contactGroupIds": [
0
]
},
"firstName": {
"content": "string",
"required": true,
"position": 0
},
"lastName": {
"content": "string",
"required": true,
"position": 0
},
"emailAddress": {
"content": "string",
"required": true,
"position": 0
},
"contactTitle": {
"content": "string",
"required": true,
"position": 0
},
"nickname": {
"content": "string",
"required": true,
"position": 0
},
"landline": {
"content": "string",
"required": true,
"position": 0
},
"fax": {
"content": "string",
"required": true,
"position": 0
},
"birthday": {
"content": "string",
"required": true,
"position": 0
},
"homepage": {
"content": "string",
"required": true,
"position": 0
},
"instantMessenger": {
"content": "string",
"required": true,
"position": 0
},
"skype": {
"content": "string",
"required": true,
"position": 0
},
"remarks": {
"content": "string",
"required": true,
"position": 0
},
"street": {
"content": "string",
"required": true,
"position": 0
},
"zipCode": {
"content": "string",
"required": true,
"position": 0
},
"city": {
"content": "string",
"required": true,
"position": 0
},
"country": {
"content": "string",
"required": true,
"position": 0
},
"company": {
"content": "string",
"required": true,
"position": 0
},
"department": {
"content": "string",
"required": true,
"position": 0
},
"bureau": {
"content": "string",
"required": true,
"position": 0
},
"position": {
"content": "string",
"required": true,
"position": 0
},
"jobTitle": {
"content": "string",
"required": true,
"position": 0
},
"msisdn": {
"content": "string",
"position": 0,
"optinChannels": [
"string"
]
},
"logo": {
"visible": true,
"position": 0,
"attachmentId": 0,
"attachmentMimeType": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
},
"labelChannelSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"labelContactGroupSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"labelWhatsappMsisdn": {
"visible": true,
"position": 0,
"content": "string"
},
"titleMsisdnVerificationSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"descriptionMsisdnVerificationSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"termsAndConditions": {
"visible": true,
"position": 0,
"content": "string",
"required": true
}
},
"messages": {
"pinSms": {
"content": "string"
},
"welcomeSms": {
"content": "string",
"active": true
},
"welcomeWhatsapp": {
"content": "string",
"active": true
},
"isBlacklisted": {
"content": "string",
"active": true
},
"whatsappMsisdn": {
"content": "string",
"active": true
}
},
"kioskMode": true,
"whatsappAvailable": true,
"smsAvailable": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
AppletOptInConfigurationRequestDto {
components (AppletOptInConfigurationComponentsRequestDto, optional):
components
,
messages (AppletOptInConfigurationMessagesRequestDto, optional):
messages
,
kioskMode (boolean, optional):
kiosk mode
}
AppletOptInConfigurationComponentsRequestDto {
title (AppletOptInConfigurationComponentFieldRequestDto, optional):
title
,
intro (AppletOptInConfigurationComponentTextareaRequestDto, optional):
intro
,
contactGroups (AppletOptInConfigurationComponentContactGroupsRequestDto):
contact groups
,
firstName (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
first name
,
lastName (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
last name
,
emailAddress (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
email address
,
contactTitle (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
title
,
nickname (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
nickname
,
landline (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
landline phone number
,
fax (AppletOptInConfigurationComponentContactFieldRequestDto, optional):
fax
,
birthday (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
birthday
,
homepage (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
homepage
,
instantMessenger
(AppletOptInConfigurationComponentContactFieldRequestDto, optional):
instant messenger user
,
skype (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
skype
,
remarks (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
custom remarks
,
street (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
street
,
zipCode (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
zip code
,
city (AppletOptInConfigurationComponentContactFieldRequestDto, optional):
city
,
country (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
country
,
company (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
company name
,
department (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
department
,
bureau (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
bureau
,
position (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
position
,
jobTitle (AppletOptInConfigurationComponentContactFieldRequestDto,
optional):
job title
,
msisdn (AppletOptInConfigurationComponentMsisdnRequestDto):
msisdn
,
logo (AppletOptInConfigurationComponentAttachmentRequestDto, optional):
logo
,
appletTitle (AppletOptInConfigurationComponentFieldRequestDto, optional):
applet title
,
companyName (AppletOptInConfigurationComponentFieldRequestDto, optional):
company name
,
labelChannelSelection (AppletOptInConfigurationComponentFieldRequestDto,
optional):
label channel selection
,
labelContactGroupSelection
(AppletOptInConfigurationComponentFieldRequestDto, optional):
label contact group selection
,
labelWhatsappMsisdn (AppletOptInConfigurationComponentFieldRequestDto,
optional):
label whatsapp msisdn
,
titleMsisdnVerificationSuccessful
(AppletOptInConfigurationComponentFieldRequestDto, optional):
title msisdn verification successful
,
descriptionMsisdnVerificationSuccessful
(AppletOptInConfigurationComponentTextareaRequestDto, optional):
description msisdn verification successful
,
termsAndConditions
(AppletOptInConfigurationComponentTermsAndConditionsRequestDto,
optional):
terms and conditions
}
AppletOptInConfigurationMessagesRequestDto {
pinSms (AppletOptInConfigurationMessageRequestDto):
pin sms
,
welcomeSms (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
welcome sms
,
welcomeWhatsapp (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
welcome whatsapp
,
isBlacklisted (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
is blacklisted
,
whatsappMsisdn (AppletOptInConfigurationActivatableMessageRequestDto,
optional):
whatsapp msisdn sms
}
AppletOptInConfigurationComponentFieldRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptInConfigurationComponentTextareaRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptInConfigurationComponentContactGroupsRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
contactGroupIds (Array[integer], optional):
contact group ids
}
AppletOptInConfigurationComponentContactFieldRequestDto {
content (string, optional):
content
,
required (boolean, optional):
required
,
position (integer, optional):
position
}
AppletOptInConfigurationComponentMsisdnRequestDto {
content (string, optional):
content
,
position (integer, optional):
position
,
optinChannels (Array[string], optional):
opt in channels
}
AppletOptInConfigurationComponentAttachmentRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
attachmentId (integer, optional):
attachment id
integerMax. Value:9223372036854776000
,
attachmentMimeType (string, optional):
attachment mime type
}
AppletOptInConfigurationComponentTermsAndConditionsRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
,
required (boolean, optional):
required
}
AppletOptInConfigurationMessageRequestDto {
content (string, optional):
content
}
AppletOptInConfigurationActivatableMessageRequestDto {
content (string, optional):
content
,
active (boolean, optional):
active
}
{
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"contactGroups": {
"visible": true,
"position": 0,
"contactGroupIds": [
0
]
},
"firstName": {
"content": "string",
"required": true,
"position": 0
},
"lastName": {
"content": "string",
"required": true,
"position": 0
},
"emailAddress": {
"content": "string",
"required": true,
"position": 0
},
"contactTitle": {
"content": "string",
"required": true,
"position": 0
},
"nickname": {
"content": "string",
"required": true,
"position": 0
},
"landline": {
"content": "string",
"required": true,
"position": 0
},
"fax": {
"content": "string",
"required": true,
"position": 0
},
"birthday": {
"content": "string",
"required": true,
"position": 0
},
"homepage": {
"content": "string",
"required": true,
"position": 0
},
"instantMessenger": {
"content": "string",
"required": true,
"position": 0
},
"skype": {
"content": "string",
"required": true,
"position": 0
},
"remarks": {
"content": "string",
"required": true,
"position": 0
},
"street": {
"content": "string",
"required": true,
"position": 0
},
"zipCode": {
"content": "string",
"required": true,
"position": 0
},
"city": {
"content": "string",
"required": true,
"position": 0
},
"country": {
"content": "string",
"required": true,
"position": 0
},
"company": {
"content": "string",
"required": true,
"position": 0
},
"department": {
"content": "string",
"required": true,
"position": 0
},
"bureau": {
"content": "string",
"required": true,
"position": 0
},
"position": {
"content": "string",
"required": true,
"position": 0
},
"jobTitle": {
"content": "string",
"required": true,
"position": 0
},
"msisdn": {
"content": "string",
"position": 0,
"optinChannels": [
"string"
]
},
"logo": {
"visible": true,
"position": 0,
"attachmentId": 0,
"attachmentMimeType": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
},
"labelChannelSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"labelContactGroupSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"labelWhatsappMsisdn": {
"visible": true,
"position": 0,
"content": "string"
},
"titleMsisdnVerificationSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"descriptionMsisdnVerificationSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"termsAndConditions": {
"visible": true,
"position": 0,
"content": "string",
"required": true
}
},
"messages": {
"pinSms": {
"content": "string"
},
"welcomeSms": {
"content": "string",
"active": true
},
"welcomeWhatsapp": {
"content": "string",
"active": true
},
"isBlacklisted": {
"content": "string",
"active": true
},
"whatsappMsisdn": {
"content": "string",
"active": true
}
},
"kioskMode": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/APPLETS/{ID}/OPTOUT/CONFIGURATION
* Returns optin configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletOptOutConfigurationResponseDto {
components (AppletOptOutConfigurationComponentsRequestDto, optional):
components
,
messages (AppletOptOutConfigurationMessagesRequestDto, optional):
messages
,
kioskMode (boolean, optional):
kiosk mode
,
blacklisting (AppletOptOutConfigurationBlacklistRequestDto, optional):
blacklisting
,
links (Array[Link], optional):
links
}
AppletOptOutConfigurationComponentsRequestDto {
title (AppletOptOutConfigurationComponentFieldRequestDto, optional):
title
,
intro (AppletOptOutConfigurationComponentTextareaRequestDto, optional):
intro
,
msisdn (AppletOptOutConfigurationComponentMsisdnRequestDto):
msisdn
,
contactGroups
(AppletOptOutConfigurationComponentContactGroupsRequestDto):
contact groups
,
logo (AppletOptOutConfigurationComponentAttachmentRequestDto, optional):
logo
,
appletTitle (AppletOptOutConfigurationComponentFieldRequestDto,
optional):
applet title
,
labelContactGroupSelection
(AppletOptOutConfigurationComponentFieldRequestDto, optional):
label contact group selection
,
titleOptOutSuccessful (AppletOptOutConfigurationComponentFieldRequestDto,
optional):
title opt out successful
,
descriptionOptOutSuccessful
(AppletOptOutConfigurationComponentTextareaRequestDto, optional):
description opt out successful
,
companyName (AppletOptOutConfigurationComponentFieldRequestDto,
optional):
company name
}
AppletOptOutConfigurationMessagesRequestDto {
pinSms (AppletOptOutConfigurationMessageRequestDto):
pin sms
,
goodbyeSms (AppletOptOutConfigurationActivatableMessageRequestDto,
optional):
goodbye sms
,
goodbyeWhatsapp (AppletOptOutConfigurationActivatableMessageRequestDto,
optional):
goodbye whatsapp
}
AppletOptOutConfigurationBlacklistRequestDto {
active (boolean, optional),
contentCategories (Array[string], optional)
}
Link {
rel (string, optional),
href (string, optional)
}
AppletOptOutConfigurationComponentFieldRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptOutConfigurationComponentTextareaRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptOutConfigurationComponentMsisdnRequestDto {
content (string, optional):
content
,
position (integer, optional):
position
}
AppletOptOutConfigurationComponentContactGroupsRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
contactGroupIds (Array[integer], optional):
contact group ids
}
AppletOptOutConfigurationComponentAttachmentRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
attachmentId (integer, optional):
attachment id
integerMax. Value:9223372036854776000
,
attachmentMimeType (string, optional):
attachment mime type
}
AppletOptOutConfigurationMessageRequestDto {
content (string, optional):
content
}
AppletOptOutConfigurationActivatableMessageRequestDto {
content (string, optional):
content
,
active (boolean, optional):
active
}
{
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"msisdn": {
"content": "string",
"position": 0
},
"contactGroups": {
"visible": true,
"position": 0,
"contactGroupIds": [
0
]
},
"logo": {
"visible": true,
"position": 0,
"attachmentId": 0,
"attachmentMimeType": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
},
"labelContactGroupSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"titleOptOutSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"descriptionOptOutSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
}
},
"messages": {
"pinSms": {
"content": "string"
},
"goodbyeSms": {
"content": "string",
"active": true
},
"goodbyeWhatsapp": {
"content": "string",
"active": true
}
},
"kioskMode": true,
"blacklisting": {
"active": true,
"contentCategories": [
"string"
]
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/APPLETS/{ID}/OPTOUT/CONFIGURATION
* Updates applet
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletOptOutConfigurationResponseDto {
components (AppletOptOutConfigurationComponentsRequestDto, optional):
components
,
messages (AppletOptOutConfigurationMessagesRequestDto, optional):
messages
,
kioskMode (boolean, optional):
kiosk mode
,
blacklisting (AppletOptOutConfigurationBlacklistRequestDto, optional):
blacklisting
,
links (Array[Link], optional):
links
}
AppletOptOutConfigurationComponentsRequestDto {
title (AppletOptOutConfigurationComponentFieldRequestDto, optional):
title
,
intro (AppletOptOutConfigurationComponentTextareaRequestDto, optional):
intro
,
msisdn (AppletOptOutConfigurationComponentMsisdnRequestDto):
msisdn
,
contactGroups
(AppletOptOutConfigurationComponentContactGroupsRequestDto):
contact groups
,
logo (AppletOptOutConfigurationComponentAttachmentRequestDto, optional):
logo
,
appletTitle (AppletOptOutConfigurationComponentFieldRequestDto,
optional):
applet title
,
labelContactGroupSelection
(AppletOptOutConfigurationComponentFieldRequestDto, optional):
label contact group selection
,
titleOptOutSuccessful (AppletOptOutConfigurationComponentFieldRequestDto,
optional):
title opt out successful
,
descriptionOptOutSuccessful
(AppletOptOutConfigurationComponentTextareaRequestDto, optional):
description opt out successful
,
companyName (AppletOptOutConfigurationComponentFieldRequestDto,
optional):
company name
}
AppletOptOutConfigurationMessagesRequestDto {
pinSms (AppletOptOutConfigurationMessageRequestDto):
pin sms
,
goodbyeSms (AppletOptOutConfigurationActivatableMessageRequestDto,
optional):
goodbye sms
,
goodbyeWhatsapp (AppletOptOutConfigurationActivatableMessageRequestDto,
optional):
goodbye whatsapp
}
AppletOptOutConfigurationBlacklistRequestDto {
active (boolean, optional),
contentCategories (Array[string], optional)
}
Link {
rel (string, optional),
href (string, optional)
}
AppletOptOutConfigurationComponentFieldRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptOutConfigurationComponentTextareaRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptOutConfigurationComponentMsisdnRequestDto {
content (string, optional):
content
,
position (integer, optional):
position
}
AppletOptOutConfigurationComponentContactGroupsRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
contactGroupIds (Array[integer], optional):
contact group ids
}
AppletOptOutConfigurationComponentAttachmentRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
attachmentId (integer, optional):
attachment id
integerMax. Value:9223372036854776000
,
attachmentMimeType (string, optional):
attachment mime type
}
AppletOptOutConfigurationMessageRequestDto {
content (string, optional):
content
}
AppletOptOutConfigurationActivatableMessageRequestDto {
content (string, optional):
content
,
active (boolean, optional):
active
}
{
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"msisdn": {
"content": "string",
"position": 0
},
"contactGroups": {
"visible": true,
"position": 0,
"contactGroupIds": [
0
]
},
"logo": {
"visible": true,
"position": 0,
"attachmentId": 0,
"attachmentMimeType": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
},
"labelContactGroupSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"titleOptOutSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"descriptionOptOutSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
}
},
"messages": {
"pinSms": {
"content": "string"
},
"goodbyeSms": {
"content": "string",
"active": true
},
"goodbyeWhatsapp": {
"content": "string",
"active": true
}
},
"kioskMode": true,
"blacklisting": {
"active": true,
"contentCategories": [
"string"
]
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
AppletOptOutConfigurationRequestDto {
components (AppletOptOutConfigurationComponentsRequestDto, optional):
components
,
messages (AppletOptOutConfigurationMessagesRequestDto, optional):
messages
,
kioskMode (boolean, optional):
kiosk mode
,
blacklisting (AppletOptOutConfigurationBlacklistRequestDto, optional):
blacklisting
}
AppletOptOutConfigurationComponentsRequestDto {
title (AppletOptOutConfigurationComponentFieldRequestDto, optional):
title
,
intro (AppletOptOutConfigurationComponentTextareaRequestDto, optional):
intro
,
msisdn (AppletOptOutConfigurationComponentMsisdnRequestDto):
msisdn
,
contactGroups
(AppletOptOutConfigurationComponentContactGroupsRequestDto):
contact groups
,
logo (AppletOptOutConfigurationComponentAttachmentRequestDto, optional):
logo
,
appletTitle (AppletOptOutConfigurationComponentFieldRequestDto,
optional):
applet title
,
labelContactGroupSelection
(AppletOptOutConfigurationComponentFieldRequestDto, optional):
label contact group selection
,
titleOptOutSuccessful (AppletOptOutConfigurationComponentFieldRequestDto,
optional):
title opt out successful
,
descriptionOptOutSuccessful
(AppletOptOutConfigurationComponentTextareaRequestDto, optional):
description opt out successful
,
companyName (AppletOptOutConfigurationComponentFieldRequestDto,
optional):
company name
}
AppletOptOutConfigurationMessagesRequestDto {
pinSms (AppletOptOutConfigurationMessageRequestDto):
pin sms
,
goodbyeSms (AppletOptOutConfigurationActivatableMessageRequestDto,
optional):
goodbye sms
,
goodbyeWhatsapp (AppletOptOutConfigurationActivatableMessageRequestDto,
optional):
goodbye whatsapp
}
AppletOptOutConfigurationBlacklistRequestDto {
active (boolean, optional),
contentCategories (Array[string], optional)
}
AppletOptOutConfigurationComponentFieldRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptOutConfigurationComponentTextareaRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletOptOutConfigurationComponentMsisdnRequestDto {
content (string, optional):
content
,
position (integer, optional):
position
}
AppletOptOutConfigurationComponentContactGroupsRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
contactGroupIds (Array[integer], optional):
contact group ids
}
AppletOptOutConfigurationComponentAttachmentRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
attachmentId (integer, optional):
attachment id
integerMax. Value:9223372036854776000
,
attachmentMimeType (string, optional):
attachment mime type
}
AppletOptOutConfigurationMessageRequestDto {
content (string, optional):
content
}
AppletOptOutConfigurationActivatableMessageRequestDto {
content (string, optional):
content
,
active (boolean, optional):
active
}
{
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"msisdn": {
"content": "string",
"position": 0
},
"contactGroups": {
"visible": true,
"position": 0,
"contactGroupIds": [
0
]
},
"logo": {
"visible": true,
"position": 0,
"attachmentId": 0,
"attachmentMimeType": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
},
"labelContactGroupSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"titleOptOutSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"descriptionOptOutSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
}
},
"messages": {
"pinSms": {
"content": "string"
},
"goodbyeSms": {
"content": "string",
"active": true
},
"goodbyeWhatsapp": {
"content": "string",
"active": true
}
},
"kioskMode": true,
"blacklisting": {
"active": true,
"contentCategories": [
"string"
]
}
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/APPLETS/{ID}/WAT_DEVICE_SUBSCRIPTION/CONFIGURATION
* Returns wat_device_subscription configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletWatDeviceSubscriptionConfigurationResponseDto {
components (AppletWatDeviceSubscriptionConfigurationComponentsRequestDto,
optional):
components
,
messages (AppletWatDeviceSubscriptionConfigurationMessagesRequestDto,
optional):
messages
,
mode (string, optional):
mode
stringReg. Exp.:^(?i)(redirect|manual)$
,
links (Array[Link], optional):
links
}
AppletWatDeviceSubscriptionConfigurationComponentsRequestDto {
title (AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
title
,
intro
(AppletWatDeviceSubscriptionConfigurationComponentTextareaRequestDto,
optional):
intro
,
logo
(AppletWatDeviceSubscriptionConfigurationComponentAttachmentRequestDto,
optional):
logo
,
termsAndConditions
(AppletWatDeviceSubscriptionConfigurationComponentTermsAndConditionsRequestDto,
optional):
terms and conditions
,
companyName
(AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
company name
,
appletTitle
(AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
applet title
}
AppletWatDeviceSubscriptionConfigurationMessagesRequestDto {
prefilledWhatsappMessage
(AppletWatDeviceSubscriptionConfigurationMessageRequestDto):
prefilled whatsapp message
}
Link {
rel (string, optional),
href (string, optional)
}
AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletWatDeviceSubscriptionConfigurationComponentTextareaRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletWatDeviceSubscriptionConfigurationComponentAttachmentRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
attachmentId (integer, optional):
attachment id
integerMax. Value:9223372036854776000
,
attachmentMimeType (string, optional):
attachment mime type
}
AppletWatDeviceSubscriptionConfigurationComponentTermsAndConditionsRequestDto
{
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
,
required (boolean, optional):
required
}
AppletWatDeviceSubscriptionConfigurationMessageRequestDto {
content (string, optional):
content
}
{
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"logo": {
"visible": true,
"position": 0,
"attachmentId": 0,
"attachmentMimeType": "string"
},
"termsAndConditions": {
"visible": true,
"position": 0,
"content": "string",
"required": true
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
}
},
"messages": {
"prefilledWhatsappMessage": {
"content": "string"
}
},
"mode": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/APPLETS/{ID}/WAT_DEVICE_SUBSCRIPTION/CONFIGURATION
* Updates wat_device_subscription configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AppletWatDeviceSubscriptionConfigurationResponseDto {
components (AppletWatDeviceSubscriptionConfigurationComponentsRequestDto,
optional):
components
,
messages (AppletWatDeviceSubscriptionConfigurationMessagesRequestDto,
optional):
messages
,
mode (string, optional):
mode
stringReg. Exp.:^(?i)(redirect|manual)$
,
links (Array[Link], optional):
links
}
AppletWatDeviceSubscriptionConfigurationComponentsRequestDto {
title (AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
title
,
intro
(AppletWatDeviceSubscriptionConfigurationComponentTextareaRequestDto,
optional):
intro
,
logo
(AppletWatDeviceSubscriptionConfigurationComponentAttachmentRequestDto,
optional):
logo
,
termsAndConditions
(AppletWatDeviceSubscriptionConfigurationComponentTermsAndConditionsRequestDto,
optional):
terms and conditions
,
companyName
(AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
company name
,
appletTitle
(AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
applet title
}
AppletWatDeviceSubscriptionConfigurationMessagesRequestDto {
prefilledWhatsappMessage
(AppletWatDeviceSubscriptionConfigurationMessageRequestDto):
prefilled whatsapp message
}
Link {
rel (string, optional),
href (string, optional)
}
AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletWatDeviceSubscriptionConfigurationComponentTextareaRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletWatDeviceSubscriptionConfigurationComponentAttachmentRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
attachmentId (integer, optional):
attachment id
integerMax. Value:9223372036854776000
,
attachmentMimeType (string, optional):
attachment mime type
}
AppletWatDeviceSubscriptionConfigurationComponentTermsAndConditionsRequestDto
{
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
,
required (boolean, optional):
required
}
AppletWatDeviceSubscriptionConfigurationMessageRequestDto {
content (string, optional):
content
}
{
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"logo": {
"visible": true,
"position": 0,
"attachmentId": 0,
"attachmentMimeType": "string"
},
"termsAndConditions": {
"visible": true,
"position": 0,
"content": "string",
"required": true
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
}
},
"messages": {
"prefilledWhatsappMessage": {
"content": "string"
}
},
"mode": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
AppletWatDeviceSubscriptionConfigurationRequestDto {
components (AppletWatDeviceSubscriptionConfigurationComponentsRequestDto,
optional):
components
,
messages (AppletWatDeviceSubscriptionConfigurationMessagesRequestDto,
optional):
messages
,
mode (string, optional):
mode
stringReg. Exp.:^(?i)(redirect|manual)$
}
AppletWatDeviceSubscriptionConfigurationComponentsRequestDto {
title (AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
title
,
intro
(AppletWatDeviceSubscriptionConfigurationComponentTextareaRequestDto,
optional):
intro
,
logo
(AppletWatDeviceSubscriptionConfigurationComponentAttachmentRequestDto,
optional):
logo
,
termsAndConditions
(AppletWatDeviceSubscriptionConfigurationComponentTermsAndConditionsRequestDto,
optional):
terms and conditions
,
companyName
(AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
company name
,
appletTitle
(AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
applet title
}
AppletWatDeviceSubscriptionConfigurationMessagesRequestDto {
prefilledWhatsappMessage
(AppletWatDeviceSubscriptionConfigurationMessageRequestDto):
prefilled whatsapp message
}
AppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletWatDeviceSubscriptionConfigurationComponentTextareaRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
AppletWatDeviceSubscriptionConfigurationComponentAttachmentRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
attachmentId (integer, optional):
attachment id
integerMax. Value:9223372036854776000
,
attachmentMimeType (string, optional):
attachment mime type
}
AppletWatDeviceSubscriptionConfigurationComponentTermsAndConditionsRequestDto
{
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
,
required (boolean, optional):
required
}
AppletWatDeviceSubscriptionConfigurationMessageRequestDto {
content (string, optional):
content
}
{
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"logo": {
"visible": true,
"position": 0,
"attachmentId": 0,
"attachmentMimeType": "string"
},
"termsAndConditions": {
"visible": true,
"position": 0,
"content": "string",
"required": true
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
}
},
"messages": {
"prefilledWhatsappMessage": {
"content": "string"
}
},
"mode": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ARCHIVE : WEBSMS.COM ARCHIVE API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS
* Returns delivery details for the given archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeliveryDetailResponse
]
DeliveryDetailResponse {
id (integer):
monthly record id
,
sentOn (string):
sent on
,
recipient (string):
recipient
,
sender (string):
sender
,
messageType (string):
message type
,
username (string):
username
,
productId (integer, optional):
product id
,
productName (string, optional):
product name
,
origin (string, optional):
message origin
= ['api_http', 'api_http_simple', 'api_rest', 'api_rest_simple',
'api_rest_converged', 'api_rest_customer_channel', 'api_smpp',
'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp', 'sdk_perl',
'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php', 'api_smtp_email2sms',
'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
detail (string, optional):
detail
,
message (string, optional):
message
,
statusOn (string, optional):
status on (date of delivery state)
,
status (string, optional):
delivery state
,
deliveryReport (boolean, optional):
delivery report requested
,
contentCategory (string, optional):
contentCategory
,
directionType (string, optional):
directionType
,
links (Array[Link], optional):
links
,
recipientContact (ContactResponse, optional):
recipient contact details, if available
,
product (ProductResponse, optional):
product
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
ProductResponse {
id (integer, optional):
product id
,
name (string, optional):
name
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"sentOn": "2024-06-20T13:22:50.860Z",
"recipient": "string",
"sender": "string",
"messageType": "string",
"username": "string",
"productId": 0,
"productName": "string",
"origin": "api_http",
"detail": "string",
"message": "string",
"statusOn": "2024-06-20T13:22:50.860Z",
"status": "string",
"deliveryReport": true,
"contentCategory": "string",
"directionType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"recipientContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:50.860Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:50.860Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"product": {
"id": 0,
"name": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT
* Exports delivery details for the given archive message
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
format
Export format (pdf, csv, xsl)
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ARCHIVE/MESSAGES/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/ARCHIVE/MESSAGES/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/{ID}/RECIPIENTS
* Returns recipients for the given archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactResponse
]
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:50.872Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:50.872Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/{ID}/CONTACT_GROUPS
* Returns contact groups for the given archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:50.875Z",
"lastModified": "2024-06-20T13:22:50.875Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:50.875Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:50.875Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES
* Returns archive messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ArchiveMessageResponse
]
ArchiveMessageResponse {
id (integer):
message id
,
transferId (string):
transfer id
,
transferStart (string):
transfer start timestamp
,
transferEnd (string):
transfer end timestamp
,
content (string):
message content
,
sentOn (string):
sent on
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
numberOfRecipients (integer, optional):
number of recipients
,
subject (string, optional):
subject
,
numberOfContactGroups (integer, optional):
number of contact groups
,
contactGroupIds (Array[integer], optional):
contact group id list
,
recipients (Array[string], optional):
recipient list
,
selectors (Array[string], optional):
selectors
,
sender (string, optional):
sender identification
,
contentCategory (string, optional):
content category
,
messageType (string, optional):
message_type
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
urlshorteningType (string, optional):
urlshortening type
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"id": 0,
"transferId": "string",
"transferStart": "2024-06-20T13:22:50.878Z",
"transferEnd": "2024-06-20T13:22:50.878Z",
"content": "string",
"sentOn": "2024-06-20T13:22:50.878Z",
"origin": "api_http",
"numberOfRecipients": 0,
"subject": "string",
"numberOfContactGroups": 0,
"contactGroupIds": [
0
],
"recipients": [
"string"
],
"selectors": [
"string"
],
"sender": "string",
"contentCategory": "string",
"messageType": "string",
"lastModified": "2024-06-20T13:22:50.878Z",
"lastModifiedBy": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"urlshorteningType": "string",
"automated": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/ARCHIVE/MESSAGES/{ID}
* Deletes archive message
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/{ID}
* Returns archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ArchiveMessageResponse {
id (integer):
message id
,
transferId (string):
transfer id
,
transferStart (string):
transfer start timestamp
,
transferEnd (string):
transfer end timestamp
,
content (string):
message content
,
sentOn (string):
sent on
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
numberOfRecipients (integer, optional):
number of recipients
,
subject (string, optional):
subject
,
numberOfContactGroups (integer, optional):
number of contact groups
,
contactGroupIds (Array[integer], optional):
contact group id list
,
recipients (Array[string], optional):
recipient list
,
selectors (Array[string], optional):
selectors
,
sender (string, optional):
sender identification
,
contentCategory (string, optional):
content category
,
messageType (string, optional):
message_type
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
urlshorteningType (string, optional):
urlshortening type
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"transferId": "string",
"transferStart": "2024-06-20T13:22:50.882Z",
"transferEnd": "2024-06-20T13:22:50.882Z",
"content": "string",
"sentOn": "2024-06-20T13:22:50.882Z",
"origin": "api_http",
"numberOfRecipients": 0,
"subject": "string",
"numberOfContactGroups": 0,
"contactGroupIds": [
0
],
"recipients": [
"string"
],
"selectors": [
"string"
],
"sender": "string",
"contentCategory": "string",
"messageType": "string",
"lastModified": "2024-06-20T13:22:50.882Z",
"lastModifiedBy": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"urlshorteningType": "string",
"automated": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ARCHIVE/MESSAGES/DELETE
* Deletes multiple archive messages
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/{ID}/SELECTORS
* Returns selectors for the given archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactSelectorResponse
]
ContactSelectorResponse {
name (string):
name
,
numberOfContacts (integer, optional):
number of contacts
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"name": "string",
"numberOfContacts": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/EXPORT
* Exports archive messages
PARAMETERS
Parameter Value Description Parameter Type Data Type format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT/TASKS
* Returns delivery details export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT/TASKS
* Creates and executes delivery details export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}
* Deletes/cancels delivery details export task
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}
* Returns delivery details export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}/FILE
* Returns delivery details export file
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* BLACKLIST : BLACKLIST API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/RECIPIENT_BLACKLIST/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/RECIPIENT_BLACKLIST/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/RECIPIENT_BLACKLIST/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/IMPORT/FIELDS
* Returns list of supported import fields
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
FieldMetaDataResponse
]
FieldMetaDataResponse {
name (string):
name
,
type (string):
data type
,
required (boolean):
required
,
maxLength (integer):
maximum length
,
isDuplicateCheckSupported (boolean):
whether duplicate check is supported for this field
}
[
{
"name": "string",
"type": "string",
"required": true,
"maxLength": 0,
"isDuplicateCheckSupported": true
}
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/RECIPIENT_BLACKLIST/IMPORT/FILES
* Uploads import file
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CsvFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
delimiter (string, optional):
delimiter
,
charset (string, optional):
charset
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"delimiter": "string",
"charset": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type file
formData undefined
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/RECIPIENT_BLACKLIST/IMPORT/FILES/{ID}
* Deletes import file
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/IMPORT/FILES/{ID}
* Returns import file information
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CsvFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
delimiter (string, optional):
delimiter
,
charset (string, optional):
charset
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"delimiter": "string",
"charset": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/IMPORT/FILES/{ID}/ROWS
* Returns import file rows
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
Row
]
Row {
row (integer):
row
,
columns (Array[Column], optional)
}
Column {
column (integer):
column
,
value (string):
value
}
[
{
"row": 0,
"columns": [
{
"column": 0,
"value": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/IMPORT/FILES/{ID}/FIELD_MAPPING
* Tries to detect field mapping
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/IMPORT/TASKS
* Returns import tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ImportContactsResponse
]
ImportContactsResponse {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
,
id (integer):
id
,
processed (integer, optional):
total of processed contacts
,
added (integer, optional):
newly added contacts
,
updated (integer, optional):
updated contacts
,
updatedCsv (integer, optional):
updated csv contacts
,
ignored (integer, optional):
ignored contacts
,
failed (integer, optional):
failed contacts
,
blacklisted (integer, optional):
blacklisted recipients
,
empty (integer, optional):
empty contacts
,
nonEnabledWhatsapp (integer, optional):
non enabled whatsapp recipients
,
state (AsyncState, optional):
invalid records
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string",
"id": 0,
"processed": 0,
"added": 0,
"updated": 0,
"updatedCsv": 0,
"ignored": 0,
"failed": 0,
"blacklisted": 0,
"empty": 0,
"nonEnabledWhatsapp": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/RECIPIENT_BLACKLIST/IMPORT/TASKS
* Creates and executes import task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ImportContactsResponse {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
,
id (integer):
id
,
processed (integer, optional):
total of processed contacts
,
added (integer, optional):
newly added contacts
,
updated (integer, optional):
updated contacts
,
updatedCsv (integer, optional):
updated csv contacts
,
ignored (integer, optional):
ignored contacts
,
failed (integer, optional):
failed contacts
,
blacklisted (integer, optional):
blacklisted recipients
,
empty (integer, optional):
empty contacts
,
nonEnabledWhatsapp (integer, optional):
non enabled whatsapp recipients
,
state (AsyncState, optional):
invalid records
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string",
"id": 0,
"processed": 0,
"added": 0,
"updated": 0,
"updatedCsv": 0,
"ignored": 0,
"failed": 0,
"blacklisted": 0,
"empty": 0,
"nonEnabledWhatsapp": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ImportRecipientBlacklistRequestDto {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contentCategories (Array[string], optional),
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingRecipientBlacklists (boolean, optional):
don't touch existing recipientBlacklists
,
dryRun (boolean, optional):
dry run
}
{
"importFileId": 0,
"fieldMapping": {},
"contentCategories": [
"string"
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingRecipientBlacklists": true,
"dryRun": true
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/RECIPIENT_BLACKLIST/IMPORT/TASKS/{ID}
* Deletes/cancels import task
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/IMPORT/TASKS/{ID}
* Returns import task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ImportContactsResponse {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
,
id (integer):
id
,
processed (integer, optional):
total of processed contacts
,
added (integer, optional):
newly added contacts
,
updated (integer, optional):
updated contacts
,
updatedCsv (integer, optional):
updated csv contacts
,
ignored (integer, optional):
ignored contacts
,
failed (integer, optional):
failed contacts
,
blacklisted (integer, optional):
blacklisted recipients
,
empty (integer, optional):
empty contacts
,
nonEnabledWhatsapp (integer, optional):
non enabled whatsapp recipients
,
state (AsyncState, optional):
invalid records
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string",
"id": 0,
"processed": 0,
"added": 0,
"updated": 0,
"updatedCsv": 0,
"ignored": 0,
"failed": 0,
"blacklisted": 0,
"empty": 0,
"nonEnabledWhatsapp": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/IMPORT/TASKS/{ID}/INVALID_RECORDS
* Returns invalid records from import task.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
InvalidRecord
]
InvalidRecord {
type (string, optional):
type
,
row (integer, optional):
row index
,
column (integer, optional):
column index
,
field (string, optional):
field name
,
value (string, optional):
invalid value
,
description (string, optional):
error description
}
[
{
"type": "string",
"row": 0,
"column": 0,
"field": "string",
"value": "string",
"description": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/GROUPED
* Returns grouped recipients from recipient blacklist
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
GroupedRecipientBlacklistResponseDto {
id (integer, optional):
id
,
recipient (string, optional):
recipient
}
{
"id": 0,
"recipient": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type search
Search string
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/RECIPIENT_BLACKLIST/ADD
* Adds recipients to one or more blacklisted categories. Sets existing
(non-active) entries to active
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
AddRecipientBlacklistsRequestDto {
recipients (Array[string], optional):
recipient list
,
contentCategories (Array[string], optional):
recipient list
,
comment (string, optional):
comment
}
{
"recipients": [
"string"
],
"contentCategories": [
"string"
],
"comment": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/{ID}
* Returns recipient blacklist entry
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RecipientBlacklistResponse {
recipient (string, optional):
recipient
stringReg. Exp.:\+?[1-9][0-9]{1,15}
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
comment (string, optional):
comment
,
active (boolean, optional):
active
,
id (integer, optional):
recipient blacklist id
,
deactivatedOn (string, optional):
deactivated on
,
activatedOn (string, optional):
activated on
,
deactivationOrigin (string, optional):
deactivation origin
,
activationDetail (string, optional):
activation detail
,
activationOrigin (string, optional):
activation origin
,
activationBy (string, optional):
activated by
,
deactivationBy (string, optional):
deactivated by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"recipient": "string",
"contentCategory": "string",
"comment": "string",
"active": true,
"id": 0,
"deactivatedOn": "2024-06-20T13:22:50.929Z",
"activatedOn": "2024-06-20T13:22:50.929Z",
"deactivationOrigin": "string",
"activationDetail": "string",
"activationOrigin": "string",
"activationBy": "string",
"deactivationBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/RECIPIENT_BLACKLIST/{ID}
* Updates recipient blacklist entry
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RecipientBlacklistResponse {
recipient (string, optional):
recipient
stringReg. Exp.:\+?[1-9][0-9]{1,15}
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
comment (string, optional):
comment
,
active (boolean, optional):
active
,
id (integer, optional):
recipient blacklist id
,
deactivatedOn (string, optional):
deactivated on
,
activatedOn (string, optional):
activated on
,
deactivationOrigin (string, optional):
deactivation origin
,
activationDetail (string, optional):
activation detail
,
activationOrigin (string, optional):
activation origin
,
activationBy (string, optional):
activated by
,
deactivationBy (string, optional):
deactivated by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"recipient": "string",
"contentCategory": "string",
"comment": "string",
"active": true,
"id": 0,
"deactivatedOn": "2024-06-20T13:22:50.931Z",
"activatedOn": "2024-06-20T13:22:50.931Z",
"deactivationOrigin": "string",
"activationDetail": "string",
"activationOrigin": "string",
"activationBy": "string",
"deactivationBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
RecipientBlacklistRequest {
recipient (string, optional):
recipient
stringReg. Exp.:\+?[1-9][0-9]{1,15}
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
comment (string, optional):
comment
,
active (boolean, optional):
active
}
{
"recipient": "string",
"contentCategory": "string",
"comment": "string",
"active": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 304
Not modified
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST/EXPORT
* Exports recipient blacklist entries
PARAMETERS
Parameter Value Description Parameter Type Data Type format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/RECIPIENT_BLACKLIST
* Returns recipient blacklist entries
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RecipientBlacklistResponse {
recipient (string, optional):
recipient
stringReg. Exp.:\+?[1-9][0-9]{1,15}
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
comment (string, optional):
comment
,
active (boolean, optional):
active
,
id (integer, optional):
recipient blacklist id
,
deactivatedOn (string, optional):
deactivated on
,
activatedOn (string, optional):
activated on
,
deactivationOrigin (string, optional):
deactivation origin
,
activationDetail (string, optional):
activation detail
,
activationOrigin (string, optional):
activation origin
,
activationBy (string, optional):
activated by
,
deactivationBy (string, optional):
deactivated by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"recipient": "string",
"contentCategory": "string",
"comment": "string",
"active": true,
"id": 0,
"deactivatedOn": "2024-06-20T13:22:50.934Z",
"activatedOn": "2024-06-20T13:22:50.934Z",
"deactivationOrigin": "string",
"activationDetail": "string",
"activationOrigin": "string",
"activationBy": "string",
"deactivationBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/RECIPIENT_BLACKLIST
* Adds recipient blacklist entry
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RecipientBlacklistResponse {
recipient (string, optional):
recipient
stringReg. Exp.:\+?[1-9][0-9]{1,15}
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
comment (string, optional):
comment
,
active (boolean, optional):
active
,
id (integer, optional):
recipient blacklist id
,
deactivatedOn (string, optional):
deactivated on
,
activatedOn (string, optional):
activated on
,
deactivationOrigin (string, optional):
deactivation origin
,
activationDetail (string, optional):
activation detail
,
activationOrigin (string, optional):
activation origin
,
activationBy (string, optional):
activated by
,
deactivationBy (string, optional):
deactivated by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"recipient": "string",
"contentCategory": "string",
"comment": "string",
"active": true,
"id": 0,
"deactivatedOn": "2024-06-20T13:22:50.936Z",
"activatedOn": "2024-06-20T13:22:50.936Z",
"deactivationOrigin": "string",
"activationDetail": "string",
"activationOrigin": "string",
"activationBy": "string",
"deactivationBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
RecipientBlacklistRequest {
recipient (string, optional):
recipient
stringReg. Exp.:\+?[1-9][0-9]{1,15}
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
comment (string, optional):
comment
,
active (boolean, optional):
active
}
{
"recipient": "string",
"contentCategory": "string",
"comment": "string",
"active": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CONFIGURATION : WEBSMS.COM CONFIGURATION API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/CONFIGURATION/INBOX
* Returns inbox configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
InboxConfigurationResponse {
enabled (boolean, optional):
inbox enabled?
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"enabled": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/INBOX
* Updates inbox configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
InboxConfigurationResponse {
enabled (boolean, optional):
inbox enabled?
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"enabled": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
InboxConfigurationRequest {
enabled (boolean, optional):
inbox enabled?
}
{
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/ARCHIVE
* Returns archive configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ArchiveConfigurationResponse {
enabled (boolean, optional):
archive enabled?
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"enabled": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/ARCHIVE
* Updates archive configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ArchiveConfigurationResponse {
enabled (boolean, optional):
archive enabled?
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"enabled": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ArchiveConfigurationRequest {
enabled (boolean, optional):
archive enabled?
}
{
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/LOCALE
* Returns account locale
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
LocaleConfigurationRequest {
locale (string, optional):
Default account locale
}
{
"locale": "string"
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/LOCALE
* Updates account locale
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
LocaleConfigurationRequest {
locale (string, optional):
Default account locale
}
{
"locale": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
LocaleConfigurationRequest {
locale (string, optional):
Default account locale
}
{
"locale": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/CONFIGURATION/URLSHORTENING_DEFAULT_DOMAIN
* Deletes account default urlshortening domain configuration
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/URLSHORTENING_DEFAULT_DOMAIN
* Returns account default urlshortening domain configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UrlshorteningDefaultDomainConfigurationResponse {
domainPart (string, optional):
urlshortening default domain part
,
urlScheme (string, optional):
urlshortening default url scheme
stringReg. Exp.:^(?i)(http|https)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"domainPart": "string",
"urlScheme": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/URLSHORTENING_DEFAULT_DOMAIN
* Updates account default urlshortening domain configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UrlshorteningDefaultDomainConfigurationResponse {
domainPart (string, optional):
urlshortening default domain part
,
urlScheme (string, optional):
urlshortening default url scheme
stringReg. Exp.:^(?i)(http|https)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"domainPart": "string",
"urlScheme": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
UrlshorteningDefaultDomainConfigurationRequest {
domainPart (string, optional):
urlshortening default domain part
,
urlScheme (string, optional):
urlshortening default url scheme
stringReg. Exp.:^(?i)(http|https)$
}
{
"domainPart": "string",
"urlScheme": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/URLSHORTENING_TYPE_WHATSAPP
* Returns account whatsapp urlshortening type configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UrlshorteningTypeConfigurationResponse {
urlshorteningType (string, optional):
urlshortening type
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"urlshorteningType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/URLSHORTENING_TYPE_WHATSAPP
* Updates account whatsapp urlshortening type configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UrlshorteningTypeConfigurationResponse {
urlshorteningType (string, optional):
urlshortening type
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"urlshorteningType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
UrlshorteningTypeConfigurationRequest {
urlshorteningType (string, optional):
urlshortening type
}
{
"urlshorteningType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/URLSHORTENING_TYPE_SMS
* Returns account sms urlshortening type configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UrlshorteningTypeConfigurationResponse {
urlshorteningType (string, optional):
urlshortening type
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"urlshorteningType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/URLSHORTENING_TYPE_SMS
* Updates account sms urlshortening type configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UrlshorteningTypeConfigurationResponse {
urlshorteningType (string, optional):
urlshortening type
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"urlshorteningType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
UrlshorteningTypeConfigurationRequest {
urlshorteningType (string, optional):
urlshortening type
}
{
"urlshorteningType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/FORWARDING
* Returns forwarding configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ForwardingConfigurationResponse {
type (string, optional):
type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs)
,
target (string, optional):
target URL/address
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/FORWARDING
* Updates forwarding configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ForwardingConfigurationResponse {
type (string, optional):
type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs)
,
target (string, optional):
target URL/address
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ForwardingConfigurationRequest {
type (string, optional):
type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs)
,
target (string, optional):
target URL/address
}
{
"type": "string",
"target": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/DLR_SMS_FORWARDING
* Returns dlrSms forwarding configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrSmsForwardingConfigurationRequest {
enabled (boolean, optional):
enabled?
,
bpwebappType (string, optional):
bpwebapp type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
bpwebappTarget (string, optional):
bpwebapp target URL/address
,
otherType (string, optional):
other type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
legacyXmlType (string, optional):
legacyXml type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs,
...)
,
legacyXmlTarget (string, optional):
legacyXml target URL/address
,
atmsType (string, optional):
atms type
,
atmsTarget (string, optional):
atms target URL/address
,
simplesmsType (string, optional):
simple sms type
,
simplesmsTarget (string, optional):
simple sms target URL/address
}
{
"enabled": true,
"bpwebappType": "string",
"bpwebappTarget": "string",
"otherType": "string",
"legacyXmlType": "string",
"legacyXmlTarget": "string",
"atmsType": "string",
"atmsTarget": "string",
"simplesmsType": "string",
"simplesmsTarget": "string"
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/DLR_SMS_FORWARDING
* Updates dlrSms forwarding configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrSmsForwardingConfigurationRequest {
enabled (boolean, optional):
enabled?
,
bpwebappType (string, optional):
bpwebapp type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
bpwebappTarget (string, optional):
bpwebapp target URL/address
,
otherType (string, optional):
other type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
legacyXmlType (string, optional):
legacyXml type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs,
...)
,
legacyXmlTarget (string, optional):
legacyXml target URL/address
,
atmsType (string, optional):
atms type
,
atmsTarget (string, optional):
atms target URL/address
,
simplesmsType (string, optional):
simple sms type
,
simplesmsTarget (string, optional):
simple sms target URL/address
}
{
"enabled": true,
"bpwebappType": "string",
"bpwebappTarget": "string",
"otherType": "string",
"legacyXmlType": "string",
"legacyXmlTarget": "string",
"atmsType": "string",
"atmsTarget": "string",
"simplesmsType": "string",
"simplesmsTarget": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DlrSmsForwardingConfigurationRequest {
enabled (boolean, optional):
enabled?
,
bpwebappType (string, optional):
bpwebapp type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
bpwebappTarget (string, optional):
bpwebapp target URL/address
,
otherType (string, optional):
other type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
legacyXmlType (string, optional):
legacyXml type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs,
...)
,
legacyXmlTarget (string, optional):
legacyXml target URL/address
,
atmsType (string, optional):
atms type
,
atmsTarget (string, optional):
atms target URL/address
,
simplesmsType (string, optional):
simple sms type
,
simplesmsTarget (string, optional):
simple sms target URL/address
}
{
"enabled": true,
"bpwebappType": "string",
"bpwebappTarget": "string",
"otherType": "string",
"legacyXmlType": "string",
"legacyXmlTarget": "string",
"atmsType": "string",
"atmsTarget": "string",
"simplesmsType": "string",
"simplesmsTarget": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/DLR_WHATSAPP_FORWARDING
* Returns dlr whatsapp forwarding configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrWhatsappForwardingConfigurationRequest {
enabled (boolean, optional):
enabled?
,
bpwebappType (string, optional):
bpwebapp type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
bpwebappTarget (string, optional):
bpwebapp target URL/address
,
otherType (string, optional):
other type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
apiRestType (string, optional):
apiRest type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
apiRestTarget (string, optional):
apiRest target URL/address
}
{
"enabled": true,
"bpwebappType": "string",
"bpwebappTarget": "string",
"otherType": "string",
"apiRestType": "string",
"apiRestTarget": "string"
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/DLR_WHATSAPP_FORWARDING
* Updates dlr whatsapp forwarding configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrWhatsappForwardingConfigurationRequest {
enabled (boolean, optional):
enabled?
,
bpwebappType (string, optional):
bpwebapp type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
bpwebappTarget (string, optional):
bpwebapp target URL/address
,
otherType (string, optional):
other type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
apiRestType (string, optional):
apiRest type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
apiRestTarget (string, optional):
apiRest target URL/address
}
{
"enabled": true,
"bpwebappType": "string",
"bpwebappTarget": "string",
"otherType": "string",
"apiRestType": "string",
"apiRestTarget": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DlrWhatsappForwardingConfigurationRequest {
enabled (boolean, optional):
enabled?
,
bpwebappType (string, optional):
bpwebapp type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
bpwebappTarget (string, optional):
bpwebapp target URL/address
,
otherType (string, optional):
other type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
apiRestType (string, optional):
apiRest type (http_json, http_xml, smtp_json, smtp_xml, amazon_sqs, ...)
,
apiRestTarget (string, optional):
apiRest target URL/address
}
{
"enabled": true,
"bpwebappType": "string",
"bpwebappTarget": "string",
"otherType": "string",
"apiRestType": "string",
"apiRestTarget": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/CONTENT_CATEGORY
* Returns content category configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContentCategoryConfigurationResponse {
contentCategory (string, optional):
contentCategory (personal, advertisement, informational)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contentCategory": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/CONTENT_CATEGORY
* Updates content category configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContentCategoryConfigurationResponse {
contentCategory (string, optional):
contentCategory (personal, advertisement, informational)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contentCategory": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ContentCategoryConfigurationRequest {
contentCategory (string, optional):
contentCategory (personal, advertisement, informational)
}
{
"contentCategory": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/BLACKLIST
* Returns blacklist configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
BlacklistConfigurationResponse {
blacklistedConfirmationMessageSmsContent (string, optional):
blacklisted confirmation message sms content
,
blacklistedConfirmationMessageSmsActive (boolean, optional):
is lacklisted confirmation message sms active?
,
blacklistedConfirmationMessageWhatsappContent (string, optional):
blacklisted confirmation message whatsapp content
,
blacklistedConfirmationMessageWhatsappActive (boolean, optional):
is blacklisted confirmation message whatsapp active?
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"blacklistedConfirmationMessageSmsContent": "string",
"blacklistedConfirmationMessageSmsActive": true,
"blacklistedConfirmationMessageWhatsappContent": "string",
"blacklistedConfirmationMessageWhatsappActive": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/BLACKLIST
* Updates blacklist configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
BlacklistConfigurationResponse {
blacklistedConfirmationMessageSmsContent (string, optional):
blacklisted confirmation message sms content
,
blacklistedConfirmationMessageSmsActive (boolean, optional):
is lacklisted confirmation message sms active?
,
blacklistedConfirmationMessageWhatsappContent (string, optional):
blacklisted confirmation message whatsapp content
,
blacklistedConfirmationMessageWhatsappActive (boolean, optional):
is blacklisted confirmation message whatsapp active?
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"blacklistedConfirmationMessageSmsContent": "string",
"blacklistedConfirmationMessageSmsActive": true,
"blacklistedConfirmationMessageWhatsappContent": "string",
"blacklistedConfirmationMessageWhatsappActive": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
BlacklistConfigurationRequest {
blacklistedConfirmationMessageSmsContent (string, optional):
blacklisted confirmation message sms content
,
blacklistedConfirmationMessageSmsActive (boolean, optional):
is lacklisted confirmation message sms active?
,
blacklistedConfirmationMessageWhatsappContent (string, optional):
blacklisted confirmation message whatsapp content
,
blacklistedConfirmationMessageWhatsappActive (boolean, optional):
is blacklisted confirmation message whatsapp active?
}
{
"blacklistedConfirmationMessageSmsContent": "string",
"blacklistedConfirmationMessageSmsActive": true,
"blacklistedConfirmationMessageWhatsappContent": "string",
"blacklistedConfirmationMessageWhatsappActive": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/MESSAGING_API/HTTP/WHITELIST
* Returns HTTP whitelist entries
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
WhitelistEntryResponse
]
WhitelistEntryResponse {
value (string, optional):
value
,
id (integer):
whitelist entry id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"value": "string",
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CONFIGURATION/MESSAGING_API/HTTP/WHITELIST
* Adds HTTP whitelist entry
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
WhitelistEntryResponse {
value (string, optional):
value
,
id (integer):
whitelist entry id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"value": "string",
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
WhitelistEntryRequest {
value (string, optional):
value
}
{
"value": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/CONFIGURATION/MESSAGING_API/HTTP/WHITELIST/{ID}
* Deletes HTTP whitelist entry
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/MESSAGING_API/HTTP/WHITELIST/{ID}
* Returns HTTP whitelist entry
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhitelistEntryResponse {
value (string, optional):
value
,
id (integer):
whitelist entry id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"value": "string",
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/MESSAGING_API/HTTP/WHITELIST/{ID}
* Updates HTTP whitelist entry
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhitelistEntryResponse {
value (string, optional):
value
,
id (integer):
whitelist entry id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"value": "string",
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
WhitelistEntryRequest {
value (string, optional):
value
}
{
"value": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 304
Not modified
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CONFIGURATION/MESSAGING_API/CHANGE_PASSWORD
* Changes messaging API password
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ChangePasswordRequest {
oldPassword (string):
old password
,
newPassword (string):
new password
}
{
"oldPassword": "string",
"newPassword": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CONFIGURATION/MESSAGING_API/AUTHENTICATION
* Changes messaging API password
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MessagingAuthenticationRequest {
password (string, optional):
password
}
{
"password": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/MESSAGING_API/ACCESS_TOKENS
* Returns access tokens
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessagingAccessTokenResponse
]
MessagingAccessTokenResponse {
id (integer):
id
,
value (string):
value
,
created (string):
creation date
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"id": 0,
"value": "string",
"created": "2024-06-20T13:22:50.966Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CONFIGURATION/MESSAGING_API/ACCESS_TOKENS/GENERATE
* Generates access token
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
MessagingAccessTokenResponse {
id (integer):
id
,
value (string):
value
,
created (string):
creation date
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"value": "string",
"created": "2024-06-20T13:22:50.967Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/CONFIGURATION/MESSAGING_API/ACCESS_TOKENS/{ID}
* Deletes access token
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/MESSAGING_API/ACCESS_TOKENS/{ID}
* Returns access tokens
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MessagingAccessTokenResponse {
id (integer):
id
,
value (string):
value
,
created (string):
creation date
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"value": "string",
"created": "2024-06-20T13:22:50.969Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CONFIGURATION/SMPP/AUTHENTICATION
* Changes smpp password
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
SmppAuthenticationRequest {
password (string, optional):
password
}
{
"password": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CONFIGURATION/ONBOARDING
* Returns account onboarding status
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CONFIGURATION/ONBOARDING
* Updates account onboarding status
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
OnboardingConfigurationRequest {
onboardingStatus (string, optional):
onboardingStatus
}
{
"onboardingStatus": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CUSTOMER_CHANNELS : CUSTOMER CHANNELS API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/CUSTOMER_CHANNELS
* Returns customer channels
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
CustomerChannelResponseDto
]
CustomerChannelResponseDto {
name (string, optional)
stringMax. Length:255
,
type (string, optional):
customer channel type
,
id (integer, optional):
customer channel id
,
uuid (string, optional):
customer channel uuid
,
created (string, optional):
creation date
,
lastModified (string, optional):
last modified
,
createdBy (string, optional):
created by
,
lastModifiedBy (string, optional):
last modified by
,
priority (string, optional):
priority
,
lastOrigin (string, optional):
last origin
,
status (string, optional):
status
,
smtpId (string, optional):
smtpId
,
identifierId (integer, optional):
identifier id
,
identifier (IdentifierResponseDto, optional):
identifier
,
fallbackAccountId (integer, optional):
fallbackAccountId
,
links (Array[Link], optional):
links
}
IdentifierResponseDto {
id (integer, optional):
identifier id
,
identifier (string, optional):
identifier
,
type (string, optional):
type
,
active (boolean, optional):
active?
,
status (string, optional):
status
,
identifierConfiguration (IdentifierConfigurationResponseDto, optional):
identifierConfiguration
}
Link {
rel (string, optional),
href (string, optional)
}
IdentifierConfigurationResponseDto {
whatsappIdentifierConfiguration
(WhatsappIdentifierConfigurationResponseDto, optional):
whatsappIdentifierConfiguration
}
WhatsappIdentifierConfigurationResponseDto {
provider (string, optional),
metaPhoneNumberId (string, optional),
wabaId (string, optional),
wabaName (string, optional),
messageTemplateNamespace (string, optional)
}
[
{
"name": "string",
"type": "string",
"id": 0,
"uuid": "string",
"created": "2024-06-20T13:22:50.974Z",
"lastModified": "2024-06-20T13:22:50.974Z",
"createdBy": "string",
"lastModifiedBy": "string",
"priority": "string",
"lastOrigin": "string",
"status": "string",
"smtpId": "string",
"identifierId": 0,
"identifier": {
"id": 0,
"identifier": "string",
"type": "string",
"active": true,
"status": "string",
"identifierConfiguration": {
"whatsappIdentifierConfiguration": {
"provider": "string",
"metaPhoneNumberId": "string",
"wabaId": "string",
"wabaName": "string",
"messageTemplateNamespace": "string"
}
}
},
"fallbackAccountId": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CUSTOMER_CHANNELS
* Adds customer channel information/settings
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelResponseDto {
name (string, optional)
stringMax. Length:255
,
type (string, optional):
customer channel type
,
id (integer, optional):
customer channel id
,
uuid (string, optional):
customer channel uuid
,
created (string, optional):
creation date
,
lastModified (string, optional):
last modified
,
createdBy (string, optional):
created by
,
lastModifiedBy (string, optional):
last modified by
,
priority (string, optional):
priority
,
lastOrigin (string, optional):
last origin
,
status (string, optional):
status
,
smtpId (string, optional):
smtpId
,
identifierId (integer, optional):
identifier id
,
identifier (IdentifierResponseDto, optional):
identifier
,
fallbackAccountId (integer, optional):
fallbackAccountId
,
links (Array[Link], optional):
links
}
IdentifierResponseDto {
id (integer, optional):
identifier id
,
identifier (string, optional):
identifier
,
type (string, optional):
type
,
active (boolean, optional):
active?
,
status (string, optional):
status
,
identifierConfiguration (IdentifierConfigurationResponseDto, optional):
identifierConfiguration
}
Link {
rel (string, optional),
href (string, optional)
}
IdentifierConfigurationResponseDto {
whatsappIdentifierConfiguration
(WhatsappIdentifierConfigurationResponseDto, optional):
whatsappIdentifierConfiguration
}
WhatsappIdentifierConfigurationResponseDto {
provider (string, optional),
metaPhoneNumberId (string, optional),
wabaId (string, optional),
wabaName (string, optional),
messageTemplateNamespace (string, optional)
}
{
"name": "string",
"type": "string",
"id": 0,
"uuid": "string",
"created": "2024-06-20T13:22:50.976Z",
"lastModified": "2024-06-20T13:22:50.976Z",
"createdBy": "string",
"lastModifiedBy": "string",
"priority": "string",
"lastOrigin": "string",
"status": "string",
"smtpId": "string",
"identifierId": 0,
"identifier": {
"id": 0,
"identifier": "string",
"type": "string",
"active": true,
"status": "string",
"identifierConfiguration": {
"whatsappIdentifierConfiguration": {
"provider": "string",
"metaPhoneNumberId": "string",
"wabaId": "string",
"wabaName": "string",
"messageTemplateNamespace": "string"
}
}
},
"fallbackAccountId": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelRequestDto {
name (string, optional)
stringMax. Length:255
,
type (string, optional)
stringReg. Exp.:^(?i)(whatsapp)$
}
{
"name": "string",
"type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST
/V1/CUSTOMER_CHANNELS/{ID}/WHATSAPP/INITIATE_PHONE_NUMBER_PROVISIONING
* Initiates phone number provisioning
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
InitiatePhoneNumberProvisioningRequest {
metaPhoneNumberId (string, optional):
the external (meta) phoneNumberId
,
wabaId (string, optional):
the external (meta) wabaId
,
metaAccessToken (string, optional):
the external (meta) temp access token provided by metas embedded signup
,
provider (string, optional):
the provider the phone number should be registered through (e.g. LINK,
WHATSAPP, ...)
stringReg. Exp.:^$|^(?i)(link_mobility|internal)$
}
{
"metaPhoneNumberId": "string",
"wabaId": "string",
"metaAccessToken": "string",
"provider": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST
/V1/CUSTOMER_CHANNELS/{ID}/WHATSAPP/CONFIRM_LINK_WHATSAPP_PHONE_NUMBER_PROVISIONING
* Confirms link whatsapp phone number provisioning
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
token query string body
Parameter content type: application/json
body
* Model
* Model Schema
LinkWhatsappProvisioningResultDto {
success (boolean, optional),
cpaasClient (CpaasClient, optional),
phoneNumber (string, optional),
phoneNumberId (string, optional),
wabaId (string, optional)
}
CpaasClient {
clientId (string, optional),
secret (string, optional),
iv (string, optional)
}
{
"success": true,
"cpaasClient": {
"clientId": "string",
"secret": "string",
"iv": "string"
},
"phoneNumber": "string",
"phoneNumberId": "string",
"wabaId": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER_CHANNELS/{ID}
* Returns customer channel information
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelResponseDto {
name (string, optional)
stringMax. Length:255
,
type (string, optional):
customer channel type
,
id (integer, optional):
customer channel id
,
uuid (string, optional):
customer channel uuid
,
created (string, optional):
creation date
,
lastModified (string, optional):
last modified
,
createdBy (string, optional):
created by
,
lastModifiedBy (string, optional):
last modified by
,
priority (string, optional):
priority
,
lastOrigin (string, optional):
last origin
,
status (string, optional):
status
,
smtpId (string, optional):
smtpId
,
identifierId (integer, optional):
identifier id
,
identifier (IdentifierResponseDto, optional):
identifier
,
fallbackAccountId (integer, optional):
fallbackAccountId
,
links (Array[Link], optional):
links
}
IdentifierResponseDto {
id (integer, optional):
identifier id
,
identifier (string, optional):
identifier
,
type (string, optional):
type
,
active (boolean, optional):
active?
,
status (string, optional):
status
,
identifierConfiguration (IdentifierConfigurationResponseDto, optional):
identifierConfiguration
}
Link {
rel (string, optional),
href (string, optional)
}
IdentifierConfigurationResponseDto {
whatsappIdentifierConfiguration
(WhatsappIdentifierConfigurationResponseDto, optional):
whatsappIdentifierConfiguration
}
WhatsappIdentifierConfigurationResponseDto {
provider (string, optional),
metaPhoneNumberId (string, optional),
wabaId (string, optional),
wabaName (string, optional),
messageTemplateNamespace (string, optional)
}
{
"name": "string",
"type": "string",
"id": 0,
"uuid": "string",
"created": "2024-06-20T13:22:50.980Z",
"lastModified": "2024-06-20T13:22:50.980Z",
"createdBy": "string",
"lastModifiedBy": "string",
"priority": "string",
"lastOrigin": "string",
"status": "string",
"smtpId": "string",
"identifierId": 0,
"identifier": {
"id": 0,
"identifier": "string",
"type": "string",
"active": true,
"status": "string",
"identifierConfiguration": {
"whatsappIdentifierConfiguration": {
"provider": "string",
"metaPhoneNumberId": "string",
"wabaId": "string",
"wabaName": "string",
"messageTemplateNamespace": "string"
}
}
},
"fallbackAccountId": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CUSTOMER_CHANNELS/{ID}
* Updates customer channel information/settings
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelResponseDto {
name (string, optional)
stringMax. Length:255
,
type (string, optional):
customer channel type
,
id (integer, optional):
customer channel id
,
uuid (string, optional):
customer channel uuid
,
created (string, optional):
creation date
,
lastModified (string, optional):
last modified
,
createdBy (string, optional):
created by
,
lastModifiedBy (string, optional):
last modified by
,
priority (string, optional):
priority
,
lastOrigin (string, optional):
last origin
,
status (string, optional):
status
,
smtpId (string, optional):
smtpId
,
identifierId (integer, optional):
identifier id
,
identifier (IdentifierResponseDto, optional):
identifier
,
fallbackAccountId (integer, optional):
fallbackAccountId
,
links (Array[Link], optional):
links
}
IdentifierResponseDto {
id (integer, optional):
identifier id
,
identifier (string, optional):
identifier
,
type (string, optional):
type
,
active (boolean, optional):
active?
,
status (string, optional):
status
,
identifierConfiguration (IdentifierConfigurationResponseDto, optional):
identifierConfiguration
}
Link {
rel (string, optional),
href (string, optional)
}
IdentifierConfigurationResponseDto {
whatsappIdentifierConfiguration
(WhatsappIdentifierConfigurationResponseDto, optional):
whatsappIdentifierConfiguration
}
WhatsappIdentifierConfigurationResponseDto {
provider (string, optional),
metaPhoneNumberId (string, optional),
wabaId (string, optional),
wabaName (string, optional),
messageTemplateNamespace (string, optional)
}
{
"name": "string",
"type": "string",
"id": 0,
"uuid": "string",
"created": "2024-06-20T13:22:50.982Z",
"lastModified": "2024-06-20T13:22:50.982Z",
"createdBy": "string",
"lastModifiedBy": "string",
"priority": "string",
"lastOrigin": "string",
"status": "string",
"smtpId": "string",
"identifierId": 0,
"identifier": {
"id": 0,
"identifier": "string",
"type": "string",
"active": true,
"status": "string",
"identifierConfiguration": {
"whatsappIdentifierConfiguration": {
"provider": "string",
"metaPhoneNumberId": "string",
"wabaId": "string",
"wabaName": "string",
"messageTemplateNamespace": "string"
}
}
},
"fallbackAccountId": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelRequestDto {
name (string, optional)
stringMax. Length:255
,
type (string, optional)
stringReg. Exp.:^(?i)(whatsapp)$
}
{
"name": "string",
"type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER_CHANNELS/{CUSTOMER_CHANNEL_ID}/AGENTS
* Retrieve a list of all agents for the specified customer channel.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
CustomerChannelAgentResponseDto
]
CustomerChannelAgentResponseDto {
accountId (integer):
account id
,
active (boolean, optional):
active
,
id (integer, optional):
agent id
,
customerChannelId (integer, optional):
customer channel id
,
customerId (integer, optional):
customer id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"accountId": 0,
"active": true,
"id": 0,
"customerChannelId": 0,
"customerId": 0,
"timestamp": "2024-06-20T13:22:50.983Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type customer_channel_id
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CUSTOMER_CHANNELS/{CUSTOMER_CHANNEL_ID}/AGENTS
* Creates a new agent assignment for the specified customer channel.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelAgentResponseDto {
accountId (integer):
account id
,
active (boolean, optional):
active
,
id (integer, optional):
agent id
,
customerChannelId (integer, optional):
customer channel id
,
customerId (integer, optional):
customer id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountId": 0,
"active": true,
"id": 0,
"customerChannelId": 0,
"customerId": 0,
"timestamp": "2024-06-20T13:22:50.984Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type customer_channel_id
path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelAgentRequestDto {
accountId (integer):
account id
,
active (boolean, optional):
active
}
{
"accountId": 0,
"active": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/CUSTOMER_CHANNELS/{CUSTOMER_CHANNEL_ID}/AGENTS/{AGENT_ID}
* Deletes a specific agent assignment.
PARAMETERS
Parameter Value Description Parameter Type Data Type customer_channel_id
path integer agent_id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER_CHANNELS/{CUSTOMER_CHANNEL_ID}/AGENTS/{AGENT_ID}
* Retrieve a specific agent assignment.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelAgentResponseDto {
accountId (integer):
account id
,
active (boolean, optional):
active
,
id (integer, optional):
agent id
,
customerChannelId (integer, optional):
customer channel id
,
customerId (integer, optional):
customer id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountId": 0,
"active": true,
"id": 0,
"customerChannelId": 0,
"customerId": 0,
"timestamp": "2024-06-20T13:22:50.987Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type customer_channel_id
path integer agent_id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CUSTOMER_CHANNELS/{CUSTOMER_CHANNEL_ID}/AGENTS/{AGENT_ID}
* Updates the details of a specific agent assignment.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelAgentResponseDto {
accountId (integer):
account id
,
active (boolean, optional):
active
,
id (integer, optional):
agent id
,
customerChannelId (integer, optional):
customer channel id
,
customerId (integer, optional):
customer id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountId": 0,
"active": true,
"id": 0,
"customerChannelId": 0,
"customerId": 0,
"timestamp": "2024-06-20T13:22:50.988Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type customer_channel_id
path integer agent_id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelAgentRequestDto {
accountId (integer):
account id
,
active (boolean, optional):
active
}
{
"accountId": 0,
"active": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/CUSTOMER_CHANNELS/{CUSTOMER_CHANNEL_ID}/ACCOUNTS_ASSIGNABLE_AS_AGENT
* Retrieve a list of all active accounts associated with their agent
assignments for the specified customer channel.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
CustomerChannelAgentAssignableAccountsResponseDto
]
CustomerChannelAgentAssignableAccountsResponseDto {
links (Array[Link], optional):
links
,
account (AssignableAccountResponseDto, optional),
customerChannelAgent (CustomerChannelAgentResponseDto, optional)
}
Link {
rel (string, optional),
href (string, optional)
}
AssignableAccountResponseDto {
id (integer, optional):
account id
,
username (string, optional):
user
,
active (boolean, optional):
active
,
role (string, optional):
role
}
CustomerChannelAgentResponseDto {
accountId (integer):
account id
,
active (boolean, optional):
active
,
id (integer, optional):
agent id
,
customerChannelId (integer, optional):
customer channel id
,
customerId (integer, optional):
customer id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
}
[
{
"links": [
{
"rel": "string",
"href": "string"
}
],
"account": {
"id": 0,
"username": "string",
"active": true,
"role": "string"
},
"customerChannelAgent": {
"accountId": 0,
"active": true,
"id": 0,
"customerChannelId": 0,
"customerId": 0,
"timestamp": "2024-06-20T13:22:50.990Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type customer_channel_id
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DEPRECATED : DEPRECATED API METHODS (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/INFO/SELECTORS
* Returns available statistic/delivery details selectors
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
string
]
[
"string"
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/OPT_IN
* Returns default Opt-in URLs
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
OptInResponse
]
OptInResponse {
showAllGroups (boolean, optional):
show all groups?
,
contactGroupIds (Array[integer], optional):
contact group id list
,
basic (string, optional):
basic version
,
business (string, optional):
business version
,
extended (string, optional):
extended version
,
unsubscribe (string, optional):
unsubscribe
}
[
{
"showAllGroups": true,
"contactGroupIds": [
0
],
"basic": "string",
"business": "string",
"extended": "string",
"unsubscribe": "string"
}
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/OPT_IN
* Generates Opt-in URLs
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
OptInResponse
]
OptInResponse {
showAllGroups (boolean, optional):
show all groups?
,
contactGroupIds (Array[integer], optional):
contact group id list
,
basic (string, optional):
basic version
,
business (string, optional):
business version
,
extended (string, optional):
extended version
,
unsubscribe (string, optional):
unsubscribe
}
[
{
"showAllGroups": true,
"contactGroupIds": [
0
],
"basic": "string",
"business": "string",
"extended": "string",
"unsubscribe": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
OptInRequestDto {
showAllGroups (boolean, optional):
show all groups?
,
contactGroupIds (Array[integer], optional):
contact group id list
}
{
"showAllGroups": true,
"contactGroupIds": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DEVICES : DEVICE API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/DEVICES/EXPORT/TASKS/{ID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DEVICES/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DevicesExportResponse
]
DevicesExportResponse {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
search (string, optional):
Search
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"search": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DEVICES/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DevicesExportResponse {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
search (string, optional):
Search
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"search": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceType
DeviceType (optional)
query string body
Parameter content type: application/json
body
* Model
* Model Schema
DevicesExportRequest {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
search (string, optional):
Search
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"search": "string"
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/DEVICES/EXPORT/TASKS/{ID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DEVICES/EXPORT/TASKS/{ID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DevicesExportResponse {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
search (string, optional):
Search
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"search": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DEVICES/{ID}/DISABLE
* Disables device
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DeviceResponse {
id (integer, optional):
id
,
msisdn (integer, optional):
MSISDN
,
enabled (boolean, optional):
enabled?
,
name (string, optional):
name
,
created (string, optional):
creation date
,
updated (string, optional):
last update date
,
deviceType (string, optional):
device type
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"msisdn": 0,
"enabled": true,
"name": "string",
"created": "2024-06-20T13:22:51.002Z",
"updated": "2024-06-20T13:22:51.002Z",
"deviceType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DEVICES/DISABLE
* Disables devices
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DisableDevicesResponse {
deviceTypes (Array[string], optional):
device types list
stringMax. Items:10
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"deviceTypes": [
"string"
],
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DisableDevicesRequest {
deviceTypes (Array[string], optional):
device types list
stringMax. Items:10
}
{
"deviceTypes": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DEVICES/CHECK_MSISDN
* Checks if devices exist for given msisdn
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DeviceResponse {
id (integer, optional):
id
,
msisdn (integer, optional):
MSISDN
,
enabled (boolean, optional):
enabled?
,
name (string, optional):
name
,
created (string, optional):
creation date
,
updated (string, optional):
last update date
,
deviceType (string, optional):
device type
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"msisdn": 0,
"enabled": true,
"name": "string",
"created": "2024-06-20T13:22:51.004Z",
"updated": "2024-06-20T13:22:51.004Z",
"deviceType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
SearchExistingDevicesRequest {
msisdn (string, optional)
stringReg. Exp.:\+?[1-9][0-9]{1,15}
}
{
"msisdn": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DEVICES/EXPORT
* Exports devices
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceType
DeviceType (optional)
query string format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DEVICES
* Returns devices
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeviceResponse
]
DeviceResponse {
id (integer, optional):
id
,
msisdn (integer, optional):
MSISDN
,
enabled (boolean, optional):
enabled?
,
name (string, optional):
name
,
created (string, optional):
creation date
,
updated (string, optional):
last update date
,
deviceType (string, optional):
device type
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"id": 0,
"msisdn": 0,
"enabled": true,
"name": "string",
"created": "2024-06-20T13:22:51.007Z",
"updated": "2024-06-20T13:22:51.007Z",
"deviceType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceType
DeviceType (optional)
query string query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DEVICES/{ID}
* Returns device
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DeviceResponse {
id (integer, optional):
id
,
msisdn (integer, optional):
MSISDN
,
enabled (boolean, optional):
enabled?
,
name (string, optional):
name
,
created (string, optional):
creation date
,
updated (string, optional):
last update date
,
deviceType (string, optional):
device type
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"msisdn": 0,
"enabled": true,
"name": "string",
"created": "2024-06-20T13:22:51.009Z",
"updated": "2024-06-20T13:22:51.009Z",
"deviceType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DIRECTORY : WEBSMS.COM DIRECTORY API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/DIRECTORY
* Returns directories
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DirectoryResponse
]
DirectoryResponse {
name (string, optional):
name
,
id (integer):
directory id
,
created (string):
creation date
,
lastModified (string, optional):
last modified
}
[
{
"name": "string",
"id": 0,
"created": "2024-06-20T13:22:51.011Z",
"lastModified": "2024-06-20T13:22:51.011Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}
* Returns directory
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DirectoryResponse {
name (string, optional):
name
,
id (integer):
directory id
,
created (string):
creation date
,
lastModified (string, optional):
last modified
}
{
"name": "string",
"id": 0,
"created": "2024-06-20T13:22:51.013Z",
"lastModified": "2024-06-20T13:22:51.013Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/EXPORT/TASKS/{ID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/EXPORT/TASKS/{ID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/EXPORT/TASKS/{ID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/COUNT
* Counts contacts
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Count {
count (integer):
count
}
{
"count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string query
FIQL/RSQL query string
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS
* Deletes all contacts
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS
* Returns contacts
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactResponse
]
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.023Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.023Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS
* Adds contact
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.025Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.025Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string body
Parameter content type: application/json
body
* Model
* Model Schema
ContactRequest {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/{ID}
* Deletes contact
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/{ID}
* Returns contact
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.029Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.029Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/{ID}
* Updates contact
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.031Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.031Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ContactRequest {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/DELETE
* Deletes multiple contacts
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/FIELDS
* Returns list of supported import fields
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
FieldMetaDataResponse
]
FieldMetaDataResponse {
name (string):
name
,
type (string):
data type
,
required (boolean):
required
,
maxLength (integer):
maximum length
,
isDuplicateCheckSupported (boolean):
whether duplicate check is supported for this field
}
[
{
"name": "string",
"type": "string",
"required": true,
"maxLength": 0,
"isDuplicateCheckSupported": true
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/FILES
* Uploads import file
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CsvFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
delimiter (string, optional):
delimiter
,
charset (string, optional):
charset
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"delimiter": "string",
"charset": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string file
formData undefined
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/FILES/{ID}
* Deletes import file
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/FILES/{ID}
* Returns import file information
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CsvFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
delimiter (string, optional):
delimiter
,
charset (string, optional):
charset
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"delimiter": "string",
"charset": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/FILES/{ID}/ROWS
* Returns import file rows
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
Row
]
Row {
row (integer):
row
,
columns (Array[Column], optional)
}
Column {
column (integer):
column
,
value (string):
value
}
[
{
"row": 0,
"columns": [
{
"column": 0,
"value": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path long page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/FILES/{ID}/FIELD_MAPPING
* Tries to detect field mapping
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/TASKS
* Returns import tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ImportContactsResponse
]
ImportContactsResponse {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
,
id (integer):
id
,
processed (integer, optional):
total of processed contacts
,
added (integer, optional):
newly added contacts
,
updated (integer, optional):
updated contacts
,
updatedCsv (integer, optional):
updated csv contacts
,
ignored (integer, optional):
ignored contacts
,
failed (integer, optional):
failed contacts
,
blacklisted (integer, optional):
blacklisted recipients
,
empty (integer, optional):
empty contacts
,
nonEnabledWhatsapp (integer, optional):
non enabled whatsapp recipients
,
state (AsyncState, optional):
invalid records
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string",
"id": 0,
"processed": 0,
"added": 0,
"updated": 0,
"updatedCsv": 0,
"ignored": 0,
"failed": 0,
"blacklisted": 0,
"empty": 0,
"nonEnabledWhatsapp": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/TASKS
* Creates and executes import task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ImportContactsResponse {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
,
id (integer):
id
,
processed (integer, optional):
total of processed contacts
,
added (integer, optional):
newly added contacts
,
updated (integer, optional):
updated contacts
,
updatedCsv (integer, optional):
updated csv contacts
,
ignored (integer, optional):
ignored contacts
,
failed (integer, optional):
failed contacts
,
blacklisted (integer, optional):
blacklisted recipients
,
empty (integer, optional):
empty contacts
,
nonEnabledWhatsapp (integer, optional):
non enabled whatsapp recipients
,
state (AsyncState, optional):
invalid records
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string",
"id": 0,
"processed": 0,
"added": 0,
"updated": 0,
"updatedCsv": 0,
"ignored": 0,
"failed": 0,
"blacklisted": 0,
"empty": 0,
"nonEnabledWhatsapp": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string body
Parameter content type: application/json
body
* Model
* Model Schema
ImportContactRequestDto {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
}
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string"
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/EXPORT
* Exports contacts
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/{ID}/CONTACT_GROUPS
* Returns contact groups for contact
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.049Z",
"lastModified": "2024-06-20T13:22:51.049Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.049Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.049Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/TASKS/{ID}
* Deletes/cancels import task
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/TASKS/{ID}
* Returns import task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ImportContactsResponse {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
,
id (integer):
id
,
processed (integer, optional):
total of processed contacts
,
added (integer, optional):
newly added contacts
,
updated (integer, optional):
updated contacts
,
updatedCsv (integer, optional):
updated csv contacts
,
ignored (integer, optional):
ignored contacts
,
failed (integer, optional):
failed contacts
,
blacklisted (integer, optional):
blacklisted recipients
,
empty (integer, optional):
empty contacts
,
nonEnabledWhatsapp (integer, optional):
non enabled whatsapp recipients
,
state (AsyncState, optional):
invalid records
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string",
"id": 0,
"processed": 0,
"added": 0,
"updated": 0,
"updatedCsv": 0,
"ignored": 0,
"failed": 0,
"blacklisted": 0,
"empty": 0,
"nonEnabledWhatsapp": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACTS/IMPORT/TASKS/{ID}/INVALID_RECORDS
* Returns invalid records from import task.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
InvalidRecord
]
InvalidRecord {
type (string, optional):
type
,
row (integer, optional):
row index
,
column (integer, optional):
column index
,
field (string, optional):
field name
,
value (string, optional):
invalid value
,
description (string, optional):
error description
}
[
{
"type": "string",
"row": 0,
"column": 0,
"field": "string",
"value": "string",
"description": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path long page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST
/V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT/TASKS
* Creates and executes export task
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE
/V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS
* Returns contact groups
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.069Z",
"lastModified": "2024-06-20T13:22:51.069Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.069Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.069Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS
* Adds contact group
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.072Z",
"lastModified": "2024-06-20T13:22:51.072Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.072Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.072Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string body
Parameter content type: application/json
body
* Model
* Model Schema
ContactGroupRequest {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/PRESET
* Returns contact group preset
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.074Z",
"lastModified": "2024-06-20T13:22:51.074Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.074Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.074Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}
* Deletes contact group
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}
* Returns contact group
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.077Z",
"lastModified": "2024-06-20T13:22:51.077Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.077Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.077Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}
* Updates contact group
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.079Z",
"lastModified": "2024-06-20T13:22:51.079Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.079Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.079Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ContactGroupRequest {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/CONTACTS
* Returns contacts for contact group
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactResponse
]
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.082Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.082Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/DELETE
* Deletes multiple contact groups
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/CLEAR
* Clears contact group
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/PURGE
* Deletes all contacts in group
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
PurgeContactGroupRequest {
exclusiveOnly (boolean, optional):
delete only contacts exclusive in this group
}
{
"exclusiveOnly": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT
* Exports contacts for contact group
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/SIZES
* Returns recipients type specific sizes for group
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactGroupSizesResponse {
total (integer, optional):
amount of total contacts in group
,
mobile (integer, optional):
amount of mobile sms recipients in group
,
whatsapp (integer, optional):
amount of whatsapp recipients in group
,
mobileAndWhatsapp (integer, optional):
amount of recipients in group containing mobile AND whatsapp
,
mobileChannelEnabled (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
mobileAndMobileChannelEnabled (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappChannelEnabled (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappAndWhatsappChannelEnabled (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabled (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
allChannelsEnabledAndReachable (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
whatsappChannelAndWhatsappDeviceEnabled (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
allChannelsEnabledAndRecipients (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddress (integer, optional):
amount of recipients in group containing emailAddress
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"total": 0,
"mobile": 0,
"whatsapp": 0,
"mobileAndWhatsapp": 0,
"mobileChannelEnabled": 0,
"mobileAndMobileChannelEnabled": 0,
"whatsappChannelEnabled": 0,
"whatsappAndWhatsappChannelEnabled": 0,
"allChannelsEnabled": 0,
"allChannelsEnabledAndReachable": 0,
"whatsappChannelAndWhatsappDeviceEnabled": 0,
"allChannelsEnabledAndRecipients": 0,
"emailAddress": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/CONTACT_GROUPS/{ID}/MEMBERSHIPS
* Returns contacts group memberships for contact group
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupMembershipResponse
]
ContactGroupMembershipResponse {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group mebership id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true,
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/MEMBERSHIPS
* Returns contact group memberships
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupMembershipResponse
]
ContactGroupMembershipResponse {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group mebership id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true,
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/MEMBERSHIPS
* Adds contact group membership
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
ContactGroupMembershipResponse {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group mebership id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true,
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string body
Parameter content type: application/json
body
* Model
* Model Schema
ContactGroupMembershipRequest {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
}
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/MEMBERSHIPS/COPY
* Copies contact group members from one or more contact groups to
another
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string body
Parameter content type: application/json
body
* Model
* Model Schema
CopyContactGroupMembershipsRequest {
sourceIds (Array[integer], optional):
source contact group ids
,
targetId (integer, optional):
target contact group id
}
{
"sourceIds": [
0
],
"targetId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/DIRECTORY/{DIRECTORYSELECTOR}/MEMBERSHIPS/{ID}
* Deletes contact group membership
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/DIRECTORY/{DIRECTORYSELECTOR}/MEMBERSHIPS/{ID}
* Returns contact group membership
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactGroupMembershipResponse {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group mebership id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true,
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/DIRECTORY/{DIRECTORYSELECTOR}/MEMBERSHIPS/{ID}
* Updates contact group membership
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactGroupMembershipResponse {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group mebership id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true,
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ContactGroupMembershipRequest {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
}
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/MEMBERSHIPS/{ID}/PURGE
* Deletes contact in membership
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
PurgeContactGroupMembershipRequest {
exclusiveOnly (boolean, optional):
delete only contacts exclusive in this group
}
{
"exclusiveOnly": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/MEMBERSHIPS/ADD
* Adds contacts to one or more contact groups
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string body
Parameter content type: application/json
body
* Model
* Model Schema
AddContactGroupMembershipsRequest {
contactIds (Array[integer], optional):
source contact ids
,
contactGroupIds (Array[integer], optional):
target contact group id
,
deleteExisting (boolean, optional):
whether to delete exiting memberships for the contacts
}
{
"contactIds": [
0
],
"contactGroupIds": [
0
],
"deleteExisting": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/DIRECTORY/{DIRECTORYSELECTOR}/MEMBERSHIPS/DELETE
* Deletes multiple contact group memberships
PARAMETERS
Parameter Value Description Parameter Type Data Type directorySelector
path string body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* EXCEPTION_ROUTINGS : EXCEPTION ROUTING API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /V1/EXCEPTION_ROUTINGS/{ID}
* Deletes exception routing
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/EXCEPTION_ROUTINGS/{ID}
* Returns exception routing
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExceptionRoutingResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
,
id (integer, optional):
exception routing id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
,
createdBy (string, optional):
createdBy
,
lastModifiedBy (string, optional):
lastModifiedBy
,
createdOn (string, optional):
createdOn
,
lastOrigin (string, optional):
lastOrigin
}
Link {
rel (string, optional),
href (string, optional)
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string",
"id": 0,
"timestamp": "2024-06-20T13:22:51.116Z",
"links": [
{
"rel": "string",
"href": "string"
}
],
"createdBy": "string",
"lastModifiedBy": "string",
"createdOn": "2024-06-20T13:22:51.116Z",
"lastOrigin": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/EXCEPTION_ROUTINGS/{ID}
* Updates exception routing
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExceptionRoutingResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
,
id (integer, optional):
exception routing id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
,
createdBy (string, optional):
createdBy
,
lastModifiedBy (string, optional):
lastModifiedBy
,
createdOn (string, optional):
createdOn
,
lastOrigin (string, optional):
lastOrigin
}
Link {
rel (string, optional),
href (string, optional)
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string",
"id": 0,
"timestamp": "2024-06-20T13:22:51.117Z",
"links": [
{
"rel": "string",
"href": "string"
}
],
"createdBy": "string",
"lastModifiedBy": "string",
"createdOn": "2024-06-20T13:22:51.117Z",
"lastOrigin": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ExceptionRoutingRequest {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/EXCEPTION_ROUTINGS
* Returns exception routing entries
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExceptionRoutingResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
,
id (integer, optional):
exception routing id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
,
createdBy (string, optional):
createdBy
,
lastModifiedBy (string, optional):
lastModifiedBy
,
createdOn (string, optional):
createdOn
,
lastOrigin (string, optional):
lastOrigin
}
Link {
rel (string, optional),
href (string, optional)
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string",
"id": 0,
"timestamp": "2024-06-20T13:22:51.118Z",
"links": [
{
"rel": "string",
"href": "string"
}
],
"createdBy": "string",
"lastModifiedBy": "string",
"createdOn": "2024-06-20T13:22:51.118Z",
"lastOrigin": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/EXCEPTION_ROUTINGS
* Adds exception routing
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
ExceptionRoutingResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
,
id (integer, optional):
exception routing id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
,
createdBy (string, optional):
createdBy
,
lastModifiedBy (string, optional):
lastModifiedBy
,
createdOn (string, optional):
createdOn
,
lastOrigin (string, optional):
lastOrigin
}
Link {
rel (string, optional),
href (string, optional)
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string",
"id": 0,
"timestamp": "2024-06-20T13:22:51.120Z",
"links": [
{
"rel": "string",
"href": "string"
}
],
"createdBy": "string",
"lastModifiedBy": "string",
"createdOn": "2024-06-20T13:22:51.120Z",
"lastOrigin": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ExceptionRoutingRequest {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/EXCEPTION_ROUTINGS/SENDERS
* Returns available senders
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExceptionRoutingResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
,
id (integer, optional):
exception routing id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
,
createdBy (string, optional):
createdBy
,
lastModifiedBy (string, optional):
lastModifiedBy
,
createdOn (string, optional):
createdOn
,
lastOrigin (string, optional):
lastOrigin
}
Link {
rel (string, optional),
href (string, optional)
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string",
"id": 0,
"timestamp": "2024-06-20T13:22:51.122Z",
"links": [
{
"rel": "string",
"href": "string"
}
],
"createdBy": "string",
"lastModifiedBy": "string",
"createdOn": "2024-06-20T13:22:51.122Z",
"lastOrigin": "string"
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/EXCEPTION_ROUTINGS/ROUTE_PROFILES
* Returns available route profiles
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExceptionRoutingResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
,
id (integer, optional):
exception routing id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
,
createdBy (string, optional):
createdBy
,
lastModifiedBy (string, optional):
lastModifiedBy
,
createdOn (string, optional):
createdOn
,
lastOrigin (string, optional):
lastOrigin
}
Link {
rel (string, optional),
href (string, optional)
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string",
"id": 0,
"timestamp": "2024-06-20T13:22:51.122Z",
"links": [
{
"rel": "string",
"href": "string"
}
],
"createdBy": "string",
"lastModifiedBy": "string",
"createdOn": "2024-06-20T13:22:51.122Z",
"lastOrigin": "string"
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/EXCEPTION_ROUTINGS/{ID}/TEST_MESSAGE
* Send a test message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExceptionRoutingResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
,
id (integer, optional):
exception routing id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
,
createdBy (string, optional):
createdBy
,
lastModifiedBy (string, optional):
lastModifiedBy
,
createdOn (string, optional):
createdOn
,
lastOrigin (string, optional):
lastOrigin
}
Link {
rel (string, optional),
href (string, optional)
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string",
"id": 0,
"timestamp": "2024-06-20T13:22:51.123Z",
"links": [
{
"rel": "string",
"href": "string"
}
],
"createdBy": "string",
"lastModifiedBy": "string",
"createdOn": "2024-06-20T13:22:51.123Z",
"lastOrigin": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ExceptionRoutingTestMessageRequest {
content (string, optional):
content
}
{
"content": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/EXCEPTION_ROUTINGS/{ID}/TEST_MESSAGE_LOGS
* Returns test message logs
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExceptionRoutingResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
,
id (integer, optional):
exception routing id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
,
createdBy (string, optional):
createdBy
,
lastModifiedBy (string, optional):
lastModifiedBy
,
createdOn (string, optional):
createdOn
,
lastOrigin (string, optional):
lastOrigin
}
Link {
rel (string, optional),
href (string, optional)
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string",
"id": 0,
"timestamp": "2024-06-20T13:22:51.124Z",
"links": [
{
"rel": "string",
"href": "string"
}
],
"createdBy": "string",
"lastModifiedBy": "string",
"createdOn": "2024-06-20T13:22:51.124Z",
"lastOrigin": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/EXCEPTION_ROUTINGS/{ID}/TEST_MESSAGE_LOGS/{TEST_MESSAGE_LOG_ID}
* Returns test message log
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExceptionRoutingResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
regionCode (string, optional),
active (boolean, optional):
active
,
routeProfile (string, optional):
routeProfile
,
sender (string, optional):
sender
,
id (integer, optional):
exception routing id
,
timestamp (string, optional):
timestamp
,
links (Array[Link], optional):
links
,
createdBy (string, optional):
createdBy
,
lastModifiedBy (string, optional):
lastModifiedBy
,
createdOn (string, optional):
createdOn
,
lastOrigin (string, optional):
lastOrigin
}
Link {
rel (string, optional),
href (string, optional)
}
{
"msisdn": "string",
"regionCode": "string",
"active": true,
"routeProfile": "string",
"sender": "string",
"id": 0,
"timestamp": "2024-06-20T13:22:51.126Z",
"links": [
{
"rel": "string",
"href": "string"
}
],
"createdBy": "string",
"lastModifiedBy": "string",
"createdOn": "2024-06-20T13:22:51.126Z",
"lastOrigin": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
test_message_log_id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* HLR_LOOKUPS : HLR LOOKUPS API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/HLR_LOOKUPS
* Returns HLR Lookup data
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HlrLookupResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
network (string, optional):
network
,
status (string, optional):
status
,
ported (boolean, optional):
ported
,
timestamp (string, optional):
timestamp
}
{
"msisdn": "string",
"network": "string",
"status": "string",
"ported": true,
"timestamp": "2024-06-20T13:22:51.128Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/HLR_LOOKUPS
* Returns HLR Lookup data of the supplied recipient number
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HlrLookupResponse {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
,
network (string, optional):
network
,
status (string, optional):
status
,
ported (boolean, optional):
ported
,
timestamp (string, optional):
timestamp
}
{
"msisdn": "string",
"network": "string",
"status": "string",
"ported": true,
"timestamp": "2024-06-20T13:22:51.130Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
HlrLookupRequest {
msisdn (string, optional):
msisdn
stringReg. Exp.:^|\+?[1-9][0-9]{1,15}
}
{
"msisdn": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* INBOX : WEBSMS.COM INBOX API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * PUT /V1/INBOX/MESSAGES/{ID}/READ
* Marks inbox message as read
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INBOX/MESSAGES/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INBOX/MESSAGES/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/INBOX/MESSAGES/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/INBOX/MESSAGES/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INBOX/MESSAGES/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INBOX/MESSAGES
* Returns inbox messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
InboxMessageResponse
]
InboxMessageResponse {
id (integer):
message id
,
content (string):
message content
,
recipient (string):
recipient number
,
sender (string):
sender number
,
receivedOn (string):
received on
,
read (boolean):
read?
,
remoteSms (boolean):
remote SMS?
,
messageType (string, optional):
message type
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
senderContact (ContactResponse, optional):
sender contact details, if available
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"content": "string",
"recipient": "string",
"sender": "string",
"receivedOn": "2024-06-20T13:22:51.138Z",
"read": true,
"remoteSms": true,
"messageType": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"senderContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.138Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.138Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/INBOX/MESSAGES/{ID}
* Deletes inbox message
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INBOX/MESSAGES/{ID}
* Returns inbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
InboxMessageResponse {
id (integer):
message id
,
content (string):
message content
,
recipient (string):
recipient number
,
sender (string):
sender number
,
receivedOn (string):
received on
,
read (boolean):
read?
,
remoteSms (boolean):
remote SMS?
,
messageType (string, optional):
message type
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
senderContact (ContactResponse, optional):
sender contact details, if available
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
{
"id": 0,
"content": "string",
"recipient": "string",
"sender": "string",
"receivedOn": "2024-06-20T13:22:51.141Z",
"read": true,
"remoteSms": true,
"messageType": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"senderContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.141Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.141Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/INBOX/MESSAGES/DELETE
* Deletes multiple inbox messages
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INBOX/MESSAGES/EXPORT
* Exports inbox messages
PARAMETERS
Parameter Value Description Parameter Type Data Type format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/INBOX/MESSAGES/{ID}/UNREAD
* Marks inbox message as unread
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INBOX/MESSAGES/{ID}/CONVERSATION
* Returns conversation around the given inbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ConversationMessageResponse
]
ConversationMessageResponse {
direction (string, optional):
direction
,
content (string, optional):
message content
,
timestamp (string):
timestamp
,
messageType (string, optional):
message type
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"direction": "string",
"content": "string",
"timestamp": "2024-06-20T13:22:51.146Z",
"messageType": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"automated": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer size
The preferred amount of conversation items
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* JOBS : JOB API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/JOBS/CONTACT_SUBSCRIPTION_REPORTS
* Returns all contact subscription report jobs
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactSubscriptionReport {
emailRecipients (Array[string], optional):
email recipient list
stringMax. Items:100
,
weekdays (Array[string], optional):
weekdays
,
enabled (boolean, optional):
enabled?
}
{
"emailRecipients": [
"string"
],
"weekdays": [
"string"
],
"enabled": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer contactGroupId
Filters results by contact group ids
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/JOBS/CONTACT_SUBSCRIPTION_REPORTS
* Adds contact subscription report
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
ContactSubscriptionReport {
emailRecipients (Array[string], optional):
email recipient list
stringMax. Items:100
,
weekdays (Array[string], optional):
weekdays
,
enabled (boolean, optional):
enabled?
}
{
"emailRecipients": [
"string"
],
"weekdays": [
"string"
],
"enabled": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ContactSubscriptionReport {
emailRecipients (Array[string], optional):
email recipient list
stringMax. Items:100
,
weekdays (Array[string], optional):
weekdays
,
enabled (boolean, optional):
enabled?
}
{
"emailRecipients": [
"string"
],
"weekdays": [
"string"
],
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/JOBS/CONTACT_SUBSCRIPTION_REPORTS/{ID}
* Returns contact subscription report
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactSubscriptionReport {
emailRecipients (Array[string], optional):
email recipient list
stringMax. Items:100
,
weekdays (Array[string], optional):
weekdays
,
enabled (boolean, optional):
enabled?
}
{
"emailRecipients": [
"string"
],
"weekdays": [
"string"
],
"enabled": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/JOBS/CONTACT_SUBSCRIPTION_REPORTS/{ID}
* Updates contact subscription report job
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactSubscriptionReport {
emailRecipients (Array[string], optional):
email recipient list
stringMax. Items:100
,
weekdays (Array[string], optional):
weekdays
,
enabled (boolean, optional):
enabled?
}
{
"emailRecipients": [
"string"
],
"weekdays": [
"string"
],
"enabled": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ContactSubscriptionReport {
emailRecipients (Array[string], optional):
email recipient list
stringMax. Items:100
,
weekdays (Array[string], optional):
weekdays
,
enabled (boolean, optional):
enabled?
}
{
"emailRecipients": [
"string"
],
"weekdays": [
"string"
],
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/JOBS/CONTACT_SUBSCRIPTION_REPORTS/{ID}/EXECUTE
* Updates contact subscription report job
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MAILBOX : WEBSMS.COM MAILBOX API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /V1/MAILBOX/{MAILBOXSELECTOR}/ATTACHMENTS/{ID}
* Deletes attachment
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ATTACHMENTS/{ID}
* Returns attachment info
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AttachmentResponseDto {
id (integer, optional):
id
,
mimeType (string, optional):
mimeType
,
size (integer, optional):
size
,
attachmentType (string, optional):
attachment type
,
name (string, optional):
name
,
url (string, optional):
url
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"mimeType": "string",
"size": 0,
"attachmentType": "string",
"name": "string",
"url": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ATTACHMENTS/{ID}/CONTENT
* Returns attachment
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ATTACHMENTS/{ID}/THUMBNAIL
* Returns attachment thumbnail
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MAILBOX/{MAILBOXSELECTOR}/ATTACHMENTS
* Adds attachment
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
AttachmentResponseDto {
id (integer, optional):
id
,
mimeType (string, optional):
mimeType
,
size (integer, optional):
size
,
attachmentType (string, optional):
attachment type
,
name (string, optional):
name
,
url (string, optional):
url
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"mimeType": "string",
"size": 0,
"attachmentType": "string",
"name": "string",
"url": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string file
formData undefined attachmentType formData string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/CONVERSATIONS/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/CONVERSATIONS/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MAILBOX/{MAILBOXSELECTOR}/CONVERSATIONS/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/MAILBOX/{MAILBOXSELECTOR}/CONVERSATIONS/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/CONVERSATIONS/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/CONVERSATIONS/{ID}/MESSAGES
* Returns messages for the given conversation
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ConversationMessageResponse
]
ConversationMessageResponse {
direction (string, optional):
direction
,
content (string, optional):
message content
,
timestamp (string):
timestamp
,
messageType (string, optional):
message type
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"direction": "string",
"content": "string",
"timestamp": "2024-06-20T13:22:51.170Z",
"messageType": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"automated": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer size
The preferred amount of messages
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/CONVERSATIONS/EXPORT
* Exports conversation messages
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/CONVERSATIONS
* Returns conversations
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ConversationResponse
]
ConversationResponse {
id (integer, optional):
id
,
identifier (string, optional):
identifier
,
timestamp (string, optional):
timestamp
,
latestMessageContent (string, optional):
latest message content
,
latestMessageType (string, optional):
latest message type
,
latestMessageDirection (string, optional):
latest message direction
,
relatedContactsAmount (integer, optional):
related contacts amount
,
links (Array[Link], optional):
links
,
firstRelatedContact (ContactResponse, optional):
contact details, if available
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"identifier": "string",
"timestamp": "2024-06-20T13:22:51.175Z",
"latestMessageContent": "string",
"latestMessageType": "string",
"latestMessageDirection": "string",
"relatedContactsAmount": 0,
"links": [
{
"rel": "string",
"href": "string"
}
],
"firstRelatedContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.175Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.175Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX
* Returns mailboxes
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MailboxResponse
]
MailboxResponse {
name (string, optional):
name
,
id (integer):
mailbox id
,
created (string):
creation date
,
lastModified (string, optional):
last modified
}
[
{
"name": "string",
"id": 0,
"created": "2024-06-20T13:22:51.179Z",
"lastModified": "2024-06-20T13:22:51.179Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}
* Returns mailbox
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MailboxResponse {
name (string, optional):
name
,
id (integer):
mailbox id
,
created (string):
creation date
,
lastModified (string, optional):
last modified
}
{
"name": "string",
"id": 0,
"created": "2024-06-20T13:22:51.182Z",
"lastModified": "2024-06-20T13:22:51.182Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS
* Returns delivery details for the given archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeliveryDetailResponse
]
DeliveryDetailResponse {
id (integer):
monthly record id
,
sentOn (string):
sent on
,
recipient (string):
recipient
,
sender (string):
sender
,
messageType (string):
message type
,
username (string):
username
,
productId (integer, optional):
product id
,
productName (string, optional):
product name
,
origin (string, optional):
message origin
= ['api_http', 'api_http_simple', 'api_rest', 'api_rest_simple',
'api_rest_converged', 'api_rest_customer_channel', 'api_smpp',
'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp', 'sdk_perl',
'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php', 'api_smtp_email2sms',
'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
detail (string, optional):
detail
,
message (string, optional):
message
,
statusOn (string, optional):
status on (date of delivery state)
,
status (string, optional):
delivery state
,
deliveryReport (boolean, optional):
delivery report requested
,
contentCategory (string, optional):
contentCategory
,
directionType (string, optional):
directionType
,
links (Array[Link], optional):
links
,
recipientContact (ContactResponse, optional):
recipient contact details, if available
,
product (ProductResponse, optional):
product
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
ProductResponse {
id (integer, optional):
product id
,
name (string, optional):
name
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"sentOn": "2024-06-20T13:22:51.183Z",
"recipient": "string",
"sender": "string",
"messageType": "string",
"username": "string",
"productId": 0,
"productName": "string",
"origin": "api_http",
"detail": "string",
"message": "string",
"statusOn": "2024-06-20T13:22:51.183Z",
"status": "string",
"deliveryReport": true,
"contentCategory": "string",
"directionType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"recipientContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.183Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.183Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"product": {
"id": 0,
"name": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT
* Exports delivery details for the given archive message
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer format
Export format (pdf, csv, xsl)
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/RECIPIENTS
* Returns recipients for the given archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactResponse
]
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.201Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.201Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/CONTACT_GROUPS
* Returns contact groups for the given archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.205Z",
"lastModified": "2024-06-20T13:22:51.205Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.205Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.205Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES
* Deletes all archive messages
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES
* Returns archive messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ArchiveMessageResponse
]
ArchiveMessageResponse {
id (integer):
message id
,
transferId (string):
transfer id
,
transferStart (string):
transfer start timestamp
,
transferEnd (string):
transfer end timestamp
,
content (string):
message content
,
sentOn (string):
sent on
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
numberOfRecipients (integer, optional):
number of recipients
,
subject (string, optional):
subject
,
numberOfContactGroups (integer, optional):
number of contact groups
,
contactGroupIds (Array[integer], optional):
contact group id list
,
recipients (Array[string], optional):
recipient list
,
selectors (Array[string], optional):
selectors
,
sender (string, optional):
sender identification
,
contentCategory (string, optional):
content category
,
messageType (string, optional):
message_type
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
urlshorteningType (string, optional):
urlshortening type
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"id": 0,
"transferId": "string",
"transferStart": "2024-06-20T13:22:51.210Z",
"transferEnd": "2024-06-20T13:22:51.210Z",
"content": "string",
"sentOn": "2024-06-20T13:22:51.210Z",
"origin": "api_http",
"numberOfRecipients": 0,
"subject": "string",
"numberOfContactGroups": 0,
"contactGroupIds": [
0
],
"recipients": [
"string"
],
"selectors": [
"string"
],
"sender": "string",
"contentCategory": "string",
"messageType": "string",
"lastModified": "2024-06-20T13:22:51.210Z",
"lastModifiedBy": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"urlshorteningType": "string",
"automated": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}
* Deletes archive message
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}
* Returns archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ArchiveMessageResponse {
id (integer):
message id
,
transferId (string):
transfer id
,
transferStart (string):
transfer start timestamp
,
transferEnd (string):
transfer end timestamp
,
content (string):
message content
,
sentOn (string):
sent on
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
numberOfRecipients (integer, optional):
number of recipients
,
subject (string, optional):
subject
,
numberOfContactGroups (integer, optional):
number of contact groups
,
contactGroupIds (Array[integer], optional):
contact group id list
,
recipients (Array[string], optional):
recipient list
,
selectors (Array[string], optional):
selectors
,
sender (string, optional):
sender identification
,
contentCategory (string, optional):
content category
,
messageType (string, optional):
message_type
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
urlshorteningType (string, optional):
urlshortening type
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"transferId": "string",
"transferStart": "2024-06-20T13:22:51.215Z",
"transferEnd": "2024-06-20T13:22:51.215Z",
"content": "string",
"sentOn": "2024-06-20T13:22:51.215Z",
"origin": "api_http",
"numberOfRecipients": 0,
"subject": "string",
"numberOfContactGroups": 0,
"contactGroupIds": [
0
],
"recipients": [
"string"
],
"selectors": [
"string"
],
"sender": "string",
"contentCategory": "string",
"messageType": "string",
"lastModified": "2024-06-20T13:22:51.215Z",
"lastModifiedBy": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"urlshorteningType": "string",
"automated": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/DELETE
* Deletes multiple archive messages
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/SELECTORS
* Returns selectors for the given archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactSelectorResponse
]
ContactSelectorResponse {
name (string):
name
,
numberOfContacts (integer, optional):
number of contacts
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"name": "string",
"numberOfContacts": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/EXPORT
* Exports archive messages
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT/TASKS
* Returns delivery details export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT/TASKS
* Creates and executes delivery details export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}
* Deletes/cancels delivery details export task
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}
* Returns delivery details export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}/FILE
* Returns delivery details export file
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/STATISTICS/URLSHORTENER/EXPORT
* Exports urlshortener statistics
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/STATISTICS/URLSHORTENER/EXPORT/TASKS
* Returns urlshortener statistic export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageArchiveUrlshortenerStatisticExportResponse
]
MessageArchiveUrlshortenerStatisticExportResponse {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/STATISTICS/URLSHORTENER/EXPORT/TASKS
* Creates and executes urlshortener statistic export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MessageArchiveUrlshortenerStatisticExportResponse {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string body
Parameter content type: application/json
body
* Model
* Model Schema
MessageArchiveUrlshortenerStatisticExportRequest {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string"
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean query
FIQL/RSQL query string
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/STATISTICS/URLSHORTENER/EXPORT/TASKS/{TASKID}
* Deletes/cancels urlshortener statistic export task
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/STATISTICS/URLSHORTENER/EXPORT/TASKS/{TASKID}
* Returns urlshortener statistic export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MessageArchiveUrlshortenerStatisticExportResponse {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/STATISTICS/URLSHORTENER/EXPORT/TASKS/{TASKID}/FILE
* Returns urlshortener statistic export file
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/COUNT
* Counts archive messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Count {
count (integer):
count
}
{
"count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string query
FIQL/RSQL query string
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/STATISTICS/URLSHORTENER
* Returns urlshortener statistics for archive messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageArchiveUrlshortenerStatisticResponse
]
MessageArchiveUrlshortenerStatisticResponse {
intervalStart (string, optional):
interval start time
,
intervalEnd (string, optional):
interval end time
,
archiveMessageAmount (integer, optional):
archive message amount
,
redirectAmount (integer, optional):
redirect amount
}
[
{
"intervalStart": "2024-06-20T13:22:51.247Z",
"intervalEnd": "2024-06-20T13:22:51.247Z",
"archiveMessageAmount": 0,
"redirectAmount": 0
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string query
FIQL/RSQL query string
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/ARCHIVE/MESSAGES/{ID}/STATISTICS/WHATSAPP
* Returns whatsapp statistics for given archive message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WatMessageStatisticResponse {
intervalStart (string, optional):
interval start time
,
intervalEnd (string, optional):
interval end time
,
acceptedAmount (integer, optional):
accepted amount (disptached to whatsapp)
,
deliveredAmount (integer, optional):
delivered amount
,
readAmount (integer, optional):
read amount
,
deliveredAndReadAmount (integer, optional):
amount of messages that were delivered AND read
,
deliveredAndReadAvgDelay (integer, optional):
average time in seconds between delivery and read status
}
{
"intervalStart": "2024-06-20T13:22:51.249Z",
"intervalEnd": "2024-06-20T13:22:51.249Z",
"acceptedAmount": 0,
"deliveredAmount": 0,
"readAmount": 0,
"deliveredAndReadAmount": 0,
"deliveredAndReadAvgDelay": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES/{ID}/RECIPIENTS
* Returns recipients for the given outbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactResponse
]
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.250Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.250Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES/{ID}/CONTACT_GROUPS
* Returns contact groups for the given outbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.252Z",
"lastModified": "2024-06-20T13:22:51.252Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.252Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.252Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES
* Deletes all (deleteable) outbox messages
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES
* Returns outbox messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
OutboxMessageResponse
]
OutboxMessageResponse {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message id
,
status (string):
status
,
numberOfRecipients (integer, optional):
number of recipients
,
numberOfContactGroups (integer, optional):
number of contact groups
,
sender (string, optional):
sender identification
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:51.255Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:51.255Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string",
"id": 0,
"status": "string",
"numberOfRecipients": 0,
"numberOfContactGroups": 0,
"sender": "string",
"lastModified": "2024-06-20T13:22:51.255Z",
"lastModifiedBy": "string",
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"origin": "api_http",
"automated": true
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES
* Add (queues) outbox message
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
OutboxMessageResponse {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message id
,
status (string):
status
,
numberOfRecipients (integer, optional):
number of recipients
,
numberOfContactGroups (integer, optional):
number of contact groups
,
sender (string, optional):
sender identification
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
}
Link {
rel (string, optional),
href (string, optional)
}
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:51.259Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:51.259Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string",
"id": 0,
"status": "string",
"numberOfRecipients": 0,
"numberOfContactGroups": 0,
"sender": "string",
"lastModified": "2024-06-20T13:22:51.259Z",
"lastModifiedBy": "string",
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"origin": "api_http",
"automated": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string body
Parameter content type: application/json
body
* Model
* Model Schema
OutboxMessageRequest {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
}
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:50.755Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:50.755Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES/{ID}
* Deletes outbox message
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES/{ID}
* Returns outbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
OutboxMessageResponse {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message id
,
status (string):
status
,
numberOfRecipients (integer, optional):
number of recipients
,
numberOfContactGroups (integer, optional):
number of contact groups
,
sender (string, optional):
sender identification
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
}
Link {
rel (string, optional),
href (string, optional)
}
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:51.264Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:51.264Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string",
"id": 0,
"status": "string",
"numberOfRecipients": 0,
"numberOfContactGroups": 0,
"sender": "string",
"lastModified": "2024-06-20T13:22:51.264Z",
"lastModifiedBy": "string",
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"origin": "api_http",
"automated": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES/{ID}
* Updates outbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
OutboxMessageResponse {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message id
,
status (string):
status
,
numberOfRecipients (integer, optional):
number of recipients
,
numberOfContactGroups (integer, optional):
number of contact groups
,
sender (string, optional):
sender identification
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
}
Link {
rel (string, optional),
href (string, optional)
}
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:51.265Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:51.265Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string",
"id": 0,
"status": "string",
"numberOfRecipients": 0,
"numberOfContactGroups": 0,
"sender": "string",
"lastModified": "2024-06-20T13:22:51.265Z",
"lastModifiedBy": "string",
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"origin": "api_http",
"automated": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
OutboxMessageRequest {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
}
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:50.756Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:50.756Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES/DELETE
* Deletes multiple outbox messages
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES/{ID}/SELECTORS
* Returns selectors for the given outbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactSelectorResponse
]
ContactSelectorResponse {
name (string):
name
,
numberOfContacts (integer, optional):
number of contacts
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"name": "string",
"numberOfContacts": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/OUTBOX/MESSAGES/COUNT
* Counts outbox messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Count {
count (integer):
count
}
{
"count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string query
FIQL/RSQL query string
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/{ID}/READ
* Marks inbox message as read
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES
* Deletes all inbox messages
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES
* Returns inbox messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
InboxMessageResponse
]
InboxMessageResponse {
id (integer):
message id
,
content (string):
message content
,
recipient (string):
recipient number
,
sender (string):
sender number
,
receivedOn (string):
received on
,
read (boolean):
read?
,
remoteSms (boolean):
remote SMS?
,
messageType (string, optional):
message type
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
senderContact (ContactResponse, optional):
sender contact details, if available
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"content": "string",
"recipient": "string",
"sender": "string",
"receivedOn": "2024-06-20T13:22:51.286Z",
"read": true,
"remoteSms": true,
"messageType": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"senderContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.287Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.287Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/{ID}
* Deletes inbox message
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/{ID}
* Returns inbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
InboxMessageResponse {
id (integer):
message id
,
content (string):
message content
,
recipient (string):
recipient number
,
sender (string):
sender number
,
receivedOn (string):
received on
,
read (boolean):
read?
,
remoteSms (boolean):
remote SMS?
,
messageType (string, optional):
message type
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
senderContact (ContactResponse, optional):
sender contact details, if available
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
{
"id": 0,
"content": "string",
"recipient": "string",
"sender": "string",
"receivedOn": "2024-06-20T13:22:51.291Z",
"read": true,
"remoteSms": true,
"messageType": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"senderContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.292Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.292Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/DELETE
* Deletes multiple inbox messages
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/EXPORT
* Exports inbox messages
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/{ID}/UNREAD
* Marks inbox message as unread
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/{ID}/CONVERSATION
* Returns conversation around the given inbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ConversationMessageResponse
]
ConversationMessageResponse {
direction (string, optional):
direction
,
content (string, optional):
message content
,
timestamp (string):
timestamp
,
messageType (string, optional):
message type
,
attachmentId (integer, optional):
attachment id
,
attachmentMimeType (string, optional):
attachment mime type
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"direction": "string",
"content": "string",
"timestamp": "2024-06-20T13:22:51.299Z",
"messageType": "string",
"attachmentId": 0,
"attachmentMimeType": "string",
"automated": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string id path integer size
The preferred amount of conversation items
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/MAILBOX/{MAILBOXSELECTOR}/INBOX/MESSAGES/COUNT
* Counts inbox messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Count {
count (integer):
count
}
{
"count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mailboxSelector path
string query
FIQL/RSQL query string
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MESSAGING : MESSAGING API
* Show/Hide
* List Operations
* Expand Operations
* * POST /CONVERGED/WHATSAPP/ATTACHMENT
* Upload whatsapp attachment
IMPLEMENTATION NOTES
Uploads a whatsapp attachment. Resulting attachmentId may be used when
sending whatsapp messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AttachmentResponse {
statusCode (integer, optional):
Status code
,
statusMessage (string, optional):
Description of the response status code.
,
attachmentId (integer, optional):
the attachment id
}
{
"statusCode": 2000,
"statusMessage": "OK",
"attachmentId": 20
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type file
The file to upload.
formData undefined
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONVERGED/VOICE
* Sends a voice message to a list of recipients
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MessageSendResponse {
statusCode (integer, optional):
Status code
,
statusMessage (string, optional):
Description of the response status code.
,
clientMessageId (string, optional):
Contains the message id defined in the request.
,
transferId (string, optional):
Unique identifier that is set after successful processing of the request.
,
smsCount (integer, optional):
The actual number of generated SMS.
}
{
"statusCode": 2000,
"statusMessage": "OK",
"clientMessageId": "myUniqueId",
"transferId": "0059d0b20100a0a8b803",
"smsCount": 1
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
VoiceMessageSendRequest {
recipientAddressList (Array[integer]):
List of recipients (E164 formatted MSISDNs - see Wikipedia
en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The
list of recipients may contain a maximum of 1000 entries.
,
senderAddress (string, optional):
Optional. Address of the sender (assigned to the account) from which the
message is sent.
,
senderAddressType (string, optional):
Optional. The sender address type. The following address types are
supported: national, international, alphanumeric or shortcode).
= ['national', 'international', 'alphanumeric', 'shortcode']
stringEnum:"national", "international", "alphanumeric", "shortcode"
,
contentCategory (string, optional):
Optional. The content category that is used to categorize the message
(used for blacklisting). The following content categories are supported:
informational or advertisement. If no content category is provided, the
default setting is used (may be changed inside the onlinesms web
interface).
= ['informational', 'advertisement']
stringEnum:"informational", "advertisement"
,
notificationCallbackUrl (string, optional):
Optional. When setting a notificationCallbackUrl all delivery reports are
forwarded to this URL.
,
clientMessageId (string, optional):
Optional. May contain a freely definable message id.
,
priority (integer, optional):
Optional. Priority of the message. Must not exceed the value configured
for the account used to send the message. For more information please
contact our customer service.
,
test (boolean, optional):
Optional. true: The transmission is only simulated, no SMS is sent.
Depending on the number of recipients the status code 2000 or 2001 is
returned. false (default): No simulation is done. The SMS is sent via the
SMS Gateway.
,
validityPeriode (integer, optional):
Optional. Specifies the validity periode (in seconds) in which the
message is tried to be delivered to the recipient. A minimum of 1 minute
and a maximum of 3 days are allowed.
integerMin. Value:60Max. Value:259200
,
messageContent (string),
maxSmsPerMessage (integer, optional)
}
{
"recipientAddressList": "[\"436991234567\"]",
"senderAddress": "4369912345678",
"senderAddressType": "international",
"contentCategory": "informational",
"notificationCallbackUrl": "https://user:pass@myservice.com/myservice/",
"clientMessageId": "myUniqueId",
"priority": 5,
"test": true,
"validityPeriode": 300,
"messageContent": "string",
"maxSmsPerMessage": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 2000
OK - Accepted. The request has been accepted by the network operator.
2001
OK - Queued. Request with multiple recipients has been queued for
immediate delivery.
4001
ERR - Invalid Credentials. Inactive account or customer.
4002
ERR - Invalid Recipients. One or more recipients are not in the correct
format or contain invalid msisdns (i.e: 436761234567).
4003
ERR - Invalid Sender. Sender address or type is invalid.
4008
ERR - Invalid clientMessageId.
4009
ERR - Message text (messageContent) is invalid
4013
ERR - Message limit is reached.
4014
ERR - Sender IP address is not authorized.
4015
ERR - Invalid message priority.
4016
ERR - Invalid COD ReturnAddress (notificationCallbackUrl)
4019
ERR - A required parameter was not given. The parameter name is shown in
the statusMessage
4021
ERR - Invalid account.
4022
ERR - Access to the API was denied.
4023
ERR - Request limit exceeded for this IP address
4025
ERR - Recipients amount over limit. A maximum of 50 recipients per
message is allowed in a single request
4026
ERR - MaxSmsPerMessage exceeded. SMS amount limit per message was hit.
4040
ERR - Invalid contentCategory.
4041
ERR - Invalid validityPeriode. A minimum of 60 seconds is allowed
5000
ERR - Internal error. Please contact support.
5003
ERR - The service is currently not available
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONVERGED/WHATSAPP
* Send whatsapp message
IMPLEMENTATION NOTES
Sends a whatsapp message (broadcast) to a list of recipients
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MessageSendResponse {
statusCode (integer, optional):
Status code
,
statusMessage (string, optional):
Description of the response status code.
,
clientMessageId (string, optional):
Contains the message id defined in the request.
,
transferId (string, optional):
Unique identifier that is set after successful processing of the request.
,
smsCount (integer, optional):
The actual number of generated SMS.
}
{
"statusCode": 2000,
"statusMessage": "OK",
"clientMessageId": "myUniqueId",
"transferId": "0059d0b20100a0a8b803",
"smsCount": 1
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
WhatsAppMessageSendRequest {
messageContent (string):
UTF-8 encoded message content. May not exceed 10000 characters.
,
recipientAddressList (Array[integer]):
List of recipients (E164 formatted MSISDNs - see Wikipedia
en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The
list of recipients may contain a maximum of 1000 entries.
,
contentCategory (string, optional):
Optional. The content category that is used to categorize the message
(used for blacklisting). The following content categories are supported:
informational or advertisement. If no content category is provided, the
default setting is used (may be changed inside the onlinesms web
interface).
= ['informational', 'advertisement']
stringEnum:"informational", "advertisement"
,
clientMessageId (string, optional):
Optional. May contain a freely definable message id.
,
priority (integer, optional):
Optional. Priority of the message. Must not exceed the value configured
for the account used to send the message. For more information please
contact our customer service.
,
test (boolean, optional):
Optional. true: The transmission is only simulated, no Whatsapp message
is sent. Depending on the number of recipients the status code 2000 or
2001 is returned. false (default): No simulation is done. The Whatsapp
message is sent.
,
attachmentId (integer, optional):
Optional. May contain an attachmentId. Attachments can be created by
using POST /whatsapp/attachment
,
validityPeriode (integer, optional):
Optional. Specifies the validity periode (in seconds) in which the
message is tried to be delivered to the recipient. A minimum of 1 minute
and a maximum of 3 days are allowed.
integerMin. Value:60Max. Value:259200
}
{
"messageContent": "example message content",
"recipientAddressList": "[\"436991234567\"]",
"contentCategory": "informational",
"clientMessageId": "myUniqueId",
"priority": 5,
"test": true,
"attachmentId": 20,
"validityPeriode": 300
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONVERGED/TEXT
* Sends a text message to a list of recipients
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MessageSendResponse {
statusCode (integer, optional):
Status code
,
statusMessage (string, optional):
Description of the response status code.
,
clientMessageId (string, optional):
Contains the message id defined in the request.
,
transferId (string, optional):
Unique identifier that is set after successful processing of the request.
,
smsCount (integer, optional):
The actual number of generated SMS.
}
{
"statusCode": 2000,
"statusMessage": "OK",
"clientMessageId": "myUniqueId",
"transferId": "0059d0b20100a0a8b803",
"smsCount": 1
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TextMessageSendRequest {
recipientAddressList (Array[integer]):
List of recipients (E164 formatted MSISDNs - see Wikipedia
en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The
list of recipients may contain a maximum of 1000 entries.
,
senderAddress (string, optional):
Optional. Address of the sender (assigned to the account) from which the
message is sent.
,
senderAddressType (string, optional):
Optional. The sender address type. The following address types are
supported: national, international, alphanumeric or shortcode).
= ['national', 'international', 'alphanumeric', 'shortcode']
stringEnum:"national", "international", "alphanumeric", "shortcode"
,
contentCategory (string, optional):
Optional. The content category that is used to categorize the message
(used for blacklisting). The following content categories are supported:
informational or advertisement. If no content category is provided, the
default setting is used (may be changed inside the onlinesms web
interface).
= ['informational', 'advertisement']
stringEnum:"informational", "advertisement"
,
notificationCallbackUrl (string, optional):
Optional. When setting a notificationCallbackUrl all delivery reports are
forwarded to this URL.
,
clientMessageId (string, optional):
Optional. May contain a freely definable message id.
,
priority (integer, optional):
Optional. Priority of the message. Must not exceed the value configured
for the account used to send the message. For more information please
contact our customer service.
,
test (boolean, optional):
Optional. true: The transmission is only simulated, no SMS is sent.
Depending on the number of recipients the status code 2000 or 2001 is
returned. false (default): No simulation is done. The SMS is sent via the
SMS Gateway.
,
validityPeriode (integer, optional):
Optional. Specifies the validity periode (in seconds) in which the
message is tried to be delivered to the recipient. A minimum of 1 minute
and a maximum of 3 days are allowed.
integerMin. Value:60Max. Value:259200
,
sendAsFlashSms (boolean, optional):
Optional. true: The message is sent as flash SMS (displayed directly on
the screen of the mobile phone). false (default): The message is sent as
standard text SMS
,
messageContent (string):
UTF-8 encoded message content
,
maxSmsPerMessage (integer, optional):
Optional. Specifies the maximum number of SMS to be generated. If the
system generates more than this number of SMS, the status code 4026 is
returned. The default value of this parameter is 0.If set to 0, no
limitation is applied.
,
messageType (string, optional):
Optional. Specifies the message type. Allowed values are default and
voice. When using the message type default, the outgoing message type is
determined based on account settings. Using the message type voice
triggers a voice call.
= ['default', 'voice']
stringEnum:"default", "voice"
,
pushParameters (object, optional),
additionalPushParameters (object, optional)
}
{
"recipientAddressList": "[\"436991234567\"]",
"senderAddress": "4369912345678",
"senderAddressType": "international",
"contentCategory": "informational",
"notificationCallbackUrl": "https://user:pass@myservice.com/myservice/",
"clientMessageId": "myUniqueId",
"priority": 5,
"test": true,
"validityPeriode": 300,
"sendAsFlashSms": true,
"messageContent": "example message content",
"maxSmsPerMessage": 1,
"messageType": "default",
"pushParameters": {},
"additionalPushParameters": {}
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 2000
OK - Accepted. The request has been accepted by the network operator.
2001
OK - Queued. Request with multiple recipients has been queued for
immediate delivery.
4001
ERR - Invalid Credentials. Inactive account or customer.
4002
ERR - Invalid Recipients. One or more recipients are not in the correct
format or contain invalid msisdns (i.e: 436761234567).
4003
ERR - Invalid Sender. Sender address or type is invalid.
4008
ERR - Invalid clientMessageId.
4009
ERR - Message text (messageContent) is invalid
4013
ERR - Message limit is reached.
4014
ERR - Sender IP address is not authorized.
4015
ERR - Invalid message priority.
4016
ERR - Invalid COD ReturnAddress (notificationCallbackUrl)
4019
ERR - A required parameter was not given. The parameter name is shown in
the statusMessage
4021
ERR - Invalid account.
4022
ERR - Access to the API was denied.
4023
ERR - Request limit exceeded for this IP address
4025
ERR - Recipients amount over limit. A maximum of 50 recipients per
message is allowed in a single request
4026
ERR - MaxSmsPerMessage exceeded. SMS amount limit per message was hit.
4040
ERR - Invalid contentCategory.
4041
ERR - Invalid validityPeriode. A minimum of 60 seconds is allowed
5000
ERR - Internal error. Please contact support.
5003
ERR - The service is currently not available
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /SMSMESSAGING/SIMPLE
* Send text message
IMPLEMENTATION NOTES
Sends a text message to a list of recipients with a simple GET request
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsSendResponse {
statusCode (integer, optional):
Status code
,
statusMessage (string, optional):
Description of the response status code.
,
clientMessageId (string, optional):
Contains the message id defined in the request.
,
transferId (string, optional):
Unique identifier that is set after successful processing of the request.
,
smsCount (integer, optional):
The actual number of generated SMS.
}
{
"statusCode": 2000,
"statusMessage": "OK",
"clientMessageId": "myUniqueId",
"transferId": "0059d0b20100a0a8b803",
"smsCount": 1
}
Response Content Type text/plain
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body string clientMessageId
Optional. May contain a freely definable message id.
query string maxSmsPerMessage
Optional. Specifies the maximum number of SMS to be generated. If the
system generates more than this number of SMS, the status code 4026 is
returned. The default value is 0.If set to 0, no limitation is applied.
query string notificationCallbackUrl
Optional. When setting a notificationCallbackUrl all delivery reports are
forwarded to this URL.
query string priority
Optional. Priority of the message. Must not exceed the value configured
for the account used to send the message. For more information please
contact our customer service.
query string sendAsFlashSms
Optional. true: The message is sent as flash SMS (displayed directly on
the screen of the mobile phone). false (default): The message is sent as
standard text SMS
query string senderAddress
Optional. Address of the sender (assigned to the account) from which the
message is sent.
query string senderAddressType national international alphanumeric
shortcode
Optional. The sender address type. The following address types are
supported: national, international, alphanumeric or shortcode).
query string contentCategory informational advertisement
Optional. The content category that is used to categorize the message
(used for blacklisting). The following content categories are supported:
informational or advertisement. If no content category is provided, the
default setting is used (may be changed inside the onlinesms web
interface).
query string test
Optional. true: The transmission is only simulated, no SMS is sent.
Depending on the number of recipients the status code 2000 or 2001 is
returned. false (default): No simulation is done. The SMS is sent via the
SMS Gateway.
query string recipientAddressList
List of recipients (E164 formatted MSISDNs - see Wikipedia
en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The
list of recipients may contains a mamiumum of 1000 entries.
query Array[string] messageContent
Latin1 URL-encoded message content
query string messageType default voice
Optional. Specifies the message type. Allowed values are default and
voice. When using the message type default, the outgoing message type is
determined based on account settings. Using the message type voice
triggers a voice call.
query string validityPeriode
Optional. Specifies the validity periode (in seconds) in which the
message is tried to be delivered to the recipient. A minimum of 1 minute
and a maximum of 3 days are allowed.
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /SMSMESSAGING/SIMPLE
* Send text message
IMPLEMENTATION NOTES
Sends a text message to a list of recipients with a simple POST request
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsSendResponse {
statusCode (integer, optional):
Status code
,
statusMessage (string, optional):
Description of the response status code.
,
clientMessageId (string, optional):
Contains the message id defined in the request.
,
transferId (string, optional):
Unique identifier that is set after successful processing of the request.
,
smsCount (integer, optional):
The actual number of generated SMS.
}
{
"statusCode": 2000,
"statusMessage": "OK",
"clientMessageId": "myUniqueId",
"transferId": "0059d0b20100a0a8b803",
"smsCount": 1
}
Response Content Type text/plain
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/x-www-form-urlencoded
body string clientMessageId
Optional. May contain a freely definable message id.
formData string maxSmsPerMessage
Optional. Specifies the maximum number of SMS to be generated. If the
system generates more than this number of SMS, the status code 4026 is
returned. The default value is 0.If set to 0, no limitation is applied.
formData string notificationCallbackUrl
Optional. When setting a notificationCallbackUrl all delivery reports are
forwarded to this URL.
formData string priority
Optional. Priority of the message. Must not exceed the value configured
for the account used to send the message. For more information please
contact our customer service.
formData string sendAsFlashSms
Optional. true: The message is sent as flash SMS (displayed directly on
the screen of the mobile phone). false (default): The message is sent as
standard text SMS
formData string senderAddress
Optional. Address of the sender (assigned to the account) from which the
message is sent.
formData string senderAddressType national international alphanumeric
shortcode
Optional. The sender address type. The following address types are
supported: national, international, alphanumeric or shortcode).
formData string contentCategory informational advertisement
Optional. The content category that is used to categorize the message
(used for blacklisting). The following content categories are supported:
informational or advertisement. If no content category is provided, the
default setting is used (may be changed inside the onlinesms web
interface).
formData string test
Optional. true: The transmission is only simulated, no SMS is sent.
Depending on the number of recipients the status code 2000 or 2001 is
returned. false (default): No simulation is done. The SMS is sent via the
SMS Gateway.
formData string recipientAddressList
List of recipients (E164 formatted MSISDNs - see Wikipedia
en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The
list of recipients may contains a mamiumum of 1000 entries.
formData Array[string] messageContent
Latin1 URL-encoded message content
formData string messageType default voice
Optional. Specifies the message type. Allowed values are default and
voice. When using the message type default, the outgoing message type is
determined based on account settings. Using the message type voice
triggers a voice call.
formData string validityPeriode
Optional. Specifies the validity periode (in seconds) in which the
message is tried to be delivered to the recipient. A minimum of 1 minute
and a maximum of 3 days are allowed.
formData integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /SMSMESSAGING/BINARY
* Send binary message
IMPLEMENTATION NOTES
Sends a binary message to a list of recipients
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsSendResponse {
statusCode (integer, optional):
Status code
,
statusMessage (string, optional):
Description of the response status code.
,
clientMessageId (string, optional):
Contains the message id defined in the request.
,
transferId (string, optional):
Unique identifier that is set after successful processing of the request.
,
smsCount (integer, optional):
The actual number of generated SMS.
}
{
"statusCode": 2000,
"statusMessage": "OK",
"clientMessageId": "myUniqueId",
"transferId": "0059d0b20100a0a8b803",
"smsCount": 1
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
BinarySmsSendRequest {
recipientAddressList (Array[integer]):
List of recipients (E164 formatted MSISDNs - see Wikipedia
en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The
list of recipients may contain a maximum of 1000 entries.
,
senderAddress (string, optional):
Optional. Address of the sender (assigned to the account) from which the
message is sent.
,
senderAddressType (string, optional):
Optional. The sender address type. The following address types are
supported: national, international, alphanumeric or shortcode).
= ['national', 'international', 'alphanumeric', 'shortcode']
stringEnum:"national", "international", "alphanumeric", "shortcode"
,
contentCategory (string, optional):
Optional. The content category that is used to categorize the message
(used for blacklisting). The following content categories are supported:
informational or advertisement. If no content category is provided, the
default setting is used (may be changed inside the onlinesms web
interface).
= ['informational', 'advertisement']
stringEnum:"informational", "advertisement"
,
notificationCallbackUrl (string, optional):
Optional. When setting a notificationCallbackUrl all delivery reports are
forwarded to this URL.
,
clientMessageId (string, optional):
Optional. May contain a freely definable message id.
,
priority (integer, optional):
Optional. Priority of the message. Must not exceed the value configured
for the account used to send the message. For more information please
contact our customer service.
,
test (boolean, optional):
Optional. true: The transmission is only simulated, no SMS is sent.
Depending on the number of recipients the status code 2000 or 2001 is
returned. false (default): No simulation is done. The SMS is sent via the
SMS Gateway.
,
validityPeriode (integer, optional):
Optional. Specifies the validity periode (in seconds) in which the
message is tried to be delivered to the recipient. A minimum of 1 minute
and a maximum of 3 days are allowed.
integerMin. Value:60Max. Value:259200
,
sendAsFlashSms (boolean, optional):
Optional. true: The message is sent as flash SMS (displayed directly on
the screen of the mobile phone). false (default): The message is sent as
standard text SMS
,
messageContent (Array[string], optional):
Optional. Array of Base64 encoded binary data. Every element of the array
corresponds to a message segment. The binary data is transmitted without
being changed (using 8 bit alphabet)
,
userDataHeaderPresent (boolean, optional):
Optional. true: Indicates the presence of a user data header in the
messageContent property. false (default): Indicates the absence of a user
data header in the messageContent property.
}
{
"recipientAddressList": "[\"436991234567\"]",
"senderAddress": "4369912345678",
"senderAddressType": "international",
"contentCategory": "informational",
"notificationCallbackUrl": "https://user:pass@myservice.com/myservice/",
"clientMessageId": "myUniqueId",
"priority": 5,
"test": true,
"validityPeriode": 300,
"sendAsFlashSms": true,
"messageContent": "[\"SGVsbG8gV29ybGQ=\"]",
"userDataHeaderPresent": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /SMSMESSAGING/TEXT
* Send text message
IMPLEMENTATION NOTES
Sends a text message to a list of recipients
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsSendResponse {
statusCode (integer, optional):
Status code
,
statusMessage (string, optional):
Description of the response status code.
,
clientMessageId (string, optional):
Contains the message id defined in the request.
,
transferId (string, optional):
Unique identifier that is set after successful processing of the request.
,
smsCount (integer, optional):
The actual number of generated SMS.
}
{
"statusCode": 2000,
"statusMessage": "OK",
"clientMessageId": "myUniqueId",
"transferId": "0059d0b20100a0a8b803",
"smsCount": 1
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TextSmsSendRequest {
recipientAddressList (Array[integer]):
List of recipients (E164 formatted MSISDNs - see Wikipedia
en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The
list of recipients may contain a maximum of 1000 entries.
,
senderAddress (string, optional):
Optional. Address of the sender (assigned to the account) from which the
message is sent.
,
senderAddressType (string, optional):
Optional. The sender address type. The following address types are
supported: national, international, alphanumeric or shortcode).
= ['national', 'international', 'alphanumeric', 'shortcode']
stringEnum:"national", "international", "alphanumeric", "shortcode"
,
contentCategory (string, optional):
Optional. The content category that is used to categorize the message
(used for blacklisting). The following content categories are supported:
informational or advertisement. If no content category is provided, the
default setting is used (may be changed inside the onlinesms web
interface).
= ['informational', 'advertisement']
stringEnum:"informational", "advertisement"
,
notificationCallbackUrl (string, optional):
Optional. When setting a notificationCallbackUrl all delivery reports are
forwarded to this URL.
,
clientMessageId (string, optional):
Optional. May contain a freely definable message id.
,
priority (integer, optional):
Optional. Priority of the message. Must not exceed the value configured
for the account used to send the message. For more information please
contact our customer service.
,
test (boolean, optional):
Optional. true: The transmission is only simulated, no SMS is sent.
Depending on the number of recipients the status code 2000 or 2001 is
returned. false (default): No simulation is done. The SMS is sent via the
SMS Gateway.
,
validityPeriode (integer, optional):
Optional. Specifies the validity periode (in seconds) in which the
message is tried to be delivered to the recipient. A minimum of 1 minute
and a maximum of 3 days are allowed.
integerMin. Value:60Max. Value:259200
,
sendAsFlashSms (boolean, optional):
Optional. true: The message is sent as flash SMS (displayed directly on
the screen of the mobile phone). false (default): The message is sent as
standard text SMS
,
messageContent (string):
UTF-8 encoded message content
,
maxSmsPerMessage (integer, optional):
Optional. Specifies the maximum number of SMS to be generated. If the
system generates more than this number of SMS, the status code 4026 is
returned. The default value of this parameter is 0.If set to 0, no
limitation is applied.
,
messageType (string, optional):
Optional. Specifies the message type. Allowed values are default and
voice. When using the message type default, the outgoing message type is
determined based on account settings. Using the message type voice
triggers a voice call.
= ['default', 'voice']
stringEnum:"default", "voice"
}
{
"recipientAddressList": "[\"436991234567\"]",
"senderAddress": "4369912345678",
"senderAddressType": "international",
"contentCategory": "informational",
"notificationCallbackUrl": "https://user:pass@myservice.com/myservice/",
"clientMessageId": "myUniqueId",
"priority": 5,
"test": true,
"validityPeriode": 300,
"sendAsFlashSms": true,
"messageContent": "example message content",
"maxSmsPerMessage": 1,
"messageType": "default"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* OPTIN : OPTIN API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * POST /V1/OPTIN/SUBSCRIBE
* Confirms OptIn
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ApiOptInRequest {
optInToken (string, optional):
optin token
,
contactGroupIds (Array[integer], optional):
contact group ids
,
secret (string, optional):
secret
,
contact (OptInContactRequest, optional):
contact
}
OptInContactRequest {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string):
mobile phone number
stringReg. Exp.:\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
,
fax (string, optional):
fax number
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
}
{
"optInToken": "string",
"contactGroupIds": [
0
],
"secret": "string",
"contact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "2024-06-20T13:22:50.718Z",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string"
}
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/OPTIN/INITIATE_UNSUBSCRIBE
* Initiates OptOut
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
OptOutRequest {
optInToken (string, optional):
optin token
,
contactGroupIds (Array[integer], optional):
contact group ids
,
secret (string, optional):
secret
,
mobile (string):
mobile phone number
stringReg. Exp.:\+[0-9]{1,15}
}
{
"optInToken": "string",
"contactGroupIds": [
0
],
"secret": "string",
"mobile": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/OPTIN/UNSUBSCRIBE
* Confirms OptOut
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
OptOutRequest {
optInToken (string, optional):
optin token
,
contactGroupIds (Array[integer], optional):
contact group ids
,
secret (string, optional):
secret
,
mobile (string):
mobile phone number
stringReg. Exp.:\+[0-9]{1,15}
}
{
"optInToken": "string",
"contactGroupIds": [
0
],
"secret": "string",
"mobile": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/OPTIN/GENERATE_TOKEN
* generates a token to use OptIn API
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
OptInTokenRequest {
contactGroupIds (Array[integer], optional):
contact group id
}
{
"contactGroupIds": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/OPTIN/TOKEN_INFORMATION
*
PARAMETERS
Parameter Value Description Parameter Type Data Type optInToken
OptInToken
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/OPTIN/INITIATE_SUBSCRIBE
* Initiates OptIn
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ApiOptInRequest {
optInToken (string, optional):
optin token
,
contactGroupIds (Array[integer], optional):
contact group ids
,
secret (string, optional):
secret
,
contact (OptInContactRequest, optional):
contact
}
OptInContactRequest {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string):
mobile phone number
stringReg. Exp.:\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
,
fax (string, optional):
fax number
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
}
{
"optInToken": "string",
"contactGroupIds": [
0
],
"secret": "string",
"contact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "2024-06-20T13:22:50.719Z",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string"
}
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* OUTBOX : WEBSMS.COM OUTBOX API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/OUTBOX/MESSAGES/{ID}/RECIPIENTS
* Returns recipients for the given outbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactResponse
]
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.342Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.342Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/OUTBOX/MESSAGES/{ID}/CONTACT_GROUPS
* Returns contact groups for the given outbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.344Z",
"lastModified": "2024-06-20T13:22:51.344Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.344Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.344Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/OUTBOX/MESSAGES
* Returns outbox messages
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
OutboxMessageResponse
]
OutboxMessageResponse {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message id
,
status (string):
status
,
numberOfRecipients (integer, optional):
number of recipients
,
numberOfContactGroups (integer, optional):
number of contact groups
,
sender (string, optional):
sender identification
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:51.346Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:51.346Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string",
"id": 0,
"status": "string",
"numberOfRecipients": 0,
"numberOfContactGroups": 0,
"sender": "string",
"lastModified": "2024-06-20T13:22:51.346Z",
"lastModifiedBy": "string",
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"origin": "api_http",
"automated": true
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/OUTBOX/MESSAGES
* Add (queues) outbox message
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
OutboxMessageResponse {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message id
,
status (string):
status
,
numberOfRecipients (integer, optional):
number of recipients
,
numberOfContactGroups (integer, optional):
number of contact groups
,
sender (string, optional):
sender identification
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
}
Link {
rel (string, optional),
href (string, optional)
}
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:51.349Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:51.349Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string",
"id": 0,
"status": "string",
"numberOfRecipients": 0,
"numberOfContactGroups": 0,
"sender": "string",
"lastModified": "2024-06-20T13:22:51.349Z",
"lastModifiedBy": "string",
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"origin": "api_http",
"automated": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
OutboxMessageRequest {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
}
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:50.751Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:50.751Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/OUTBOX/MESSAGES/{ID}
* Deletes outbox message
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/OUTBOX/MESSAGES/{ID}
* Returns outbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
OutboxMessageResponse {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message id
,
status (string):
status
,
numberOfRecipients (integer, optional):
number of recipients
,
numberOfContactGroups (integer, optional):
number of contact groups
,
sender (string, optional):
sender identification
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
}
Link {
rel (string, optional),
href (string, optional)
}
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:51.351Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:51.351Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string",
"id": 0,
"status": "string",
"numberOfRecipients": 0,
"numberOfContactGroups": 0,
"sender": "string",
"lastModified": "2024-06-20T13:22:51.351Z",
"lastModifiedBy": "string",
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"origin": "api_http",
"automated": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/OUTBOX/MESSAGES/{ID}
* Updates outbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
OutboxMessageResponse {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message id
,
status (string):
status
,
numberOfRecipients (integer, optional):
number of recipients
,
numberOfContactGroups (integer, optional):
number of contact groups
,
sender (string, optional):
sender identification
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
attachmentMimeType (string, optional):
attachment mime type
,
links (Array[Link], optional):
links
,
origin (string, optional) = ['api_http', 'api_http_simple', 'api_rest',
'api_rest_simple', 'api_rest_converged', 'api_rest_customer_channel',
'api_smpp', 'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp',
'sdk_perl', 'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php',
'api_smtp_email2sms', 'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
automated (boolean, optional):
is generated by an automation like Opt-Ins, PIN verification, etc.
}
Link {
rel (string, optional),
href (string, optional)
}
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:51.352Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:51.352Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string",
"id": 0,
"status": "string",
"numberOfRecipients": 0,
"numberOfContactGroups": 0,
"sender": "string",
"lastModified": "2024-06-20T13:22:51.352Z",
"lastModifiedBy": "string",
"attachmentMimeType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"origin": "api_http",
"automated": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
OutboxMessageRequest {
content (string, optional):
message content
,
subject (string, optional):
subject
,
recipients (Array[string], optional):
recipient list
,
contactGroupIds (Array[integer], optional):
contact group id list
,
selectors (Array[string], optional):
selectors
,
sendOn (string, optional):
send on (now if not specified)
,
timeSpread (integer, optional):
time spread in hours
,
repeat (string, optional):
repeat period (hourly, daily, weekly, monthly, yearly)
,
repeatInterval (integer, optional):
repeat interval
,
repeatIterations (integer, optional):
repeat iterations
,
repeatEndDate (string, optional):
repeat end datetime
,
deliveryReport (boolean, optional):
request delivery report?
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
predictedSmsCount (integer, optional):
predicted SMS count
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
attachmentId (integer, optional):
attachment id
,
urlshorteningType (string, optional):
urlshortening type
}
{
"content": "string",
"subject": "string",
"recipients": [
"string"
],
"contactGroupIds": [
0
],
"selectors": [
"string"
],
"sendOn": "2024-06-20T13:22:50.751Z",
"timeSpread": 0,
"repeat": "string",
"repeatInterval": 0,
"repeatIterations": 0,
"repeatEndDate": "2024-06-20T13:22:50.751Z",
"deliveryReport": true,
"smsType": 0,
"predictedSmsCount": 0,
"contentCategory": "string",
"messageType": "string",
"attachmentId": 0,
"urlshorteningType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/OUTBOX/MESSAGES/DELETE
* Deletes multiple outbox messages
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/OUTBOX/MESSAGES/{ID}/SELECTORS
* Returns selectors for the given outbox message
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactSelectorResponse
]
ContactSelectorResponse {
name (string):
name
,
numberOfContacts (integer, optional):
number of contacts
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"name": "string",
"numberOfContacts": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PAYMENTS : PAYMENT API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * POST /V1/PAYMENTS/CC/AUTHORIZE
* Creates cc payment authorization
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CcPaymentAuthorizationResponse {
provider (string, optional)
stringReg. Exp.:^(saferpay)$
,
frameAncestor (string, optional):
frameAncestor
,
successRedirectUrl (string, optional):
successRedirectUrl
,
failRedirectUrl (string, optional):
failRedirectUrl
,
cancelRedirectUrl (string, optional):
cancelRedirectUrl
,
attempThreeD (boolean, optional):
attempThreeD
,
spaForward (boolean, optional):
spaForward
,
shoppingCart (ShoppingCartRequest, optional):
shopping cart
,
flow (string, optional):
flow
stringReg. Exp.:^(bpwebreg|contract_payment|contract_upgrade)$
,
orderId (string, optional):
orderId
,
siteId (integer, optional):
site id (1 = Austria, 2 = Germany, 3 = Switzerland, 4 = Italy, 5 =
Linkmobility Germany, 6 = Linkmobility SSU Germany, 7 = Linkmobility SSU
Austria, 8 = Linkmobility SSU Switzerland
,
locale (string, optional),
payload (string, optional):
payload
,
firstName (string, optional):
firstName
,
lastName (string, optional):
lastName
,
emailAddress (string, optional):
emailAddress
,
city (string, optional):
city
,
country (string, optional):
country
,
street (string, optional):
street
,
postalCode (string, optional):
postalCode
,
saferpayFieldsToken (string, optional):
saferpayFieldsToken
,
nonce (string, optional):
nonce
,
token (string, optional):
token
,
paymentRedirectUrl (string, optional):
paymentRedirectUrl
,
redirectRequired (boolean, optional):
redirectRequired
}
ShoppingCartRequest {
basePackage (string, optional):
base package
stringReg.
Exp.:^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$
,
addonPackages (Array[string], optional):
addon packages
,
paymentPlan (string, optional)
stringReg. Exp.:^(?i)(yearly|monthly|null)$
}
{
"provider": "string",
"frameAncestor": "string",
"successRedirectUrl": "string",
"failRedirectUrl": "string",
"cancelRedirectUrl": "string",
"attempThreeD": true,
"spaForward": true,
"shoppingCart": {
"basePackage": "string",
"addonPackages": [
"string"
],
"paymentPlan": "string"
},
"flow": "string",
"orderId": "string",
"siteId": 0,
"locale": "string",
"payload": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"city": "string",
"country": "string",
"street": "string",
"postalCode": "string",
"saferpayFieldsToken": "string",
"nonce": "string",
"token": "string",
"paymentRedirectUrl": "string",
"redirectRequired": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CcPaymentAuthorizationRequest {
provider (string, optional)
stringReg. Exp.:^(saferpay)$
,
frameAncestor (string, optional):
frameAncestor
,
successRedirectUrl (string, optional):
successRedirectUrl
,
failRedirectUrl (string, optional):
failRedirectUrl
,
cancelRedirectUrl (string, optional):
cancelRedirectUrl
,
attempThreeD (boolean, optional):
attempThreeD
,
spaForward (boolean, optional):
spaForward
,
shoppingCart (ShoppingCartRequest, optional):
shopping cart
,
flow (string, optional):
flow
stringReg. Exp.:^(bpwebreg|contract_payment|contract_upgrade)$
,
orderId (string, optional):
orderId
,
siteId (integer, optional):
site id (1 = Austria, 2 = Germany, 3 = Switzerland, 4 = Italy, 5 =
Linkmobility Germany, 6 = Linkmobility SSU Germany, 7 = Linkmobility SSU
Austria, 8 = Linkmobility SSU Switzerland
,
locale (string, optional),
payload (string, optional):
payload
,
firstName (string, optional):
firstName
,
lastName (string, optional):
lastName
,
emailAddress (string, optional):
emailAddress
,
city (string, optional):
city
,
country (string, optional):
country
,
street (string, optional):
street
,
postalCode (string, optional):
postalCode
,
saferpayFieldsToken (string, optional):
saferpayFieldsToken
}
ShoppingCartRequest {
basePackage (string, optional):
base package
stringReg.
Exp.:^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$
,
addonPackages (Array[string], optional):
addon packages
,
paymentPlan (string, optional)
stringReg. Exp.:^(?i)(yearly|monthly|null)$
}
{
"provider": "string",
"frameAncestor": "string",
"successRedirectUrl": "string",
"failRedirectUrl": "string",
"cancelRedirectUrl": "string",
"attempThreeD": true,
"spaForward": true,
"shoppingCart": {
"basePackage": "string",
"addonPackages": [
"string"
],
"paymentPlan": "string"
},
"flow": "string",
"orderId": "string",
"siteId": 0,
"locale": "string",
"payload": "string",
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"city": "string",
"country": "string",
"street": "string",
"postalCode": "string",
"saferpayFieldsToken": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PAYMENTS/CC/RETRIEVE
* Retrieves (finished) cc payment authorization
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CcPaymentResponse {
transactionState (string, optional):
transactionState
,
transactionType (string, optional):
transactionType
,
expirationMonth (integer, optional):
expirationMonth
,
expirationYear (integer, optional):
expirationYear
,
cardType (string, optional):
cardType
,
firstName (string, optional):
firstName
,
lastName (string, optional):
lastName
,
maskedAccountNumber (string, optional):
maskedAccountNumber
,
paymentProviderResponse (object, optional):
paymentProviderResponse
,
payload (string, optional):
payload
}
{
"transactionState": "string",
"transactionType": "string",
"expirationMonth": 0,
"expirationYear": 0,
"cardType": "string",
"firstName": "string",
"lastName": "string",
"maskedAccountNumber": "string",
"paymentProviderResponse": {},
"payload": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CcPaymentRetrieveRequest {
token (string, optional),
nonce (string, optional)
}
{
"token": "string",
"nonce": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PAYMENTS/CC/SAFERPAY/REDIRECT
* Redirects saferpay GET to redirect URLs
PARAMETERS
Parameter Value Description Parameter Type Data Type redirectToken query
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
successful operation
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PAYMENTS/CC/SAFERPAY/NOTIFICATIONS
* Handles saferpay payment notifications
PARAMETERS
Parameter Value Description Parameter Type Data Type redirectToken query
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
successful operation
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PHONE_BOOK : WEBSMS.COM PHONE BOOK API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/PHONE_BOOK/CONTACTS/EXPORT/TASKS/{ID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/CONTACTS/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/PHONE_BOOK/CONTACTS/EXPORT/TASKS/{ID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/EXPORT/TASKS/{ID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/COUNT
* Counts contacts
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Count {
count (integer):
count
}
{
"count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/PHONE_BOOK/CONTACTS
* Deletes all contacts
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS
* Returns contacts
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactResponse
]
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.370Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.370Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/CONTACTS
* Adds contact
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.372Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.372Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ContactRequest {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/PHONE_BOOK/CONTACTS/{ID}
* Deletes contact
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/{ID}
* Returns contact
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.375Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.375Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/PHONE_BOOK/CONTACTS/{ID}
* Updates contact
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.376Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.376Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ContactRequest {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/CONTACTS/DELETE
* Deletes multiple contacts
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/IMPORT/FIELDS
* Returns list of supported import fields
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
FieldMetaDataResponse
]
FieldMetaDataResponse {
name (string):
name
,
type (string):
data type
,
required (boolean):
required
,
maxLength (integer):
maximum length
,
isDuplicateCheckSupported (boolean):
whether duplicate check is supported for this field
}
[
{
"name": "string",
"type": "string",
"required": true,
"maxLength": 0,
"isDuplicateCheckSupported": true
}
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/CONTACTS/IMPORT/FILES
* Uploads import file
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CsvFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
delimiter (string, optional):
delimiter
,
charset (string, optional):
charset
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"delimiter": "string",
"charset": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type file
formData undefined
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/PHONE_BOOK/CONTACTS/IMPORT/FILES/{ID}
* Deletes import file
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/IMPORT/FILES/{ID}
* Returns import file information
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CsvFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
delimiter (string, optional):
delimiter
,
charset (string, optional):
charset
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"delimiter": "string",
"charset": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/IMPORT/FILES/{ID}/ROWS
* Returns import file rows
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
Row
]
Row {
row (integer):
row
,
columns (Array[Column], optional)
}
Column {
column (integer):
column
,
value (string):
value
}
[
{
"row": 0,
"columns": [
{
"column": 0,
"value": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/IMPORT/FILES/{ID}/FIELD_MAPPING
* Tries to detect field mapping
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/IMPORT/TASKS
* Returns import tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ImportContactsResponse
]
ImportContactsResponse {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
,
id (integer):
id
,
processed (integer, optional):
total of processed contacts
,
added (integer, optional):
newly added contacts
,
updated (integer, optional):
updated contacts
,
updatedCsv (integer, optional):
updated csv contacts
,
ignored (integer, optional):
ignored contacts
,
failed (integer, optional):
failed contacts
,
blacklisted (integer, optional):
blacklisted recipients
,
empty (integer, optional):
empty contacts
,
nonEnabledWhatsapp (integer, optional):
non enabled whatsapp recipients
,
state (AsyncState, optional):
invalid records
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string",
"id": 0,
"processed": 0,
"added": 0,
"updated": 0,
"updatedCsv": 0,
"ignored": 0,
"failed": 0,
"blacklisted": 0,
"empty": 0,
"nonEnabledWhatsapp": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/CONTACTS/IMPORT/TASKS
* Creates and executes import task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ImportContactsResponse {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
,
id (integer):
id
,
processed (integer, optional):
total of processed contacts
,
added (integer, optional):
newly added contacts
,
updated (integer, optional):
updated contacts
,
updatedCsv (integer, optional):
updated csv contacts
,
ignored (integer, optional):
ignored contacts
,
failed (integer, optional):
failed contacts
,
blacklisted (integer, optional):
blacklisted recipients
,
empty (integer, optional):
empty contacts
,
nonEnabledWhatsapp (integer, optional):
non enabled whatsapp recipients
,
state (AsyncState, optional):
invalid records
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string",
"id": 0,
"processed": 0,
"added": 0,
"updated": 0,
"updatedCsv": 0,
"ignored": 0,
"failed": 0,
"blacklisted": 0,
"empty": 0,
"nonEnabledWhatsapp": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ImportContactRequestDto {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
}
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string"
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/EXPORT
* Exports contacts
PARAMETERS
Parameter Value Description Parameter Type Data Type format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/{ID}/CONTACT_GROUPS
* Returns contact groups for contact
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.389Z",
"lastModified": "2024-06-20T13:22:51.389Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.389Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.389Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/PHONE_BOOK/CONTACTS/IMPORT/TASKS/{ID}
* Deletes/cancels import task
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/IMPORT/TASKS/{ID}
* Returns import task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ImportContactsResponse {
importFileId (integer, optional):
import file id
,
fieldMapping (object, optional):
fields to import file column mapping
,
contactGroupIds (Array[integer], optional):
contact groups to assign
,
charset (string, optional):
override detected charset
,
delimiter (string, optional):
override detected delimiter
,
skipFirstRow (boolean, optional):
skip first row
,
continueOnError (boolean, optional):
continue on error
,
ignoreExistingContacts (boolean, optional):
don't touch existing contacts
,
ignoreEmptyContacts (boolean, optional):
don't import empty contacts (containing no recipients
,
mergeContactGroupIds (boolean, optional):
whether to merge or delete existing group membership
,
dryRun (boolean, optional):
dry run
,
duplicateCheckField (string, optional):
whether to check for mobile or whatsapp duplicates
stringReg. Exp.:^$|^(?i)(mobile|whatsapp)$
,
id (integer):
id
,
processed (integer, optional):
total of processed contacts
,
added (integer, optional):
newly added contacts
,
updated (integer, optional):
updated contacts
,
updatedCsv (integer, optional):
updated csv contacts
,
ignored (integer, optional):
ignored contacts
,
failed (integer, optional):
failed contacts
,
blacklisted (integer, optional):
blacklisted recipients
,
empty (integer, optional):
empty contacts
,
nonEnabledWhatsapp (integer, optional):
non enabled whatsapp recipients
,
state (AsyncState, optional):
invalid records
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"importFileId": 0,
"fieldMapping": {},
"contactGroupIds": [
0
],
"charset": "string",
"delimiter": "string",
"skipFirstRow": true,
"continueOnError": true,
"ignoreExistingContacts": true,
"ignoreEmptyContacts": true,
"mergeContactGroupIds": true,
"dryRun": true,
"duplicateCheckField": "string",
"id": 0,
"processed": 0,
"added": 0,
"updated": 0,
"updatedCsv": 0,
"ignored": 0,
"failed": 0,
"blacklisted": 0,
"empty": 0,
"nonEnabledWhatsapp": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACTS/IMPORT/TASKS/{ID}/INVALID_RECORDS
* Returns invalid records from import task.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
InvalidRecord
]
InvalidRecord {
type (string, optional):
type
,
row (integer, optional):
row index
,
column (integer, optional):
column index
,
field (string, optional):
field name
,
value (string, optional):
invalid value
,
description (string, optional):
error description
}
[
{
"type": "string",
"row": 0,
"column": 0,
"field": "string",
"value": "string",
"description": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/PHONE_BOOK/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT/TASKS
* Creates and executes export task
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACT_GROUPS
* Returns contact groups
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.402Z",
"lastModified": "2024-06-20T13:22:51.402Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.402Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.402Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/CONTACT_GROUPS
* Adds contact group
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.405Z",
"lastModified": "2024-06-20T13:22:51.405Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.405Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.405Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ContactGroupRequest {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACT_GROUPS/PRESET
* Returns contact group preset
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.408Z",
"lastModified": "2024-06-20T13:22:51.408Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.408Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.408Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}
* Deletes contact group
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}
* Returns contact group
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.411Z",
"lastModified": "2024-06-20T13:22:51.411Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.411Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.411Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}
* Updates contact group
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.415Z",
"lastModified": "2024-06-20T13:22:51.415Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.415Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.415Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
ContactGroupRequest {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
}
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}/CONTACTS
* Returns contacts for contact group
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactResponse
]
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.419Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.419Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/CONTACT_GROUPS/DELETE
* Deletes multiple contact groups
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}/CLEAR
* Clears contact group
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}/PURGE
* Deletes all contacts in group
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
PurgeContactGroupRequest {
exclusiveOnly (boolean, optional):
delete only contacts exclusive in this group
}
{
"exclusiveOnly": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/CONTACT_GROUPS/{ID}/CONTACTS/EXPORT
* Exports contacts for contact group
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
format
Export format (pdf, csv, xsl)
query string query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/MEMBERSHIPS
* Returns contact group memberships
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupMembershipResponse
]
ContactGroupMembershipResponse {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group mebership id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true,
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/MEMBERSHIPS
* Adds contact group membership
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
ContactGroupMembershipResponse {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group mebership id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true,
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ContactGroupMembershipRequest {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
}
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/MEMBERSHIPS/COPY
* Copies contact group members from one or more contact groups to
another
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CopyContactGroupMembershipsRequest {
sourceIds (Array[integer], optional):
source contact group ids
,
targetId (integer, optional):
target contact group id
}
{
"sourceIds": [
0
],
"targetId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/PHONE_BOOK/MEMBERSHIPS/{ID}
* Deletes contact group membership
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PHONE_BOOK/MEMBERSHIPS/{ID}
* Returns contact group membership
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactGroupMembershipResponse {
contactGroupId (integer):
contact group id
,
contactId (integer):
contact id
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group mebership id
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contactGroupId": 0,
"contactId": 0,
"mobile": true,
"whatsapp": true,
"id": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/MEMBERSHIPS/{ID}/PURGE
* Deletes contact in membership
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
PurgeContactGroupMembershipRequest {
exclusiveOnly (boolean, optional):
delete only contacts exclusive in this group
}
{
"exclusiveOnly": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/MEMBERSHIPS/ADD
* Adds contacts to one or more contact groups
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
AddContactGroupMembershipsRequest {
contactIds (Array[integer], optional):
source contact ids
,
contactGroupIds (Array[integer], optional):
target contact group id
,
deleteExisting (boolean, optional):
whether to delete exiting memberships for the contacts
}
{
"contactIds": [
0
],
"contactGroupIds": [
0
],
"deleteExisting": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PHONE_BOOK/MEMBERSHIPS/DELETE
* Deletes multiple contact group memberships
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PUBLICAPPLETS : PUBLIC APPLET API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/PUBLICAPPLETS/{HASHID}
* Returns applet configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PublicAppletResponse {
name (string, optional):
name
,
type (string, optional):
type
,
locale (string, optional):
locale
,
cssUrl (string, optional):
css url
,
cssContent (string, optional):
css content
,
cssTheme (string, optional):
css theme
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"type": "string",
"locale": "string",
"cssUrl": "string",
"cssContent": "string",
"cssTheme": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PUBLICAPPLETS/BUILD_VCARD
* Builds and returns vcard
PARAMETERS
Parameter Value Description Parameter Type Data Type companyName query
string msisdn query string fileName query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PUBLICAPPLETS/{HASHID}/OPTIN/REQUEST_IDENTITY_TOKEN
* Requests opt in identity token
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RequestIdentityTokenResponseDto {
identityType (string, optional):
identity type
stringReg. Exp.:^(?i)(msisdn)$
,
value (string, optional):
value (e.g. msisdn)
stringReg. Exp.:\+?[0-9]{1,15}
,
identityToken (string, optional):
identity token
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"identityType": "string",
"value": "string",
"identityToken": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
body
Parameter content type: application/json
body
* Model
* Model Schema
RequestIdentityTokenRequestDto {
identityType (string, optional):
identity type
stringReg. Exp.:^(?i)(msisdn)$
,
value (string, optional):
value (e.g. msisdn)
stringReg. Exp.:\+?[0-9]{1,15}
}
{
"identityType": "string",
"value": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PUBLICAPPLETS/{HASHID}/OPTIN/CONFIRM_IDENTITY_TOKEN
* Confirms opt in identity
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ConfirmIdentityTokenResponseDto {
identityToken (string, optional):
identity token
,
secret (string, optional):
secret
}
{
"identityToken": "string",
"secret": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
body
Parameter content type: application/json
body
* Model
* Model Schema
ConfirmIdentityTokenRequestDto {
identityToken (string, optional):
identity token
,
secret (string, optional):
secret
}
{
"identityToken": "string",
"secret": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PUBLICAPPLETS/{HASHID}/OPTIN/INITIATE_SUBSCRIBE
* Initiates OptIn
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
InitiateOptInResponseDto {
contactGroupIds (Array[integer], optional):
contact group ids
,
contact (InitiateOptInContactRequest, optional):
contact
,
optinChannels (Array[string], optional):
channels
,
termsAndConditions (string, optional):
terms and conditions
,
acceptTermsAndConditions (boolean, optional):
accept terms and conditions?
,
optInId (string, optional):
optInId
,
links (Array[Link], optional):
links
}
InitiateOptInContactRequest {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string):
mobile phone number
stringReg. Exp.:^|\+?[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+?[0-9]{1,15}
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contactGroupIds": [
0
],
"contact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "2024-06-20T13:22:51.443Z",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"whatsapp": "string"
},
"optinChannels": [
"string"
],
"termsAndConditions": "string",
"acceptTermsAndConditions": true,
"optInId": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
body
Parameter content type: application/json
body
* Model
* Model Schema
InitiateOptInRequestDto {
contactGroupIds (Array[integer], optional):
contact group ids
,
contact (InitiateOptInContactRequest, optional):
contact
,
optinChannels (Array[string], optional):
channels
,
termsAndConditions (string, optional):
terms and conditions
,
acceptTermsAndConditions (boolean, optional):
accept terms and conditions?
}
InitiateOptInContactRequest {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string):
mobile phone number
stringReg. Exp.:^|\+?[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+?[0-9]{1,15}
}
{
"contactGroupIds": [
0
],
"contact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "2024-06-20T13:22:50.726Z",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"whatsapp": "string"
},
"optinChannels": [
"string"
],
"termsAndConditions": "string",
"acceptTermsAndConditions": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PUBLICAPPLETS/{HASHID}/OPTIN/CONFIGURATION
* Returns applet optin configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PublicAppletOptInConfigurationResponseDto {
defaultDiallingCode (integer, optional):
default dialling code
,
whatsappAvailable (boolean, optional):
whatsapp available
,
smsAvailable (boolean, optional):
sms available
,
whatsappMsisdn (string, optional):
whatsapp msisdn
,
companyName (string, optional):
company name
,
components (PublicAppletOptInConfigurationComponentsResponseDto,
optional):
components
,
messages (PublicAppletOptInConfigurationMessagesResponseDto, optional):
messages
,
kioskMode (boolean, optional):
kiosk mode
}
PublicAppletOptInConfigurationComponentsResponseDto {
title (PublicAppletOptInConfigurationComponentFieldResponseDto,
optional):
title
,
intro (PublicAppletOptInConfigurationComponentTextareaResponseDto,
optional):
intro
,
contactGroups
(PublicAppletOptInConfigurationComponentContactGroupsResponseDto,
optional):
contact groups
,
firstName
(PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
first name
,
lastName (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
last name
,
emailAddress
(PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
email address
,
contactTitle
(PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
title
,
nickname (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
nickname
,
landline (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
landline phone number
,
fax (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
fax
,
birthday (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
birthday
,
homepage (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
homepage
,
instantMessenger
(PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
instant messenger user
,
skype (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
skype
,
remarks (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
custom remarks
,
street (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
street
,
zipCode (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
zip code
,
city (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
city
,
country (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
country
,
company (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
company name
,
department
(PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
department
,
bureau (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
bureau
,
position (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
position
,
jobTitle (PublicAppletOptInConfigurationComponentContactFieldResponseDto,
optional):
job title
,
msisdn (PublicAppletOptInConfigurationComponentMsisdnResponseDto,
optional):
msisdn
,
logo (PublicAppletOptInConfigurationComponentAttachmentResponseDto,
optional):
logo
,
appletTitle (PublicAppletOptInConfigurationComponentFieldResponseDto,
optional):
applet title
,
companyName (PublicAppletOptInConfigurationComponentFieldResponseDto,
optional):
company name
,
labelChannelSelection
(PublicAppletOptInConfigurationComponentFieldResponseDto, optional):
label channel selection
,
labelContactGroupSelection
(PublicAppletOptInConfigurationComponentFieldResponseDto, optional):
label contact group selection
,
labelWhatsappMsisdn
(PublicAppletOptInConfigurationComponentFieldResponseDto, optional):
label whatsapp msisdn
,
titleMsisdnVerificationSuccessful
(PublicAppletOptInConfigurationComponentFieldResponseDto, optional):
title msisdn verification successful
,
descriptionMsisdnVerificationSuccessful
(PublicAppletOptInConfigurationComponentTextareaResponseDto, optional):
description msisdn verification successful
,
termsAndConditions
(PublicAppletOptInConfigurationComponentTermsAndConditionsResponseDto,
optional):
terms and conditions
}
PublicAppletOptInConfigurationMessagesResponseDto {
isBlacklisted (PublicAppletOptInConfigurationMessageResponseDto,
optional):
is blacklisted
}
PublicAppletOptInConfigurationComponentFieldResponseDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
PublicAppletOptInConfigurationComponentTextareaResponseDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
PublicAppletOptInConfigurationComponentContactGroupsResponseDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
minimalContactGroups (Array[MinimalContactGroupResponse], optional):
contact groups
}
PublicAppletOptInConfigurationComponentContactFieldResponseDto {
content (string, optional):
content
,
required (boolean, optional):
required
,
position (integer, optional):
position
}
PublicAppletOptInConfigurationComponentMsisdnResponseDto {
content (string, optional):
content
,
position (integer, optional):
position
,
optinChannels (Array[string], optional):
opt in channels
}
PublicAppletOptInConfigurationComponentAttachmentResponseDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
url (string, optional):
attachment url
,
attachmentMimeType (string, optional):
attachment mime type
}
PublicAppletOptInConfigurationComponentTermsAndConditionsResponseDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
,
required (boolean, optional):
required
}
PublicAppletOptInConfigurationMessageResponseDto {
content (string, optional):
content
}
MinimalContactGroupResponse {
id (integer):
contact group id
,
name (string):
group name
}
{
"defaultDiallingCode": 0,
"whatsappAvailable": true,
"smsAvailable": true,
"whatsappMsisdn": "string",
"companyName": "string",
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"contactGroups": {
"visible": true,
"position": 0,
"minimalContactGroups": [
{
"id": 0,
"name": "string"
}
]
},
"firstName": {
"content": "string",
"required": true,
"position": 0
},
"lastName": {
"content": "string",
"required": true,
"position": 0
},
"emailAddress": {
"content": "string",
"required": true,
"position": 0
},
"contactTitle": {
"content": "string",
"required": true,
"position": 0
},
"nickname": {
"content": "string",
"required": true,
"position": 0
},
"landline": {
"content": "string",
"required": true,
"position": 0
},
"fax": {
"content": "string",
"required": true,
"position": 0
},
"birthday": {
"content": "string",
"required": true,
"position": 0
},
"homepage": {
"content": "string",
"required": true,
"position": 0
},
"instantMessenger": {
"content": "string",
"required": true,
"position": 0
},
"skype": {
"content": "string",
"required": true,
"position": 0
},
"remarks": {
"content": "string",
"required": true,
"position": 0
},
"street": {
"content": "string",
"required": true,
"position": 0
},
"zipCode": {
"content": "string",
"required": true,
"position": 0
},
"city": {
"content": "string",
"required": true,
"position": 0
},
"country": {
"content": "string",
"required": true,
"position": 0
},
"company": {
"content": "string",
"required": true,
"position": 0
},
"department": {
"content": "string",
"required": true,
"position": 0
},
"bureau": {
"content": "string",
"required": true,
"position": 0
},
"position": {
"content": "string",
"required": true,
"position": 0
},
"jobTitle": {
"content": "string",
"required": true,
"position": 0
},
"msisdn": {
"content": "string",
"position": 0,
"optinChannels": [
"string"
]
},
"logo": {
"visible": true,
"position": 0,
"url": "string",
"attachmentMimeType": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
},
"labelChannelSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"labelContactGroupSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"labelWhatsappMsisdn": {
"visible": true,
"position": 0,
"content": "string"
},
"titleMsisdnVerificationSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"descriptionMsisdnVerificationSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"termsAndConditions": {
"visible": true,
"position": 0,
"content": "string",
"required": true
}
},
"messages": {
"isBlacklisted": {
"content": "string"
}
},
"kioskMode": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PUBLICAPPLETS/{HASHID}/OPTIN/{OPTINID}/CHANGE_OPTIN_MOBILE
* Changes OptIn msisdn
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
optInId path string body
Parameter content type: application/json
body
* Model
* Model Schema
UpdateSmsOptInRequestDto {
mobile (string):
mobile phone number
stringReg. Exp.:^|\+?[0-9]{1,15}
}
{
"mobile": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PUBLICAPPLETS/{HASHID}/OPTIN/{OPTINID}/CHANGE_OPTIN_WHATSAPP
* Changes OptIn whatsapp
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
optInId path string body
Parameter content type: application/json
body
* Model
* Model Schema
UpdateWhatsappOptInRequestDto {
whatsapp (string):
whatsapp number
stringReg. Exp.:^|\+?[0-9]{1,15}
}
{
"whatsapp": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PUBLICAPPLETS/{HASHID}/OPTIN/{OPTINID}/SUBSCRIBE_SMS
* Confirms SMS OptIn
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ConfirmOptInResponseDto {
optionalStatusCode (integer, optional)
}
{
"optionalStatusCode": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
optInId path string identitytoken query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PUBLICAPPLETS/{HASHID}/OPTOUT/REQUEST_IDENTITY_TOKEN
* Requests opt out identity token
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RequestIdentityTokenResponseDto {
identityType (string, optional):
identity type
stringReg. Exp.:^(?i)(msisdn)$
,
value (string, optional):
value (e.g. msisdn)
stringReg. Exp.:\+?[0-9]{1,15}
,
identityToken (string, optional):
identity token
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"identityType": "string",
"value": "string",
"identityToken": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
body
Parameter content type: application/json
body
* Model
* Model Schema
RequestIdentityTokenRequestDto {
identityType (string, optional):
identity type
stringReg. Exp.:^(?i)(msisdn)$
,
value (string, optional):
value (e.g. msisdn)
stringReg. Exp.:\+?[0-9]{1,15}
}
{
"identityType": "string",
"value": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PUBLICAPPLETS/{HASHID}/OPTOUT/CONFIRM_IDENTITY_TOKEN
* Confirms identity
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ConfirmIdentityTokenResponseDto {
identityToken (string, optional):
identity token
,
secret (string, optional):
secret
}
{
"identityToken": "string",
"secret": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
body
Parameter content type: application/json
body
* Model
* Model Schema
ConfirmIdentityTokenRequestDto {
identityToken (string, optional):
identity token
,
secret (string, optional):
secret
}
{
"identityToken": "string",
"secret": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/PUBLICAPPLETS/{HASHID}/OPTOUT/UNSUBSCRIBE
* Unsubscribes from given contact groups
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ConfirmOptOutResponseDto {
contactGroupIds (Array[integer], optional):
contact group ids
}
{
"contactGroupIds": [
0
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
body
Parameter content type: application/json
body
* Model
* Model Schema
ConfirmOptOutRequestDto {
contactGroupIds (Array[integer], optional):
contact group ids
}
{
"contactGroupIds": [
0
]
}
Click to set as parameter value
identitytoken query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PUBLICAPPLETS/{HASHID}/OPTOUT/CONTACT_GROUPS
* Returns available contact groups for opt out for given identity
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MinimalContactGroupResponse {
id (integer):
contact group id
,
name (string):
group name
}
{
"id": 0,
"name": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
identitytoken query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PUBLICAPPLETS/{HASHID}/OPTOUT/CONFIGURATION
* Returns applet optin configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PublicAppletOptOutConfigurationResponseDto {
defaultDiallingCode (integer, optional):
default dialling code
,
components (PublicAppletOptOutConfigurationComponentsResponseDto,
optional):
components
,
kioskMode (boolean, optional):
kiosk mode
,
blacklistingActive (boolean, optional):
blacklisting active?
}
PublicAppletOptOutConfigurationComponentsResponseDto {
title (PublicAppletOptOutConfigurationComponentFieldResponseDto,
optional):
title
,
intro (PublicAppletOptOutConfigurationComponentTextareaResponseDto,
optional):
intro
,
msisdn (PublicAppletOptOutConfigurationComponentMsisdnResponseDto,
optional):
msisdn
,
logo (PublicAppletOptOutConfigurationComponentAttachmentResponseDto,
optional):
logo
,
appletTitle (PublicAppletOptOutConfigurationComponentFieldResponseDto,
optional):
applet title
,
labelContactGroupSelection
(PublicAppletOptOutConfigurationComponentFieldResponseDto, optional):
label contact group selection
,
titleOptOutSuccessful
(PublicAppletOptOutConfigurationComponentFieldResponseDto, optional):
title opt out successful
,
descriptionOptOutSuccessful
(PublicAppletOptOutConfigurationComponentTextareaResponseDto, optional):
description opt out successful
,
companyName (PublicAppletOptOutConfigurationComponentFieldResponseDto,
optional):
company name
}
PublicAppletOptOutConfigurationComponentFieldResponseDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
PublicAppletOptOutConfigurationComponentTextareaResponseDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
PublicAppletOptOutConfigurationComponentMsisdnResponseDto {
content (string, optional):
content
,
position (integer, optional):
position
}
PublicAppletOptOutConfigurationComponentAttachmentResponseDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
url (string, optional):
attachment url
,
attachmentMimeType (string, optional):
attachment mime type
}
{
"defaultDiallingCode": 0,
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"msisdn": {
"content": "string",
"position": 0
},
"logo": {
"visible": true,
"position": 0,
"url": "string",
"attachmentMimeType": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
},
"labelContactGroupSelection": {
"visible": true,
"position": 0,
"content": "string"
},
"titleOptOutSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"descriptionOptOutSuccessful": {
"visible": true,
"position": 0,
"content": "string"
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
}
},
"kioskMode": true,
"blacklistingActive": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/PUBLICAPPLETS/{HASHID}/WAT_DEVICE_SUBSCRIPTION/CONFIGURATION
* Returns wat_device_subscription configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PublicAppletWatDeviceSubscriptionConfigurationResponseDto {
components
(PublicAppletWatDeviceSubscriptionConfigurationComponentsRequestDto,
optional):
components
,
messages
(PublicAppletWatDeviceSubscriptionConfigurationMessagesRequestDto,
optional):
messages
,
mode (string, optional):
mode
,
whatsappAvailable (boolean, optional):
whatsapp available?
,
whatsappMsisdn (string, optional):
whatsapp msisdn
}
PublicAppletWatDeviceSubscriptionConfigurationComponentsRequestDto {
title
(PublicAppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
title
,
intro
(PublicAppletWatDeviceSubscriptionConfigurationComponentTextareaRequestDto,
optional):
intro
,
logo
(PublicAppletWatDeviceSubscriptionConfigurationComponentAttachmentRequestDto,
optional):
logo
,
termsAndConditions
(PublicAppletWatDeviceSubscriptionConfigurationComponentTermsAndConditionsRequestDto,
optional):
terms and conditions
,
companyName
(PublicAppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
company name
,
appletTitle
(PublicAppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto,
optional):
applet title
}
PublicAppletWatDeviceSubscriptionConfigurationMessagesRequestDto {
prefilledWhatsappMessage
(PublicAppletWatDeviceSubscriptionConfigurationMessageRequestDto,
optional):
prefilled whatsapp message
}
PublicAppletWatDeviceSubscriptionConfigurationComponentFieldRequestDto {
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
PublicAppletWatDeviceSubscriptionConfigurationComponentTextareaRequestDto
{
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
}
PublicAppletWatDeviceSubscriptionConfigurationComponentAttachmentRequestDto
{
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
url (string, optional):
attachment url
,
attachmentMimeType (string, optional):
attachment mime type
}
PublicAppletWatDeviceSubscriptionConfigurationComponentTermsAndConditionsRequestDto
{
visible (boolean, optional):
visible
,
position (integer, optional):
position
,
content (string, optional):
content
,
required (boolean, optional):
required
}
PublicAppletWatDeviceSubscriptionConfigurationMessageRequestDto {
content (string, optional):
content
}
{
"components": {
"title": {
"visible": true,
"position": 0,
"content": "string"
},
"intro": {
"visible": true,
"position": 0,
"content": "string"
},
"logo": {
"visible": true,
"position": 0,
"url": "string",
"attachmentMimeType": "string"
},
"termsAndConditions": {
"visible": true,
"position": 0,
"content": "string",
"required": true
},
"companyName": {
"visible": true,
"position": 0,
"content": "string"
},
"appletTitle": {
"visible": true,
"position": 0,
"content": "string"
}
},
"messages": {
"prefilledWhatsappMessage": {
"content": "string"
}
},
"mode": "string",
"whatsappAvailable": true,
"whatsappMsisdn": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type hashId path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TEMPLATES : WEBSMS.COM MESSAGE TEMPLATES API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/TEMPLATES
* Returns message templates
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageTemplateResponse
]
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.458Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TEMPLATES
* Adds message template
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.460Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MessageTemplateRequest {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
}
{
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/TEMPLATES/{ID}
* Deletes message template
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TEMPLATES/{ID}
* Returns message template
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.461Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TEMPLATES/{ID}
* Updates message template
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.462Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MessageTemplateRequest {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
}
{
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TEMPLATES/DELETE
* Deletes multiple message templates
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DeleteRequest {
ids (Array[integer]):
ids
}
{
"ids": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TRIGGERS : TRIGGER API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/TRIGGERS/MESSENGER
* Returns all (customer specific) messenger triggers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.465Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.469Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/CUSTOMER_CHANNEL
* Returns all (customer channel specific) triggers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.470Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.470Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/MOSMS/SEQUENCE_ORDER
* Returns sequence orders of mosms triggers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoSmsTriggerSequenceOrderResponse {
accountMsisdn (string, optional):
fields to import file column mapping
,
order (Array[integer]):
sequence order of mosms trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountMsisdn": "string",
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/SEQUENCE_ORDER
* Adds sequence order for mosms trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoSmsTriggerSequenceOrderResponse {
accountMsisdn (string, optional):
fields to import file column mapping
,
order (Array[integer]):
sequence order of mosms trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountMsisdn": "string",
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MoSmsTriggerSequenceOrderRequest {
accountMsisdn (string, optional):
fields to import file column mapping
,
order (Array[integer]):
sequence order of mosms trigger
}
{
"accountMsisdn": "string",
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/MOSMS/SEQUENCE_ORDER/{ID}
* Returns sequence order of mosms trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoSmsTriggerSequenceOrderResponse {
accountMsisdn (string, optional):
fields to import file column mapping
,
order (Array[integer]):
sequence order of mosms trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountMsisdn": "string",
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/MOSMS/SEQUENCE_ORDER/{ID}
* Updates sequence order of mosms trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoSmsTriggerSequenceOrderResponse {
accountMsisdn (string, optional):
fields to import file column mapping
,
order (Array[integer]):
sequence order of mosms trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountMsisdn": "string",
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MoSmsTriggerSequenceOrderRequest {
accountMsisdn (string, optional):
fields to import file column mapping
,
order (Array[integer]):
sequence order of mosms trigger
}
{
"accountMsisdn": "string",
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/HTTP_FORWARD
* Adds mosms trigger with http forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.476Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.477Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/TRIGGERS/{ID}/MOSMS
* Deletes mosms trigger
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS
* Returns mosms trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.479Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.479Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOSMS
* Updates mosms trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.480Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.480Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/CONFIGURATION
* Returns mosms trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoSmsTriggerConfigurationResponse {
accountMsisdn (string, optional):
accountMsisdn
,
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountMsisdn": "string",
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:51.482Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:51.482Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOSMS/CONFIGURATION
* Updates mosms trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoSmsTriggerConfigurationResponse {
accountMsisdn (string, optional):
accountMsisdn
,
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountMsisdn": "string",
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:51.483Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:51.483Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MoSmsTriggerConfigurationRequest {
accountMsisdn (string, optional):
accountMsisdn
,
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
}
{
"accountMsisdn": "string",
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:50.729Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:50.729Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/HTTP_FORWARD/CONFIGURATION
* Returns mosms trigger forward action configuration http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOSMS/HTTP_FORWARD/CONFIGURATION
* Updates mosms trigger forward action configuration http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
HttpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
}
{
"format": "string",
"target": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/SMTP_FORWARD
* Adds mosms trigger with smtp forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.487Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.487Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/SMTP_FORWARD/CONFIGURATION
* Returns mosms trigger forward action configuration smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmtpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOSMS/SMTP_FORWARD/CONFIGURATION
* Updates mosms trigger forward action configuration smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmtpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmtpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/SMTP_FORWARD/CONFIGURATION/CONTACT_GROUPS
* Returns configured contact groups for mosms trigger forward action
configuration smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.492Z",
"lastModified": "2024-06-20T13:22:51.492Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.492Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.492Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/SMTP_FORWARD/CONFIGURATION/CONTACTS
* Returns configured contacts for mosms trigger forward action
configuration smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.494Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.494Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/INBOX_FORWARD
* Adds mosms trigger with iunbox forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.496Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.496Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/AMAZON_SQS_FORWARD
* Adds mosms trigger with amazon sqs forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.498Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.498Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/SMPP_FORWARD
* Adds mosms trigger with smpp forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.500Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.500Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/SMSBOX_FORWARD
* Adds mosms trigger with smsbox forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.501Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.501Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/SMS_ANSWER
* Adds mosms trigger with sms_answer action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.502Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.502Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/SMS_FORWARD
* Adds mosms trigger with sms_forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.503Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.503Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/SMS_AUTO_RESPONSE
* Adds mosms trigger with sms_auto_response action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.504Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.504Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/RECIPIENT_BLACKLIST
* Adds mosms trigger with recipient_blacklist action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.506Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.506Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/AMAZON_SQS_FORWARD/CONFIGURATION
* Returns mosms trigger forward action configuration amazon sqs
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AmazonSqsForwardActionConfigurationResponse {
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOSMS/AMAZON_SQS_FORWARD/CONFIGURATION
* Updates mosms trigger forward action configuration amazon sqs
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AmazonSqsForwardActionConfigurationResponse {
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
AmazonSqsForwardActionConfigurationRequest {
target (string, optional):
target URL
}
{
"target": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/SMS_FORWARD/CONFIGURATION
* Returns mosms trigger sms_forward configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsForwardActionConfigurationResponse {
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
prefixWithSender (boolean, optional):
prefixWithSender
,
respectSegmentCount (boolean, optional):
respectSegmentCount
,
senderAddress (string, optional):
senderAddress
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"prefixWithSender": true,
"respectSegmentCount": true,
"senderAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOSMS/SMS_FORWARD/CONFIGURATION
* Updates mosms trigger sms_forward configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsForwardActionConfigurationResponse {
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
prefixWithSender (boolean, optional):
prefixWithSender
,
respectSegmentCount (boolean, optional):
respectSegmentCount
,
senderAddress (string, optional):
senderAddress
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"prefixWithSender": true,
"respectSegmentCount": true,
"senderAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmsForwardActionConfigurationRequest {
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
prefixWithSender (boolean, optional):
prefixWithSender
,
respectSegmentCount (boolean, optional):
respectSegmentCount
,
senderAddress (string, optional):
senderAddress
}
{
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"prefixWithSender": true,
"respectSegmentCount": true,
"senderAddress": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/SMS_FORWARD/CONFIGURATION/CONTACT_GROUPS
* Returns configured contact groups for mosms trigger forward action
configuration sms_forward
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.513Z",
"lastModified": "2024-06-20T13:22:51.513Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.513Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.513Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/SMS_FORWARD/CONFIGURATION/CONTACTS
* Returns configured contacts for mosms trigger forward action
configuration sms_forward
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.516Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.517Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/SMS_ANSWER/CONFIGURATION
* Returns mosms trigger sms_answer configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
senderAddress (string, optional):
senderAddress
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"senderAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOSMS/SMS_ANSWER/CONFIGURATION
* Updates mosms trigger sms_answer configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
senderAddress (string, optional):
senderAddress
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"senderAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmsAnswerActionConfigurationRequest {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
senderAddress (string, optional):
senderAddress
}
{
"messageContent": "string",
"templateId": 0,
"senderAddress": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/SMS_AUTO_RESPONSE/CONFIGURATION
* Returns mosms trigger sms_auto_response configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsAutoResponseActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOSMS/SMS_AUTO_RESPONSE/CONFIGURATION
* Updates mosms trigger sms_auto_response configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsAutoResponseActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmsAutoResponseActionConfigurationRequest {
messageContent (string, optional):
messageContent
,
contentCategories (Array[string], optional)
}
{
"messageContent": "string",
"contentCategories": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/RECIPIENT_BLACKLIST/CONFIGURATION
* Returns mosms trigger recipient_blacklist configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsRecipientBlacklistActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
contentCategories (Array[string], optional),
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"contentCategories": [
"string"
],
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOSMS/RECIPIENT_BLACKLIST/CONFIGURATION
* Updates mosms trigger recipient_blacklist configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsRecipientBlacklistActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
contentCategories (Array[string], optional),
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"contentCategories": [
"string"
],
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmsRecipientBlacklistActionConfigurationRequest {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
contentCategories (Array[string], optional)
}
{
"messageContent": "string",
"templateId": 0,
"contentCategories": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOSMS/VOICE_FORWARD
* Adds mosms trigger with voice_forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.528Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.528Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/VOICE_FORWARD/CONFIGURATION
* Returns mosms trigger voice_forward configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
VoiceForwardActionConfigurationResponse {
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
prefixWithSender (boolean, optional):
prefixWithSender
,
respectSegmentCount (boolean, optional):
respectSegmentCount
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"prefixWithSender": true,
"respectSegmentCount": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOSMS/VOICE_FORWARD/CONFIGURATION
* Updates mosms trigger voice_forward configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
VoiceForwardActionConfigurationResponse {
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
prefixWithSender (boolean, optional):
prefixWithSender
,
respectSegmentCount (boolean, optional):
respectSegmentCount
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"prefixWithSender": true,
"respectSegmentCount": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
VoiceForwardActionConfigurationRequest {
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
prefixWithSender (boolean, optional):
prefixWithSender
,
respectSegmentCount (boolean, optional):
respectSegmentCount
}
{
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"prefixWithSender": true,
"respectSegmentCount": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/VOICE_FORWARD/CONFIGURATION/CONTACT_GROUPS
* Returns configured contact groups for mosms trigger forward action
configuration voice_forward
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.533Z",
"lastModified": "2024-06-20T13:22:51.533Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.533Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.533Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOSMS/VOICE_FORWARD/CONFIGURATION/CONTACTS
* Returns configured contacts for mosms trigger forward action
configuration voice_forward
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.536Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.536Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/MOWHATSAPP/SEQUENCE_ORDER
* Returns sequence orders of mowhatsapp triggers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWhatsappTriggerSequenceOrderResponse {
order (Array[integer]):
sequence order of mosms trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWHATSAPP/SEQUENCE_ORDER
* Adds sequence order for mowhatsapp trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWhatsappTriggerSequenceOrderResponse {
order (Array[integer]):
sequence order of mosms trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MoWhatsappTriggerSequenceOrderRequest {
order (Array[integer]):
sequence order of mosms trigger
}
{
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/MOMESSENGER/SEQUENCE_ORDER
* Returns sequence orders of momessenger triggers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoMessengerTriggerSequenceOrderResponse {
order (Array[integer]):
sequence order of momessenger trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOMESSENGER/SEQUENCE_ORDER
* Adds sequence order for momessenger trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoMessengerTriggerSequenceOrderResponse {
order (Array[integer]):
sequence order of momessenger trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MoMessengerTriggerSequenceOrderRequest {
order (Array[integer]):
sequence order of momessenger trigger
}
{
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/MOWHATSAPP/SEQUENCE_ORDER/{ID}
* Returns sequence order of mowhatsapp trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWhatsappTriggerSequenceOrderResponse {
order (Array[integer]):
sequence order of mosms trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/MOWHATSAPP/SEQUENCE_ORDER/{ID}
* Updates sequence order of mowhatsapp trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWhatsappTriggerSequenceOrderResponse {
order (Array[integer]):
sequence order of mosms trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MoWhatsappTriggerSequenceOrderRequest {
order (Array[integer]):
sequence order of mosms trigger
}
{
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWHATSAPP/HTTP_FORWARD
* Adds mowhatsapp trigger with http forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.544Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.544Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/TRIGGERS/{ID}/MOWHATSAPP
* Deletes mowhatsapp trigger
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP
* Returns mowhatsapp trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.546Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.546Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWHATSAPP
* Updates mowhatsapp trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.548Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.548Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP/CONFIGURATION
* Returns mowhatsapp trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWhatsappTriggerConfigurationResponse {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:51.549Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:51.549Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWHATSAPP/CONFIGURATION
* Updates mowhatsapp trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWhatsappTriggerConfigurationResponse {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:51.550Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:51.550Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MoWhatsappTriggerConfigurationRequest {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:50.733Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:50.733Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP/HTTP_FORWARD/CONFIGURATION
* Returns mowhatsapp trigger forward action configuration http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWHATSAPP/HTTP_FORWARD/CONFIGURATION
* Updates mowhatsapp trigger forward action configuration http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
HttpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
}
{
"format": "string",
"target": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWHATSAPP/SMTP_FORWARD
* Adds mowhatsapp trigger with smtp forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.554Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.554Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP/SMTP_FORWARD/CONFIGURATION
* Returns mowhatsapp trigger forward action configuration smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmtpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWHATSAPP/SMTP_FORWARD/CONFIGURATION
* Updates mowhatsapp trigger forward action configuration smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmtpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmtpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/TRIGGERS/{ID}/MOWHATSAPP/SMTP_FORWARD/CONFIGURATION/CONTACT_GROUPS
* Returns configured contact groups for mowhatsapp trigger forward
action configuration smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.559Z",
"lastModified": "2024-06-20T13:22:51.559Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.559Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.559Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP/SMTP_FORWARD/CONFIGURATION/CONTACTS
* Returns configured contacts for mowhatsapp trigger forward action
configuration smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.561Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.561Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWHATSAPP/INBOX_FORWARD
* Adds mowhatsapp trigger with iunbox forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.563Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.563Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWHATSAPP/AMAZON_SQS_FORWARD
* Adds mowhatsapp trigger with amazon sqs forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.564Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.564Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWHATSAPP/SMSBOX_FORWARD
* Adds mowhatsapp trigger with smsbox forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.566Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.566Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWHATSAPP/WHATSAPP_ANSWER
* Adds mowhatsapp trigger with whatsapp_answer action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.567Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.567Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWHATSAPP/SMS_ANSWER
* Adds mowhatsapp trigger with sms_answer action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.569Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.569Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWHATSAPP/WHATSAPP_FORWARD
* Adds mosms trigger with whatsapp_forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.570Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.570Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWHATSAPP/WHATSAPP_AUTO_RESPONSE
* Adds mowhatsapp trigger with whatsapp_auto_response action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.572Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.572Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP/AMAZON_SQS_FORWARD/CONFIGURATION
* Returns mowhatsapp trigger forward action configuration amazon sqs
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AmazonSqsForwardActionConfigurationResponse {
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWHATSAPP/AMAZON_SQS_FORWARD/CONFIGURATION
* Updates mowhatsapp trigger forward action configuration amazon sqs
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AmazonSqsForwardActionConfigurationResponse {
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
AmazonSqsForwardActionConfigurationRequest {
target (string, optional):
target URL
}
{
"target": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP/WHATSAPP_FORWARD/CONFIGURATION
* Returns mowhatsapp trigger whatsapp_forward configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappForwardActionConfigurationResponse {
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
prefixWithSender (boolean, optional):
prefixWithSender
,
respectSegmentCount (boolean, optional):
respectSegmentCount
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"prefixWithSender": true,
"respectSegmentCount": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWHATSAPP/WHATSAPP_FORWARD/CONFIGURATION
* Updates mowhatsapp trigger whatsapp_forward configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappForwardActionConfigurationResponse {
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
prefixWithSender (boolean, optional):
prefixWithSender
,
respectSegmentCount (boolean, optional):
respectSegmentCount
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"prefixWithSender": true,
"respectSegmentCount": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
WhatsappForwardActionConfigurationRequest {
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
prefixWithSender (boolean, optional):
prefixWithSender
,
respectSegmentCount (boolean, optional):
respectSegmentCount
}
{
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"prefixWithSender": true,
"respectSegmentCount": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/TRIGGERS/{ID}/MOWHATSAPP/WHATSAPP_FORWARD/CONFIGURATION/CONTACT_GROUPS
* Returns configured contact groups for mowhatsapp trigger
whatsapp_forward action configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ContactGroupResponse
]
ContactGroupResponse {
name (string):
group name
,
remarks (string, optional):
custom remarks
,
birthdayTemplateId (integer, optional):
message template used for birthday messages
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
remoteSmsTemplateId (integer, optional):
message template used for remote SMS
,
welcomeSmsContent (string, optional):
welcome sms content
,
welcomeSmsActive (boolean, optional):
welcome sms active?
,
goodbyeSmsContent (string, optional):
goodbye sms content
,
goodbyeSmsActive (boolean, optional):
goodbye sms active?
,
welcomeWhatsappContent (string, optional):
welcome whatsapp content
,
welcomeWhatsappActive (boolean, optional):
welcome whatsapp active?
,
goodbyeWhatsappContent (string, optional):
goodbye whatsapp content
,
goodbyeWhatsappActive (boolean, optional):
goodbye whatsapp active?
,
mobile (boolean, optional):
is sms/voice/push group?
,
whatsapp (boolean, optional):
is whatsapp group?
,
id (integer):
contact group id
,
size (integer, optional):
size of group
,
whatsappSize (integer, optional):
amount of whatsapp recipients in group
,
mobileSize (integer, optional):
amount of mobile sms recipients in group
,
mobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
whatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels
,
allChannelsEnabledSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
,
whatsappChannelAndWhatsappDeviceEnabledSize (integer, optional):
amount of recipients in group with whatsapp AND enabled whatsapp channel
AND whatsapp device
,
mobileAndMobileChannelEnabledSize (integer, optional):
amount of recipients in group with enabled mobile channels and mobile
,
whatsappAndWhatsappChannelEnabledSize (integer, optional):
amount of recipients in group with enabled whatsapp channels and whatsapp
,
allChannelsEnabledAndReachableSize (integer, optional):
amount of recipients in group with enabled mobile AND whatsapp channel
AND mobile AND whatsapp AND whatsapp device
,
allChannelsEnabledAndRecipientsSize (integer, optional):
amount of recipients in group with all channels enabled and non empty
recipients
,
emailAddressSize (integer, optional):
amount of recipients in group containing emailAddress
,
lastTransfer (string, optional):
last transfer
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
,
birthdayTemplate (MessageTemplateResponse, optional):
message template used for birthday messages
,
remoteSmsTemplate (MessageTemplateResponse, optional):
message template used for remote SMS
}
Link {
rel (string, optional),
href (string, optional)
}
MessageTemplateResponse {
name (string):
message template name
,
content (string):
message template content
,
deliveryReport (boolean):
request delivery report?
,
remoteSmsShortcut (string, optional):
remote SMS shortcut
,
smsType (integer, optional):
SMS type (0 = default, 1 = flash, 2 = both)
,
contentCategory (string, optional):
content category (personal, advertisement or informational
,
messageType (string, optional):
message type (default, sms, voice, whatsapp
stringReg. Exp.:^$|^(?i)(default|voice|whatsapp)$
,
urlshorteningType (string, optional):
urlshortening type
,
id (integer):
message template id
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
links (Array[Link], optional):
links
}
[
{
"name": "string",
"remarks": "string",
"birthdayTemplateId": 0,
"remoteSmsEnabled": true,
"remoteSmsShortcut": "string",
"remoteSmsTemplateId": 0,
"welcomeSmsContent": "string",
"welcomeSmsActive": true,
"goodbyeSmsContent": "string",
"goodbyeSmsActive": true,
"welcomeWhatsappContent": "string",
"welcomeWhatsappActive": true,
"goodbyeWhatsappContent": "string",
"goodbyeWhatsappActive": true,
"mobile": true,
"whatsapp": true,
"id": 0,
"size": 0,
"whatsappSize": 0,
"mobileSize": 0,
"mobileChannelEnabledSize": 0,
"whatsappChannelEnabledSize": 0,
"allChannelsEnabledSize": 0,
"whatsappChannelAndWhatsappDeviceEnabledSize": 0,
"mobileAndMobileChannelEnabledSize": 0,
"whatsappAndWhatsappChannelEnabledSize": 0,
"allChannelsEnabledAndReachableSize": 0,
"allChannelsEnabledAndRecipientsSize": 0,
"emailAddressSize": 0,
"lastTransfer": "2024-06-20T13:22:51.580Z",
"lastModified": "2024-06-20T13:22:51.580Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"birthdayTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.580Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"remoteSmsTemplate": {
"name": "string",
"content": "string",
"deliveryReport": true,
"remoteSmsShortcut": "string",
"smsType": 0,
"contentCategory": "string",
"messageType": "string",
"urlshorteningType": "string",
"id": 0,
"lastModified": "2024-06-20T13:22:51.580Z",
"lastModifiedBy": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP/WHATSAPP_FORWARD/CONFIGURATION/CONTACTS
* Returns configured contacts for mowhatsapp trigger whatsapp_forward
action configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.583Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.583Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP/WHATSAPP_ANSWER/CONFIGURATION
* Returns mowhatsapp trigger whatsapp_answer configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWHATSAPP/WHATSAPP_ANSWER/CONFIGURATION
* Updates mowhatsapp trigger whatsapp_answer configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
WhatsappAnswerActionConfigurationRequest {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
}
{
"messageContent": "string",
"templateId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOMESSENGER/WHATSAPP_ANSWER/CONFIGURATION
* Returns momessenger trigger whatsapp_messenger_answer configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappMessengerAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOMESSENGER/WHATSAPP_ANSWER/CONFIGURATION
* Updates momessenger trigger whatsapp_messenger_answer configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappMessengerAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
WhatsappMessengerAnswerActionConfigurationRequest {
messageContent (string, optional):
messageContent
}
{
"messageContent": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP/SMS_ANSWER/CONFIGURATION
* Returns mowhatsapp trigger sms_answer configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
senderAddress (string, optional):
senderAddress
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"senderAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWHATSAPP/SMS_ANSWER/CONFIGURATION
* Updates mowhatsapp trigger sms_answer configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmsAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
senderAddress (string, optional):
senderAddress
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"senderAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmsAnswerActionConfigurationRequest {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
senderAddress (string, optional):
senderAddress
}
{
"messageContent": "string",
"templateId": 0,
"senderAddress": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWHATSAPP/WHATSAPP_AUTO_RESPONSE/CONFIGURATION
* Returns mowhatsapp trigger whatsapp_auto_response configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappAutoResponseActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWHATSAPP/WHATSAPP_AUTO_RESPONSE/CONFIGURATION
* Updates mowhatsapp trigger whatsapp_auto_response configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappAutoResponseActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"templateId": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
WhatsappAutoResponseActionConfigurationRequest {
messageContent (string, optional):
messageContent
,
templateId (integer, optional):
templateId
}
{
"messageContent": "string",
"templateId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/MOMESSENGER/SEQUENCE_ORDER/{ID}
* Returns sequence order of momessenger trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoMessengerTriggerSequenceOrderResponse {
order (Array[integer]):
sequence order of momessenger trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/MOMESSENGER/SEQUENCE_ORDER/{ID}
* Updates sequence order of momessenger trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoMessengerTriggerSequenceOrderResponse {
order (Array[integer]):
sequence order of momessenger trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mosms, ...)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MoMessengerTriggerSequenceOrderRequest {
order (Array[integer]):
sequence order of momessenger trigger
}
{
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/TRIGGERS/{ID}/MOMESSENGER
* Deletes momessenger trigger
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOMESSENGER
* Returns momessenger trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.617Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.617Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOMESSENGER
* Updates momessenger trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.619Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.619Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOMESSENGER/CONFIGURATION
* Returns momessenger trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWhatsappTriggerConfigurationResponse {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:51.622Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:51.622Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOMESSENGER/CONFIGURATION
* Updates momessenger trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWhatsappTriggerConfigurationResponse {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:51.624Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:51.624Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MoMessengerTriggerConfigurationRequest {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:50.737Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:50.737Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOMESSENGER/SMTP_FORWARD
* Adds momessenger trigger with smtp forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.626Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.626Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOMESSENGER/SMTP_FORWARD/CONFIGURATION
* Returns momessenger trigger forward action configuration smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmtpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOMESSENGER/SMTP_FORWARD/CONFIGURATION
* Updates momessenger trigger forward action configuration smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmtpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmtpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOMESSENGER/WHATSAPP_ANSWER
* Adds momessenger trigger with whatsapp_messenger_answer action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.632Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.632Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOMESSENGER/WHATSAPP_AUTO_RESPONSE
* Adds momessenger trigger with whatsapp_auto_response action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.633Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.633Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOMESSENGER/WHATSAPP_AUTO_RESPONSE/CONFIGURATION
* Returns momessenger trigger whatsapp_auto_response configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappMessengerAutoResponseActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOMESSENGER/WHATSAPP_AUTO_RESPONSE/CONFIGURATION
* Updates momessenger trigger whatsapp_auto_response configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappMessengerAutoResponseActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
WhatsappMessengerAutoResponseActionConfigurationRequest {
messageContent (string, optional):
messageContent
}
{
"messageContent": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOMESSENGER/HTTP_FORWARD
* Adds momessenger trigger with http forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.640Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.640Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
}
{
"name": "string",
"enabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOMESSENGER/HTTP_FORWARD/CONFIGURATION
* Returns momessenger trigger forward action configuration http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOMESSENGER/HTTP_FORWARD/CONFIGURATION
* Updates momessenger trigger forward action configuration http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
HttpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
}
{
"format": "string",
"target": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/MOWAB_CUSTOMER_CHANNEL/SEQUENCE_ORDER
* Returns sequence orders of mowab_customer_channel triggers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWabCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of mowab identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mowab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWAB_CUSTOMER_CHANNEL/SEQUENCE_ORDER
* Adds sequence order for mowab_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWabCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of mowab identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mowab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MoWabCustomerChannelTriggerSequenceOrderRequest {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of mowab identifier trigger
}
{
"customerChannelId": 0,
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/MOWAB_CUSTOMER_CHANNEL/SEQUENCE_ORDER/{ID}
* Returns sequence order of mowab_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWabCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of mowab identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mowab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/MOWAB_CUSTOMER_CHANNEL/SEQUENCE_ORDER/{ID}
* Updates sequence order of mowab_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWabCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of mowab identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mowab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MoWabCustomerChannelTriggerSequenceOrderRequest {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of mowab identifier trigger
}
{
"customerChannelId": 0,
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL
* Deletes mowab_customer_channel trigger
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL
* Returns mowab_customer_channel trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.659Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.659Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL
* Updates mowab_customer_channel trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.661Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.661Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS
* Returns all (account specific) triggers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.665Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.665Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/CONFIGURATION
* Returns mowab_customer_channel trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWabCustomerChannelTriggerConfigurationResponse {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:51.668Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:51.668Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/CONFIGURATION
* Updates mowab_customer_channel trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoWabCustomerChannelTriggerConfigurationResponse {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:51.671Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:51.671Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MoWabCustomerChannelTriggerConfigurationRequest {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:50.739Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:50.739Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWAB_CUSTOMER_CHANNEL/SMTP_FORWARD
* Adds mowab_customer_channel trigger with smtp forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.674Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.674Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/SMTP_FORWARD/CONFIGURATION
* Returns mowab_customer_channel trigger forward action configuration
smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmtpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/SMTP_FORWARD/CONFIGURATION
* Updates mowab_customer_channel trigger forward action configuration
smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmtpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmtpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWAB_CUSTOMER_CHANNEL/WHATSAPP_ANSWER
* Adds mowab_customer_channel trigger with whatsapp_messenger_answer
action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.681Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.681Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/WHATSAPP_ANSWER/CONFIGURATION
* Returns mowab_customer_channel trigger whatsapp_messenger_answer
configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappMessengerAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT
/V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/WHATSAPP_ANSWER/CONFIGURATION
* Updates mowab_customer_channel trigger whatsapp_messenger_answer
configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappMessengerAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
WhatsappMessengerAnswerActionConfigurationRequest {
messageContent (string, optional):
messageContent
}
{
"messageContent": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWAB_CUSTOMER_CHANNEL/WHATSAPP_AUTO_RESPONSE
* Adds mowab_customer_channel trigger with whatsapp_auto_response action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.687Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.687Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/WHATSAPP_AUTO_RESPONSE/CONFIGURATION
* Returns mowab_customer_channel trigger whatsapp_auto_response
configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappMessengerAutoResponseActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT
/V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/WHATSAPP_AUTO_RESPONSE/CONFIGURATION
* Updates mowab_customer_channel trigger whatsapp_auto_response
configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappMessengerAutoResponseActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
WhatsappMessengerAutoResponseActionConfigurationRequest {
messageContent (string, optional):
messageContent
}
{
"messageContent": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWAB_CUSTOMER_CHANNEL/RECIPIENT_BLACKLIST
* Adds mowab_customer_channel trigger with recipient_blacklist action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.693Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.693Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/RECIPIENT_BLACKLIST/CONFIGURATION
* Returns mowab_customer_channel trigger recipient_blacklist
configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappRecipientBlacklistActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
contentCategories (Array[string], optional),
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"contentCategories": [
"string"
],
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT
/V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/RECIPIENT_BLACKLIST/CONFIGURATION
* Updates mowab_customer_channel trigger recipient_blacklist
configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappRecipientBlacklistActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
contentCategories (Array[string], optional),
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"contentCategories": [
"string"
],
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
WhatsappRecipientBlacklistActionConfigurationRequest {
messageContent (string, optional):
messageContent
,
contentCategories (Array[string], optional)
}
{
"messageContent": "string",
"contentCategories": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MOWAB_CUSTOMER_CHANNEL/HTTP_FORWARD
* Adds mowab_customer_channel trigger with http forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.700Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.700Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/HTTP_FORWARD/CONFIGURATION
* Returns mowab_customer_channel trigger forward action configuration
http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MOWAB_CUSTOMER_CHANNEL/HTTP_FORWARD/CONFIGURATION
* Updates mowab_customer_channel trigger forward action configuration
http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
HttpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
}
{
"format": "string",
"target": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/DLRWAB_CUSTOMER_CHANNEL/SEQUENCE_ORDER
* Returns sequence orders of dlrwab_customer_channel triggers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrWabCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrwab identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (dlrwab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/DLRWAB_CUSTOMER_CHANNEL/SEQUENCE_ORDER
* Adds sequence order for dlrwab_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrWabCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrwab identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (dlrwab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DlrWabCustomerChannelTriggerSequenceOrderRequestDto {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrwab identifier trigger
}
{
"customerChannelId": 0,
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/DLRWAB_CUSTOMER_CHANNEL/SEQUENCE_ORDER/{ID}
* Returns sequence order of dlrwab_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrWabCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrwab identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (dlrwab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/DLRWAB_CUSTOMER_CHANNEL/SEQUENCE_ORDER/{ID}
* Updates sequence order of dlrwab_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrWabCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrwab identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (dlrwab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
DlrWabCustomerChannelTriggerSequenceOrderRequestDto {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrwab identifier trigger
}
{
"customerChannelId": 0,
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/TRIGGERS/{ID}/DLRWAB_CUSTOMER_CHANNEL
* Deletes dlrwab_customer_channel trigger
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/DLRWAB_CUSTOMER_CHANNEL
* Returns dlrwab_customer_channel trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.719Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.719Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/DLRWAB_CUSTOMER_CHANNEL
* Updates dlrwab_customer_channel trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.720Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.720Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/DLRWAB_CUSTOMER_CHANNEL/CONFIGURATION
* Returns dlrwab_customer_channel trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrWabCustomerChannelTriggerConfigurationResponseDto {
sourceMessageOrigin (string, optional):
sourceMessageOrigin
stringReg. Exp.:^(?i)(null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"sourceMessageOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/DLRWAB_CUSTOMER_CHANNEL/CONFIGURATION
* Updates dlrwab_customer_channel trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrWabCustomerChannelTriggerConfigurationResponseDto {
sourceMessageOrigin (string, optional):
sourceMessageOrigin
stringReg. Exp.:^(?i)(null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"sourceMessageOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
DlrWabCustomerChannelTriggerConfigurationRequest {
sourceMessageOrigin (string, optional):
sourceMessageOrigin
stringReg. Exp.:^(?i)(null)$
}
{
"sourceMessageOrigin": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/DLRWAB_CUSTOMER_CHANNEL/HTTP_FORWARD
* Adds dlrwab_customer_channel trigger with http forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.726Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.726Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/DLRWAB_CUSTOMER_CHANNEL/HTTP_FORWARD/CONFIGURATION
* Returns dlrwab_customer_channel trigger forward action configuration
http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/DLRWAB_CUSTOMER_CHANNEL/HTTP_FORWARD/CONFIGURATION
* Updates dlrwab_customer_channel trigger forward action configuration
http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
HttpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
}
{
"format": "string",
"target": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/DLRWAB_CUSTOMER_CHANNEL/SMTP_FORWARD
* Adds dlrwab_customer_channel trigger with smtp forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.732Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.732Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/DLRWAB_CUSTOMER_CHANNEL/SMTP_FORWARD/CONFIGURATION
* Returns dlrwab_customer_channel trigger forward action configuration
smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmtpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/DLRWAB_CUSTOMER_CHANNEL/SMTP_FORWARD/CONFIGURATION
* Updates dlrwab_customer_channel trigger forward action configuration
smtp
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SmtpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmtpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
targets (Array[string], optional):
targets
stringMax. Items:1000
,
contactGroupIds (Array[integer], optional):
contactGroupIds
integerMax. Items:100
,
contactIds (Array[integer], optional):
contactIds
integerMax. Items:10000
,
fromType (string, optional):
from type
stringReg. Exp.:^(?i)(null|none|distinct_contact|first_contact)$
}
{
"format": "string",
"targets": [
"string"
],
"contactGroupIds": [
0
],
"contactIds": [
0
],
"fromType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/MORCS_CUSTOMER_CHANNEL/SEQUENCE_ORDER
* Returns sequence orders of morcs_customer_channel triggers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoRcsCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of morcs identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mowab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MORCS_CUSTOMER_CHANNEL/SEQUENCE_ORDER
* Adds sequence order for morcs_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoRcsCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of morcs identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mowab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MoRcsCustomerChannelTriggerSequenceOrderRequest {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of morcs identifier trigger
}
{
"customerChannelId": 0,
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/MORCS_CUSTOMER_CHANNEL/SEQUENCE_ORDER/{ID}
* Returns sequence order of morcs_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoRcsCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of morcs identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mowab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/MORCS_CUSTOMER_CHANNEL/SEQUENCE_ORDER/{ID}
* Updates sequence order of morcs_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoRcsCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of morcs identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (mowab_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MoRcsCustomerChannelTriggerSequenceOrderRequest {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of morcs identifier trigger
}
{
"customerChannelId": 0,
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL
* Deletes morcs_customer_channel trigger
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL
* Returns morcs_customer_channel trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.746Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.746Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL
* Updates morcs_customer_channel trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.748Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.748Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL/CONFIGURATION
* Returns morcs_customer_channel trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoRcsCustomerChannelTriggerConfigurationResponse {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:51.751Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:51.751Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL/CONFIGURATION
* Updates morcs_customer_channel trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MoRcsCustomerChannelTriggerConfigurationResponse {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:51.753Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:51.753Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
MoRcsCustomerChannelTriggerConfigurationRequest {
contentConditionsEnabled (boolean, optional):
contentConditionsEnabled
,
contentConditionsPattern (string, optional):
contentConditionsPattern
stringMax. Length:255
,
contentConditionsIgnoreCase (boolean, optional):
contentConditionsIgnoreCase
,
contentConditionsFlag (string, optional):
contentConditionsFlag
stringReg.
Exp.:^(?i)(equals|contains|not_contains|startswith|not_startswith|null)$
,
contentConditionsHasAttachment (string, optional):
contentConditionsHasAttachment
stringReg. Exp.:^(?i)(yes|no|null)$
,
validityPeriodConditionsEnabled (boolean, optional):
validityPeriodConditionsEnabled
,
validityPeriodConditionsStart (string, optional):
validityPeriodConditionsStart
,
validityPeriodConditionsEnd (string, optional):
validityPeriodConditionsEnd
,
timePlanConditionsEnabled (boolean, optional):
timePlanConditionsEnabled
,
timePlanConditionsWeekdays (Array[string], optional):
timePlanConditionsWeekdays
,
timePlanConditionsStartTime (string, optional):
timePlanConditionsStartTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsEndTime (string, optional):
timePlanConditionsEndTime
stringReg. Exp.:^((?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)|null)$
,
timePlanConditionsTimeZone (string, optional):
timePlanConditionsTimeZone
stringReg. Exp.:^(Europe\/Vienna|null)$
}
{
"contentConditionsEnabled": true,
"contentConditionsPattern": "string",
"contentConditionsIgnoreCase": true,
"contentConditionsFlag": "string",
"contentConditionsHasAttachment": "string",
"validityPeriodConditionsEnabled": true,
"validityPeriodConditionsStart": "2024-06-20T13:22:50.742Z",
"validityPeriodConditionsEnd": "2024-06-20T13:22:50.742Z",
"timePlanConditionsEnabled": true,
"timePlanConditionsWeekdays": [
"string"
],
"timePlanConditionsStartTime": "string",
"timePlanConditionsEndTime": "string",
"timePlanConditionsTimeZone": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MORCS_CUSTOMER_CHANNEL/RCS_ANSWER
* Adds morcs_customer_channel trigger with rcs_answer action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.755Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.755Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL/RCS_ANSWER/CONFIGURATION
* Returns morcs_customer_channel trigger rcs_answer configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RcsAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL/RCS_ANSWER/CONFIGURATION
* Updates morcs_customer_channel trigger rcs_answer configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RcsAnswerActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
RcsAnswerActionConfigurationRequest {
messageContent (string, optional):
messageContent
}
{
"messageContent": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MORCS_CUSTOMER_CHANNEL/RCS_AUTO_RESPONSE
* Adds morcs_customer_channel trigger with rcs_auto_response action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.761Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.761Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL/RCS_AUTO_RESPONSE/CONFIGURATION
* Returns morcs_customer_channel trigger rcs_auto_response configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RcsAutoResponseActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT
/V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL/RCS_AUTO_RESPONSE/CONFIGURATION
* Updates morcs_customer_channel trigger rcs_auto_response configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RcsAutoResponseActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
RcsAutoResponseActionConfigurationRequest {
messageContent (string, optional):
messageContent
}
{
"messageContent": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MORCS_CUSTOMER_CHANNEL/RECIPIENT_BLACKLIST
* Adds morcs_customer_channel trigger with recipient_blacklist action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.769Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.769Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL/RECIPIENT_BLACKLIST/CONFIGURATION
* Returns morcs_customer_channel trigger recipient_blacklist
configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RcsRecipientBlacklistActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
contentCategories (Array[string], optional),
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"contentCategories": [
"string"
],
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT
/V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL/RECIPIENT_BLACKLIST/CONFIGURATION
* Updates morcs_customer_channel trigger recipient_blacklist
configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RcsRecipientBlacklistActionConfigurationResponse {
messageContent (string, optional):
messageContent
,
contentCategories (Array[string], optional),
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"messageContent": "string",
"contentCategories": [
"string"
],
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
SmsAutoResponseActionConfigurationRequest {
messageContent (string, optional):
messageContent
,
contentCategories (Array[string], optional)
}
{
"messageContent": "string",
"contentCategories": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/MORCS_CUSTOMER_CHANNEL/HTTP_FORWARD
* Adds morcs_customer_channel trigger with http forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.775Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.775Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL/HTTP_FORWARD/CONFIGURATION
* Returns morcs_customer_channel trigger forward action configuration
http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/MORCS_CUSTOMER_CHANNEL/HTTP_FORWARD/CONFIGURATION
* Updates morcs_customer_channel trigger forward action configuration
http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
HttpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
}
{
"format": "string",
"target": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/DLRRCS_CUSTOMER_CHANNEL/SEQUENCE_ORDER
* Returns sequence orders of dlrrcs_customer_channel triggers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrRcsCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrrcs identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (dlrrcs_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/DLRRCS_CUSTOMER_CHANNEL/SEQUENCE_ORDER
* Adds sequence order for dlrrcs_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrRcsCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrrcs identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (dlrrcs_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DlrRcsCustomerChannelTriggerSequenceOrderRequestDto {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrrcs identifier trigger
}
{
"customerChannelId": 0,
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/DLRRCS_CUSTOMER_CHANNEL/SEQUENCE_ORDER/{ID}
* Returns sequence order of dlrrcs_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrRcsCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrrcs identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (dlrrcs_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/DLRRCS_CUSTOMER_CHANNEL/SEQUENCE_ORDER/{ID}
* Updates sequence order of dlrrcs_customer_channel trigger
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrRcsCustomerChannelTriggerSequenceOrderResponse {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrrcs identifier trigger
,
id (integer, optional):
triggerOrder id
,
trigger (string, optional):
trigger type (dlrrcs_customer_channel)
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"customerChannelId": 0,
"order": [
0
],
"id": 0,
"trigger": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
DlrRcsCustomerChannelTriggerSequenceOrderRequestDto {
customerChannelId (integer, optional):
customerChannelId
,
order (Array[integer]):
sequence order of dlrrcs identifier trigger
}
{
"customerChannelId": 0,
"order": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/TRIGGERS/{ID}/DLRRCS_CUSTOMER_CHANNEL
* Deletes dlrrcs_customer_channel trigger
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/DLRRCS_CUSTOMER_CHANNEL
* Returns dlrrcs_customer_channel trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.793Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.793Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/DLRRCS_CUSTOMER_CHANNEL
* Updates dlrrcs_customer_channel trigger metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.795Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.795Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/DLRRCS_CUSTOMER_CHANNEL/CONFIGURATION
* Returns dlrrcs_customer_channel trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrRcsCustomerChannelTriggerConfigurationResponseDto {
sourceMessageOrigin (string, optional):
sourceMessageOrigin
stringReg. Exp.:^(?i)(null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"sourceMessageOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/DLRRCS_CUSTOMER_CHANNEL/CONFIGURATION
* Updates dlrrcs_customer_channel trigger configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DlrRcsCustomerChannelTriggerConfigurationResponseDto {
sourceMessageOrigin (string, optional):
sourceMessageOrigin
stringReg. Exp.:^(?i)(null)$
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"sourceMessageOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
DlrRcsCustomerChannelTriggerConfigurationRequest {
sourceMessageOrigin (string, optional):
sourceMessageOrigin
stringReg. Exp.:^(?i)(null)$
}
{
"sourceMessageOrigin": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TRIGGERS/DLRRCS_CUSTOMER_CHANNEL/HTTP_FORWARD
* Adds dlrrcs_customer_channel trigger with http forward action
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
CustomerChannelTriggerResponse {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
id (integer, optional):
trigger id
,
trigger (string, optional):
trigger type (mosms, ...)
,
action (string, optional):
trigger action
,
configValid (boolean, optional):
is config valid/complete?
,
lastModified (string, optional),
lastModifiedBy (string, optional):
last modified by
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
lastOrigin (string, optional):
last origin
,
links (Array[Link], optional):
links
,
customerChannelId (integer, optional):
customerChannelId
}
Link {
rel (string, optional),
href (string, optional)
}
{
"name": "string",
"enabled": true,
"id": 0,
"trigger": "string",
"action": "string",
"configValid": true,
"lastModified": "2024-06-20T13:22:51.805Z",
"lastModifiedBy": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.805Z",
"lastOrigin": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"customerChannelId": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerChannelTriggerRequest {
name (string, optional):
name
,
enabled (boolean, optional):
enabled
,
customerChannelId (integer, optional):
customerChannelId
}
{
"name": "string",
"enabled": true,
"customerChannelId": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/TRIGGERS/{ID}/DLRRCS_CUSTOMER_CHANNEL/HTTP_FORWARD/CONFIGURATION
* Returns dlrrcs_customer_channel trigger forward action configuration
http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TRIGGERS/{ID}/DLRRCS_CUSTOMER_CHANNEL/HTTP_FORWARD/CONFIGURATION
* Updates dlrrcs_customer_channel trigger forward action configuration
http
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HttpForwardActionConfigurationResponse {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"format": "string",
"target": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
HttpForwardActionConfigurationRequest {
format (string, optional):
format (json, xml, ...)
stringReg. Exp.:^(?i)(json|xml|xml_legacy|customer_channel_default)$
,
target (string, optional):
target URL
}
{
"format": "string",
"target": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* UNCATEGORIZED : WEBSMS.COM API (V1)
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/REGISTRATION/{ID}/CONFIRM_EMAIL_ADDRESS_VERIFICATION
* Confirms email address verification
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
secret query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/REGISTRATION/{ID}/CONFIRM_EMAIL_ADDRESS_VERIFICATION
* Confirms email address verification
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RegistrationResponse {
siteId (integer, optional):
site id (0 = Unknown/Autodetect, 1 = Austria, 2 = Germany, 3 =
Switzerland, 4 = Italy, 5 = Linkmobility Germany, 6 = Linkmobility SSU
Germany, 7 = Linkmobility SSU Austria, 8 = Linkmobility SSU Switzerland
,
resellerId (integer, optional):
reseller id
integerMax. Value:2147483647
,
mainContactEmailAddress (string, optional):
email address
,
mainContactFirstName (string, optional):
first name
,
mainContactLastName (string, optional):
last name
,
password (string, optional):
password
,
locale (string, optional):
locale
,
trial (boolean, optional):
is trial light registration
,
companyName (string, optional):
company name
,
companyStreet (string, optional):
company street
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
vatId (string, optional):
vat id
,
companySectorIndustryId (integer, optional):
sector industry id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
companySizeId (integer, optional):
company size id
,
mainContactTitle (string, optional):
main contact title
,
mainContactSalutation (string, optional):
main contact salutation
,
mainContactPhoneNumber (string, optional):
main contact phone number
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
invoicingCompanyName (string, optional):
invoicing company name
,
invoicingCompanyStreet (string, optional):
invoicing company street
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
paymentMethod (string, optional):
payment method
,
newsletters (boolean, optional):
accepts newsletters
,
confirmedAgbRead (boolean, optional):
confirmed agb read
,
voucherCode (string, optional):
voucher code
,
origin (string, optional):
origin
,
shoppingCart (ShoppingCartRequest, optional):
shopping cart
,
gaClientId (string, optional):
gaClientId
,
id (string, optional):
registration id (encrypted)
,
status (string):
status
,
links (Array[Link], optional):
links
,
eInvoiceEmailAddress (string, optional):
einvoice email address
}
ShoppingCartRequest {
basePackage (string, optional):
base package
stringReg.
Exp.:^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$
,
addonPackages (Array[string], optional):
addon packages
,
paymentPlan (string, optional)
stringReg. Exp.:^(?i)(yearly|monthly|null)$
}
Link {
rel (string, optional),
href (string, optional)
}
{
"siteId": 0,
"resellerId": 0,
"mainContactEmailAddress": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"password": "string",
"locale": "string",
"trial": true,
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"vatId": "string",
"companySectorIndustryId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"companySizeId": 0,
"mainContactTitle": "string",
"mainContactSalutation": "string",
"mainContactPhoneNumber": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"bankAccept": true,
"paymentMethod": "string",
"newsletters": true,
"confirmedAgbRead": true,
"voucherCode": "string",
"origin": "string",
"shoppingCart": {
"basePackage": "string",
"addonPackages": [
"string"
],
"paymentPlan": "string"
},
"gaClientId": "string",
"id": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"eInvoiceEmailAddress": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string body
Parameter content type: application/json
body
* Model
* Model Schema
ConfirmRegistrationVerificationRequest {
secret (string):
secret
}
{
"secret": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/REGISTRATION/{ID}/VERIFY
* Verifies customer registration
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/REGISTRATION/GOOGLE/AUTHORIZE
*
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
AuthorizeRequest {
redirectUri (string, optional):
Redirect URI
}
{
"redirectUri": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
successful operation
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/REGISTRATION/LIVE/AUTHORIZE
*
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
AuthorizeRequest {
redirectUri (string, optional):
Redirect URI
}
{
"redirectUri": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
successful operation
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/REGISTRATION/TERMS_AND_CONDITIONS
* Returns site specific terms and conditions
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TermsAndConditionsResponseDto {
termsAndConditions (string, optional)
}
{
"termsAndConditions": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId query integer
locale query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/REGISTRATION/{ID}
* Returns customer registration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RegistrationResponse {
siteId (integer, optional):
site id (0 = Unknown/Autodetect, 1 = Austria, 2 = Germany, 3 =
Switzerland, 4 = Italy, 5 = Linkmobility Germany, 6 = Linkmobility SSU
Germany, 7 = Linkmobility SSU Austria, 8 = Linkmobility SSU Switzerland
,
resellerId (integer, optional):
reseller id
integerMax. Value:2147483647
,
mainContactEmailAddress (string, optional):
email address
,
mainContactFirstName (string, optional):
first name
,
mainContactLastName (string, optional):
last name
,
password (string, optional):
password
,
locale (string, optional):
locale
,
trial (boolean, optional):
is trial light registration
,
companyName (string, optional):
company name
,
companyStreet (string, optional):
company street
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
vatId (string, optional):
vat id
,
companySectorIndustryId (integer, optional):
sector industry id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
companySizeId (integer, optional):
company size id
,
mainContactTitle (string, optional):
main contact title
,
mainContactSalutation (string, optional):
main contact salutation
,
mainContactPhoneNumber (string, optional):
main contact phone number
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
invoicingCompanyName (string, optional):
invoicing company name
,
invoicingCompanyStreet (string, optional):
invoicing company street
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
paymentMethod (string, optional):
payment method
,
newsletters (boolean, optional):
accepts newsletters
,
confirmedAgbRead (boolean, optional):
confirmed agb read
,
voucherCode (string, optional):
voucher code
,
origin (string, optional):
origin
,
shoppingCart (ShoppingCartRequest, optional):
shopping cart
,
gaClientId (string, optional):
gaClientId
,
id (string, optional):
registration id (encrypted)
,
status (string):
status
,
links (Array[Link], optional):
links
,
eInvoiceEmailAddress (string, optional):
einvoice email address
}
ShoppingCartRequest {
basePackage (string, optional):
base package
stringReg.
Exp.:^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$
,
addonPackages (Array[string], optional):
addon packages
,
paymentPlan (string, optional)
stringReg. Exp.:^(?i)(yearly|monthly|null)$
}
Link {
rel (string, optional),
href (string, optional)
}
{
"siteId": 0,
"resellerId": 0,
"mainContactEmailAddress": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"password": "string",
"locale": "string",
"trial": true,
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"vatId": "string",
"companySectorIndustryId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"companySizeId": 0,
"mainContactTitle": "string",
"mainContactSalutation": "string",
"mainContactPhoneNumber": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"bankAccept": true,
"paymentMethod": "string",
"newsletters": true,
"confirmedAgbRead": true,
"voucherCode": "string",
"origin": "string",
"shoppingCart": {
"basePackage": "string",
"addonPackages": [
"string"
],
"paymentPlan": "string"
},
"gaClientId": "string",
"id": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"eInvoiceEmailAddress": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/REGISTRATION/{ID}
* Updates customer registration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RegistrationResponse {
siteId (integer, optional):
site id (0 = Unknown/Autodetect, 1 = Austria, 2 = Germany, 3 =
Switzerland, 4 = Italy, 5 = Linkmobility Germany, 6 = Linkmobility SSU
Germany, 7 = Linkmobility SSU Austria, 8 = Linkmobility SSU Switzerland
,
resellerId (integer, optional):
reseller id
integerMax. Value:2147483647
,
mainContactEmailAddress (string, optional):
email address
,
mainContactFirstName (string, optional):
first name
,
mainContactLastName (string, optional):
last name
,
password (string, optional):
password
,
locale (string, optional):
locale
,
trial (boolean, optional):
is trial light registration
,
companyName (string, optional):
company name
,
companyStreet (string, optional):
company street
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
vatId (string, optional):
vat id
,
companySectorIndustryId (integer, optional):
sector industry id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
companySizeId (integer, optional):
company size id
,
mainContactTitle (string, optional):
main contact title
,
mainContactSalutation (string, optional):
main contact salutation
,
mainContactPhoneNumber (string, optional):
main contact phone number
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
invoicingCompanyName (string, optional):
invoicing company name
,
invoicingCompanyStreet (string, optional):
invoicing company street
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
paymentMethod (string, optional):
payment method
,
newsletters (boolean, optional):
accepts newsletters
,
confirmedAgbRead (boolean, optional):
confirmed agb read
,
voucherCode (string, optional):
voucher code
,
origin (string, optional):
origin
,
shoppingCart (ShoppingCartRequest, optional):
shopping cart
,
gaClientId (string, optional):
gaClientId
,
id (string, optional):
registration id (encrypted)
,
status (string):
status
,
links (Array[Link], optional):
links
,
eInvoiceEmailAddress (string, optional):
einvoice email address
}
ShoppingCartRequest {
basePackage (string, optional):
base package
stringReg.
Exp.:^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$
,
addonPackages (Array[string], optional):
addon packages
,
paymentPlan (string, optional)
stringReg. Exp.:^(?i)(yearly|monthly|null)$
}
Link {
rel (string, optional),
href (string, optional)
}
{
"siteId": 0,
"resellerId": 0,
"mainContactEmailAddress": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"password": "string",
"locale": "string",
"trial": true,
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"vatId": "string",
"companySectorIndustryId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"companySizeId": 0,
"mainContactTitle": "string",
"mainContactSalutation": "string",
"mainContactPhoneNumber": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"bankAccept": true,
"paymentMethod": "string",
"newsletters": true,
"confirmedAgbRead": true,
"voucherCode": "string",
"origin": "string",
"shoppingCart": {
"basePackage": "string",
"addonPackages": [
"string"
],
"paymentPlan": "string"
},
"gaClientId": "string",
"id": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"eInvoiceEmailAddress": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string body
Parameter content type: application/json
body
* Model
* Model Schema
RegistrationRequest {
siteId (integer, optional):
site id (0 = Unknown/Autodetect, 1 = Austria, 2 = Germany, 3 =
Switzerland, 4 = Italy, 5 = Linkmobility Germany, 6 = Linkmobility SSU
Germany, 7 = Linkmobility SSU Austria, 8 = Linkmobility SSU Switzerland
,
resellerId (integer, optional):
reseller id
integerMax. Value:2147483647
,
mainContactEmailAddress (string, optional):
email address
,
mainContactFirstName (string, optional):
first name
,
mainContactLastName (string, optional):
last name
,
password (string, optional):
password
,
locale (string, optional):
locale
,
trial (boolean, optional):
is trial light registration
,
companyName (string, optional):
company name
,
companyStreet (string, optional):
company street
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
vatId (string, optional):
vat id
,
companySectorIndustryId (integer, optional):
sector industry id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
companySizeId (integer, optional):
company size id
,
mainContactTitle (string, optional):
main contact title
,
mainContactSalutation (string, optional):
main contact salutation
,
mainContactPhoneNumber (string, optional):
main contact phone number
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
invoicingCompanyName (string, optional):
invoicing company name
,
invoicingCompanyStreet (string, optional):
invoicing company street
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
paymentMethod (string, optional):
payment method
,
newsletters (boolean, optional):
accepts newsletters
,
confirmedAgbRead (boolean, optional):
confirmed agb read
,
voucherCode (string, optional):
voucher code
,
origin (string, optional):
origin
,
shoppingCart (ShoppingCartRequest, optional):
shopping cart
,
gaClientId (string, optional):
gaClientId
,
eInvoiceEmailAddress (string, optional):
einvoice email address
}
ShoppingCartRequest {
basePackage (string, optional):
base package
stringReg.
Exp.:^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$
,
addonPackages (Array[string], optional):
addon packages
,
paymentPlan (string, optional)
stringReg. Exp.:^(?i)(yearly|monthly|null)$
}
{
"siteId": 0,
"resellerId": 0,
"mainContactEmailAddress": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"password": "string",
"locale": "string",
"trial": true,
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"vatId": "string",
"companySectorIndustryId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"companySizeId": 0,
"mainContactTitle": "string",
"mainContactSalutation": "string",
"mainContactPhoneNumber": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"bankAccept": true,
"paymentMethod": "string",
"newsletters": true,
"confirmedAgbRead": true,
"voucherCode": "string",
"origin": "string",
"shoppingCart": {
"basePackage": "string",
"addonPackages": [
"string"
],
"paymentPlan": "string"
},
"gaClientId": "string",
"eInvoiceEmailAddress": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/REGISTRATION/{ID}/INITIATE_EMAIL_ADDRESS_VERIFICATION
* Initiates email address verification
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string body
Parameter content type: application/json
body
* Model
* Model Schema
InitiateEmailAddressVerificationRequest {
clientId (string, optional):
clientId
}
{
"clientId": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/REGISTRATION
* Registers new customer
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
RegistrationResponse {
siteId (integer, optional):
site id (0 = Unknown/Autodetect, 1 = Austria, 2 = Germany, 3 =
Switzerland, 4 = Italy, 5 = Linkmobility Germany, 6 = Linkmobility SSU
Germany, 7 = Linkmobility SSU Austria, 8 = Linkmobility SSU Switzerland
,
resellerId (integer, optional):
reseller id
integerMax. Value:2147483647
,
mainContactEmailAddress (string, optional):
email address
,
mainContactFirstName (string, optional):
first name
,
mainContactLastName (string, optional):
last name
,
password (string, optional):
password
,
locale (string, optional):
locale
,
trial (boolean, optional):
is trial light registration
,
companyName (string, optional):
company name
,
companyStreet (string, optional):
company street
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
vatId (string, optional):
vat id
,
companySectorIndustryId (integer, optional):
sector industry id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
companySizeId (integer, optional):
company size id
,
mainContactTitle (string, optional):
main contact title
,
mainContactSalutation (string, optional):
main contact salutation
,
mainContactPhoneNumber (string, optional):
main contact phone number
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
invoicingCompanyName (string, optional):
invoicing company name
,
invoicingCompanyStreet (string, optional):
invoicing company street
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
paymentMethod (string, optional):
payment method
,
newsletters (boolean, optional):
accepts newsletters
,
confirmedAgbRead (boolean, optional):
confirmed agb read
,
voucherCode (string, optional):
voucher code
,
origin (string, optional):
origin
,
shoppingCart (ShoppingCartRequest, optional):
shopping cart
,
gaClientId (string, optional):
gaClientId
,
id (string, optional):
registration id (encrypted)
,
status (string):
status
,
links (Array[Link], optional):
links
,
eInvoiceEmailAddress (string, optional):
einvoice email address
}
ShoppingCartRequest {
basePackage (string, optional):
base package
stringReg.
Exp.:^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$
,
addonPackages (Array[string], optional):
addon packages
,
paymentPlan (string, optional)
stringReg. Exp.:^(?i)(yearly|monthly|null)$
}
Link {
rel (string, optional),
href (string, optional)
}
{
"siteId": 0,
"resellerId": 0,
"mainContactEmailAddress": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"password": "string",
"locale": "string",
"trial": true,
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"vatId": "string",
"companySectorIndustryId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"companySizeId": 0,
"mainContactTitle": "string",
"mainContactSalutation": "string",
"mainContactPhoneNumber": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"bankAccept": true,
"paymentMethod": "string",
"newsletters": true,
"confirmedAgbRead": true,
"voucherCode": "string",
"origin": "string",
"shoppingCart": {
"basePackage": "string",
"addonPackages": [
"string"
],
"paymentPlan": "string"
},
"gaClientId": "string",
"id": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"eInvoiceEmailAddress": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
RegistrationRequest {
siteId (integer, optional):
site id (0 = Unknown/Autodetect, 1 = Austria, 2 = Germany, 3 =
Switzerland, 4 = Italy, 5 = Linkmobility Germany, 6 = Linkmobility SSU
Germany, 7 = Linkmobility SSU Austria, 8 = Linkmobility SSU Switzerland
,
resellerId (integer, optional):
reseller id
integerMax. Value:2147483647
,
mainContactEmailAddress (string, optional):
email address
,
mainContactFirstName (string, optional):
first name
,
mainContactLastName (string, optional):
last name
,
password (string, optional):
password
,
locale (string, optional):
locale
,
trial (boolean, optional):
is trial light registration
,
companyName (string, optional):
company name
,
companyStreet (string, optional):
company street
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
vatId (string, optional):
vat id
,
companySectorIndustryId (integer, optional):
sector industry id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
companySizeId (integer, optional):
company size id
,
mainContactTitle (string, optional):
main contact title
,
mainContactSalutation (string, optional):
main contact salutation
,
mainContactPhoneNumber (string, optional):
main contact phone number
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
invoicingCompanyName (string, optional):
invoicing company name
,
invoicingCompanyStreet (string, optional):
invoicing company street
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
paymentMethod (string, optional):
payment method
,
newsletters (boolean, optional):
accepts newsletters
,
confirmedAgbRead (boolean, optional):
confirmed agb read
,
voucherCode (string, optional):
voucher code
,
origin (string, optional):
origin
,
shoppingCart (ShoppingCartRequest, optional):
shopping cart
,
gaClientId (string, optional):
gaClientId
,
eInvoiceEmailAddress (string, optional):
einvoice email address
}
ShoppingCartRequest {
basePackage (string, optional):
base package
stringReg.
Exp.:^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$
,
addonPackages (Array[string], optional):
addon packages
,
paymentPlan (string, optional)
stringReg. Exp.:^(?i)(yearly|monthly|null)$
}
{
"siteId": 0,
"resellerId": 0,
"mainContactEmailAddress": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"password": "string",
"locale": "string",
"trial": true,
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"vatId": "string",
"companySectorIndustryId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"companySizeId": 0,
"mainContactTitle": "string",
"mainContactSalutation": "string",
"mainContactPhoneNumber": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"bankAccept": true,
"paymentMethod": "string",
"newsletters": true,
"confirmedAgbRead": true,
"voucherCode": "string",
"origin": "string",
"shoppingCart": {
"basePackage": "string",
"addonPackages": [
"string"
],
"paymentPlan": "string"
},
"gaClientId": "string",
"eInvoiceEmailAddress": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/UPGRADE/{TOKEN}
* Returns customer information for Upgrade
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerUpgradeResponse {
companyName (string):
company name
stringReg. Exp.:^([^ ]{1,50})( [^ ]{0,50})?$
,
companyStreet (string):
company street
stringReg. Exp.:^([^ ]{1,50})( [^ ]{0,50})?$
,
companyPostalCode (string):
company postal code
,
companyCity (string):
company city
,
companyCountry (string):
company country
,
vatId (string, optional):
vat id
,
companySectorIndustryId (integer, optional):
sector industry id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
companySizeId (integer, optional):
company size id
,
mainContactTitle (string, optional):
main contact title
,
mainContactSalutation (string):
main contact salutation
,
mainContactFirstName (string):
main contact first name
,
mainContactLastName (string):
contact surname
,
mainContactEmailAddress (string):
main contact email address
,
mainContactPhoneNumber (string, optional):
main contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
invoicingCompanyName (string):
invoicing company name
stringReg. Exp.:^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyStreet (string):
invoicing company street
stringReg. Exp.:^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyZipCode (string):
invoicing company zip code
,
invoicingCompanyCity (string):
invoicing company city
,
invoicingCompanyCountry (string):
invoicing company country
,
geteInvoiceEmailAddress (string):
einvoice email address
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
bankDataLater (boolean, optional):
bank data later
,
newsletters (boolean, optional):
accepts newsletters
,
confirmedAgbRead (boolean):
confirmed agb read
,
voucherCode (string, optional):
voucher code
,
shoppingCart (ShoppingCartRequest, optional):
shopping cart
,
siteId (integer, optional):
site id
,
diallingCodeId (integer, optional):
dialing code
,
customerStatus (string, optional):
customer status
,
links (Array[Link], optional):
links
}
ShoppingCartRequest {
basePackage (string, optional):
base package
stringReg.
Exp.:^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$
,
addonPackages (Array[string], optional):
addon packages
,
paymentPlan (string, optional)
stringReg. Exp.:^(?i)(yearly|monthly|null)$
}
Link {
rel (string, optional),
href (string, optional)
}
{
"companyName": "string",
"companyStreet": "string",
"companyPostalCode": "string",
"companyCity": "string",
"companyCountry": "string",
"vatId": "string",
"companySectorIndustryId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"companySizeId": 0,
"mainContactTitle": "string",
"mainContactSalutation": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"mainContactEmailAddress": "string",
"mainContactPhoneNumber": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"geteInvoiceEmailAddress": "string",
"accountBic": "string",
"accountIban": "string",
"bankAccept": true,
"bankDataLater": true,
"newsletters": true,
"confirmedAgbRead": true,
"voucherCode": "string",
"shoppingCart": {
"basePackage": "string",
"addonPackages": [
"string"
],
"paymentPlan": "string"
},
"siteId": 0,
"diallingCodeId": 0,
"customerStatus": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type token path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad Request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/UPGRADE/{TOKEN}
* Upgrades customer
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerUpgradeRequest {
companyName (string):
company name
stringReg. Exp.:^([^ ]{1,50})( [^ ]{0,50})?$
,
companyStreet (string):
company street
stringReg. Exp.:^([^ ]{1,50})( [^ ]{0,50})?$
,
companyPostalCode (string):
company postal code
,
companyCity (string):
company city
,
companyCountry (string):
company country
,
vatId (string, optional):
vat id
,
companySectorIndustryId (integer, optional):
sector industry id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
companySizeId (integer, optional):
company size id
,
mainContactTitle (string, optional):
main contact title
,
mainContactSalutation (string):
main contact salutation
,
mainContactFirstName (string):
main contact first name
,
mainContactLastName (string):
contact surname
,
mainContactEmailAddress (string):
main contact email address
,
mainContactPhoneNumber (string, optional):
main contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
invoicingCompanyName (string):
invoicing company name
stringReg. Exp.:^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyStreet (string):
invoicing company street
stringReg. Exp.:^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyZipCode (string):
invoicing company zip code
,
invoicingCompanyCity (string):
invoicing company city
,
invoicingCompanyCountry (string):
invoicing company country
,
geteInvoiceEmailAddress (string):
einvoice email address
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
bankDataLater (boolean, optional):
bank data later
,
newsletters (boolean, optional):
accepts newsletters
,
confirmedAgbRead (boolean):
confirmed agb read
,
voucherCode (string, optional):
voucher code
,
shoppingCart (ShoppingCartRequest, optional):
shopping cart
}
ShoppingCartRequest {
basePackage (string, optional):
base package
stringReg.
Exp.:^(?i)(sms|wabBasic|wabBusiness|wabEnterprise|smsEssential|smsBusiness|smsEnterprise|smsFlex|smsStarter|smsSmart|smsBasic|smsStandard|smsAdvanced)$
,
addonPackages (Array[string], optional):
addon packages
,
paymentPlan (string, optional)
stringReg. Exp.:^(?i)(yearly|monthly|null)$
}
{
"companyName": "string",
"companyStreet": "string",
"companyPostalCode": "string",
"companyCity": "string",
"companyCountry": "string",
"vatId": "string",
"companySectorIndustryId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"companySizeId": 0,
"mainContactTitle": "string",
"mainContactSalutation": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"mainContactEmailAddress": "string",
"mainContactPhoneNumber": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"geteInvoiceEmailAddress": "string",
"accountBic": "string",
"accountIban": "string",
"bankAccept": true,
"bankDataLater": true,
"newsletters": true,
"confirmedAgbRead": true,
"voucherCode": "string",
"shoppingCart": {
"basePackage": "string",
"addonPackages": [
"string"
],
"paymentPlan": "string"
}
}
Click to set as parameter value
token path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad Request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/VALIDATORS/VALIDATE_POSTAL_CODE
* Validates postal code
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ValidationResponseDto {
valid (boolean, optional)
}
{
"valid": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
PostalCodeValidationRequestDto {
countryCode (string, optional),
postalCode (string, optional)
}
{
"countryCode": "string",
"postalCode": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/VALIDATORS/VALIDATE_IBAN
* Validates iban
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ValidationResponseDto {
valid (boolean, optional)
}
{
"valid": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
IBANValidationRequestDto {
iban (string, optional)
}
{
"iban": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/VALIDATORS/VALIDATE_VAT_ID
* Validates vat id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ValidationResponseDto {
valid (boolean, optional)
}
{
"valid": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
VatValidationRequestDto {
countryCode (string, optional),
vatId (string, optional)
}
{
"countryCode": "string",
"vatId": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/VALIDATORS/VALIDATE_BIC
* Validates bic
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ValidationResponseDto {
valid (boolean, optional)
}
{
"valid": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
BICValidationRequestDto {
bic (string, optional),
iban (string, optional)
}
{
"bic": "string",
"iban": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INFO/USE_CASES
* Returns list of use cases
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
UseCaseResponse
]
UseCaseResponse {
id (integer, optional):
id
,
useCase (string, optional):
use case
}
[
{
"id": 0,
"useCase": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INFO/COMPANY_SIZES
* Returns list of company sizes
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
CompanySizeResponse
]
CompanySizeResponse {
id (integer, optional):
id
,
companySize (string, optional):
company size
}
[
{
"id": 0,
"companySize": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INFO/MESSAGE_SUMMARY
* Returns message summary
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MessageSummaryResponse {
inboxTotal (integer):
number of inbox messages
,
inboxUnread (integer):
number of unread inbox messages
,
archiveTotal (integer):
number of archive messages
,
outboxTotal (integer):
number of outbox messages
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"inboxTotal": 0,
"inboxUnread": 0,
"archiveTotal": 0,
"outboxTotal": 0,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INFO/DIALLING_CODES
* Returns list of dialling codes
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DiallingCodeResponse
]
DiallingCodeResponse {
value (integer, optional):
value
,
country (string, optional):
name of the country
,
iso2 (string, optional):
two letter country code
,
iso3 (string, optional):
three letter country code
}
[
{
"value": 0,
"country": "string",
"iso2": "string",
"iso3": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INFO/PLACEHOLDERS
* Returns supported placeholders
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
string
]
[
"string"
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INFO/DELIVERY_DETAILS/SELECTORS
* Returns available delivery details selectors
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
string
]
[
"string"
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INFO/STATISTIC/SELECTORS
* Returns available statistic selectors
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
string
]
[
"string"
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INFO/CONTACTS/SELECTORS
* Returns available contacts selectors
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
string
]
[
"string"
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/INFO/SECTOR_INDUSTRIES
* Returns list of sectors and industries
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
SectorIndustryResponse
]
SectorIndustryResponse {
id (integer, optional):
id
,
sector (string, optional):
name of the sector
,
industry (string, optional):
name of the industry
}
[
{
"id": 0,
"sector": "string",
"industry": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/STATISTICS/{SELECTOR}
* Returns statistics for the customer
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageStatisticResponse
]
MessageStatisticResponse {
intervalStart (string):
interval start time
,
intervalEnd (string):
interval end time
,
smsAmount (integer):
amount of SMS messages sent
,
pushAmount (integer):
amount of push messages sent
,
voiceAmount (integer):
amount of voice messages sent
,
whatsappAmount (integer):
amount of whatsapp messages sent
,
total (integer):
total messages sent
}
[
{
"intervalStart": "2024-06-20T13:22:51.853Z",
"intervalEnd": "2024-06-20T13:22:51.853Z",
"smsAmount": 0,
"pushAmount": 0,
"voiceAmount": 0,
"whatsappAmount": 0,
"total": 0
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/STATISTICS
* Returns statistics for the customer
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageStatisticResponse
]
MessageStatisticResponse {
intervalStart (string):
interval start time
,
intervalEnd (string):
interval end time
,
smsAmount (integer):
amount of SMS messages sent
,
pushAmount (integer):
amount of push messages sent
,
voiceAmount (integer):
amount of voice messages sent
,
whatsappAmount (integer):
amount of whatsapp messages sent
,
total (integer):
total messages sent
}
[
{
"intervalStart": "2024-06-20T13:22:51.854Z",
"intervalEnd": "2024-06-20T13:22:51.854Z",
"smsAmount": 0,
"pushAmount": 0,
"voiceAmount": 0,
"whatsappAmount": 0,
"total": 0
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type filter
Filter
query string regionCode
Region Code
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}
* Returns delivery details for customer
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeliveryDetailResponse
]
DeliveryDetailResponse {
id (integer):
monthly record id
,
sentOn (string):
sent on
,
recipient (string):
recipient
,
sender (string):
sender
,
messageType (string):
message type
,
username (string):
username
,
productId (integer, optional):
product id
,
productName (string, optional):
product name
,
origin (string, optional):
message origin
= ['api_http', 'api_http_simple', 'api_rest', 'api_rest_simple',
'api_rest_converged', 'api_rest_customer_channel', 'api_smpp',
'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp', 'sdk_perl',
'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php', 'api_smtp_email2sms',
'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
detail (string, optional):
detail
,
message (string, optional):
message
,
statusOn (string, optional):
status on (date of delivery state)
,
status (string, optional):
delivery state
,
deliveryReport (boolean, optional):
delivery report requested
,
contentCategory (string, optional):
contentCategory
,
directionType (string, optional):
directionType
,
links (Array[Link], optional):
links
,
recipientContact (ContactResponse, optional):
recipient contact details, if available
,
product (ProductResponse, optional):
product
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
ProductResponse {
id (integer, optional):
product id
,
name (string, optional):
name
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"sentOn": "2024-06-20T13:22:51.855Z",
"recipient": "string",
"sender": "string",
"messageType": "string",
"username": "string",
"productId": 0,
"productName": "string",
"origin": "api_http",
"detail": "string",
"message": "string",
"statusOn": "2024-06-20T13:22:51.855Z",
"status": "string",
"deliveryReport": true,
"contentCategory": "string",
"directionType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"recipientContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.855Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.855Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"product": {
"id": 0,
"name": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS
* Returns delivery details for customer
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeliveryDetailResponse
]
DeliveryDetailResponse {
id (integer):
monthly record id
,
sentOn (string):
sent on
,
recipient (string):
recipient
,
sender (string):
sender
,
messageType (string):
message type
,
username (string):
username
,
productId (integer, optional):
product id
,
productName (string, optional):
product name
,
origin (string, optional):
message origin
= ['api_http', 'api_http_simple', 'api_rest', 'api_rest_simple',
'api_rest_converged', 'api_rest_customer_channel', 'api_smpp',
'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp', 'sdk_perl',
'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php', 'api_smtp_email2sms',
'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
detail (string, optional):
detail
,
message (string, optional):
message
,
statusOn (string, optional):
status on (date of delivery state)
,
status (string, optional):
delivery state
,
deliveryReport (boolean, optional):
delivery report requested
,
contentCategory (string, optional):
contentCategory
,
directionType (string, optional):
directionType
,
links (Array[Link], optional):
links
,
recipientContact (ContactResponse, optional):
recipient contact details, if available
,
product (ProductResponse, optional):
product
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
ProductResponse {
id (integer, optional):
product id
,
name (string, optional):
name
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"sentOn": "2024-06-20T13:22:51.857Z",
"recipient": "string",
"sender": "string",
"messageType": "string",
"username": "string",
"productId": 0,
"productName": "string",
"origin": "api_http",
"detail": "string",
"message": "string",
"statusOn": "2024-06-20T13:22:51.857Z",
"status": "string",
"deliveryReport": true,
"contentCategory": "string",
"directionType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"recipientContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.857Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.857Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"product": {
"id": 0,
"name": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer search
Search string
query string filters
Filters
query string regionCodes
Region Codes
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad Request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/EXPORT
* Exports delivery details for the customer
PARAMETERS
Parameter Value Description Parameter Type Data Type format
Export format (pdf, csv, xsl)
query string page
Request a specific page
query integer size
Sets size of a page
query integer search
Search string
query string filters
Filters
query string regionCodes
Region Codes
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT
* Exports delivery details for the customer
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
format
Export format (pdf, csv, xsl)
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CUSTOMER/DELIVERY_DETAILS/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DeliveryDetailsExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
filters (string, optional):
Filters
,
regionCodes (string, optional):
Region Codes
,
search (string, optional):
Search
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"filters": "string",
"regionCodes": "string",
"search": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DeliveryDetailsExportRequestDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
filters (string, optional):
Filters
,
regionCodes (string, optional):
Region Codes
,
search (string, optional):
Search
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"filters": "string",
"regionCodes": "string",
"search": "string"
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS
* Returns export tasks
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS
* Creates and executes export task
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS/{TASKID}
* Returns export task
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/CUSTOMER/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task for account
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT/TASKS/{TASKID}
* Returns export task for account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/ACCOUNTS
* Returns accounts for customer
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MinimalAccountResponse {
id (integer, optional):
account id
,
username (string, optional):
user
,
active (boolean, optional):
active
}
{
"id": 0,
"username": "string",
"active": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER
* Returns customer information for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerResponse {
signature (string, optional):
signature
,
optInCssUrl (string, optional):
optin css url
,
optInCssContent (string, optional):
optin css content
,
id (integer, optional):
customer id
,
companyName (string, optional):
company name
,
diallingCodeId (integer, optional):
dialing code
,
siteId (integer, optional):
site id
,
locale (string, optional):
site id locale
,
trial (boolean, optional):
trial customer
,
upgradeUrl (string, optional):
trial customer upgrade url
,
status (string, optional):
status
,
links (Array[Link], optional):
links
,
validContractPayment (boolean, optional):
has valid contract payment?
,
accountManager (AccountManagerResponse, optional):
accountManager
}
Link {
rel (string, optional),
href (string, optional)
}
AccountManagerResponse {
id (integer, optional):
id
,
firstname (string, optional):
firstname
,
surname (string, optional):
surname
}
{
"signature": "string",
"optInCssUrl": "string",
"optInCssContent": "string",
"id": 0,
"companyName": "string",
"diallingCodeId": 0,
"siteId": 0,
"locale": "string",
"trial": true,
"upgradeUrl": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"validContractPayment": true,
"accountManager": {
"id": 0,
"firstname": "string",
"surname": "string"
}
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CUSTOMER
* Updates customer information/settings
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerResponse {
signature (string, optional):
signature
,
optInCssUrl (string, optional):
optin css url
,
optInCssContent (string, optional):
optin css content
,
id (integer, optional):
customer id
,
companyName (string, optional):
company name
,
diallingCodeId (integer, optional):
dialing code
,
siteId (integer, optional):
site id
,
locale (string, optional):
site id locale
,
trial (boolean, optional):
trial customer
,
upgradeUrl (string, optional):
trial customer upgrade url
,
status (string, optional):
status
,
links (Array[Link], optional):
links
,
validContractPayment (boolean, optional):
has valid contract payment?
,
accountManager (AccountManagerResponse, optional):
accountManager
}
Link {
rel (string, optional),
href (string, optional)
}
AccountManagerResponse {
id (integer, optional):
id
,
firstname (string, optional):
firstname
,
surname (string, optional):
surname
}
{
"signature": "string",
"optInCssUrl": "string",
"optInCssContent": "string",
"id": 0,
"companyName": "string",
"diallingCodeId": 0,
"siteId": 0,
"locale": "string",
"trial": true,
"upgradeUrl": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"validContractPayment": true,
"accountManager": {
"id": 0,
"firstname": "string",
"surname": "string"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerRequest {
signature (string, optional):
signature
,
optInCssUrl (string, optional):
optin css url
,
optInCssContent (string, optional):
optin css content
}
{
"signature": "string",
"optInCssUrl": "string",
"optInCssContent": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/STATISTICS/ACCOUNTS
* Returns statistics for the customer grouped by accounts
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageStatisticGroupedByAccountResponse
]
MessageStatisticGroupedByAccountResponse {
intervalStart (string):
interval start time
,
intervalEnd (string):
interval end time
,
smsAmount (integer):
amount of SMS messages sent
,
pushAmount (integer):
amount of push messages sent
,
voiceAmount (integer):
amount of voice messages sent
,
whatsappAmount (integer):
amount of whatsapp messages sent
,
total (integer):
total messages sent
,
account (MinimalAccountResponse, optional)
}
MinimalAccountResponse {
id (integer, optional):
account id
,
username (string, optional):
user
,
active (boolean, optional):
active
}
[
{
"intervalStart": "2024-06-20T13:22:51.883Z",
"intervalEnd": "2024-06-20T13:22:51.883Z",
"smsAmount": 0,
"pushAmount": 0,
"voiceAmount": 0,
"whatsappAmount": 0,
"total": 0,
"account": {
"id": 0,
"username": "string",
"active": true
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type filter
Filter
query string regionCode
Region Code
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/STATISTICS/ACCOUNTS/{ID}
* Returns statistics for the account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageStatisticResponse
]
MessageStatisticResponse {
intervalStart (string):
interval start time
,
intervalEnd (string):
interval end time
,
smsAmount (integer):
amount of SMS messages sent
,
pushAmount (integer):
amount of push messages sent
,
voiceAmount (integer):
amount of voice messages sent
,
whatsappAmount (integer):
amount of whatsapp messages sent
,
total (integer):
total messages sent
}
[
{
"intervalStart": "2024-06-20T13:22:51.885Z",
"intervalEnd": "2024-06-20T13:22:51.885Z",
"smsAmount": 0,
"pushAmount": 0,
"voiceAmount": 0,
"whatsappAmount": 0,
"total": 0
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
filter
Filter
query string regionCode
Region Code
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}
* Returns delivery details for the account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeliveryDetailResponse
]
DeliveryDetailResponse {
id (integer):
monthly record id
,
sentOn (string):
sent on
,
recipient (string):
recipient
,
sender (string):
sender
,
messageType (string):
message type
,
username (string):
username
,
productId (integer, optional):
product id
,
productName (string, optional):
product name
,
origin (string, optional):
message origin
= ['api_http', 'api_http_simple', 'api_rest', 'api_rest_simple',
'api_rest_converged', 'api_rest_customer_channel', 'api_smpp',
'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp', 'sdk_perl',
'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php', 'api_smtp_email2sms',
'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
detail (string, optional):
detail
,
message (string, optional):
message
,
statusOn (string, optional):
status on (date of delivery state)
,
status (string, optional):
delivery state
,
deliveryReport (boolean, optional):
delivery report requested
,
contentCategory (string, optional):
contentCategory
,
directionType (string, optional):
directionType
,
links (Array[Link], optional):
links
,
recipientContact (ContactResponse, optional):
recipient contact details, if available
,
product (ProductResponse, optional):
product
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
ProductResponse {
id (integer, optional):
product id
,
name (string, optional):
name
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"sentOn": "2024-06-20T13:22:51.886Z",
"recipient": "string",
"sender": "string",
"messageType": "string",
"username": "string",
"productId": 0,
"productName": "string",
"origin": "api_http",
"detail": "string",
"message": "string",
"statusOn": "2024-06-20T13:22:51.886Z",
"status": "string",
"deliveryReport": true,
"contentCategory": "string",
"directionType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"recipientContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.886Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.886Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"product": {
"id": 0,
"name": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer search
Search string
query string filters
Filters
query string regionCodes
Region Codes
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad Request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/CONTACT_PERSON
* Returns customer contact person for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContactPersonResponse {
mainContactSalutation (string, optional):
main contact salutation
,
mainContactTitle (string, optional):
main contact title
,
mainContactFirstName (string, optional):
main contact first name
,
mainContactLastName (string, optional):
main contact last name
,
mainContactPhoneNumber (string, optional):
main contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
mainContactEmailAddress (string, optional):
main contact email address
,
techContactSalutation (string, optional):
tech contact salutation
,
techContactTitle (string, optional):
tech contact title
,
techContactFirstName (string, optional):
tech contact first name
,
techContactLastName (string, optional):
contact last name
,
techContactPhoneNumber (string, optional):
contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
techContactEmailAddress (string, optional):
contact email address
,
adminContactSalutation (string, optional):
admin contact salutation
,
adminContactTitle (string, optional):
admin contact title
,
adminContactFirstName (string, optional):
admin contact first name
,
adminContactLastName (string, optional):
admin contact last name
,
adminContactPhoneNumber (string, optional):
admin contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
adminContactEmailAddress (string, optional):
admin contact email address
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
commercialContactPhoneNumber (string, optional):
commercial contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
commercialContactEmailAddress (string, optional):
commercial contact email address
,
marketingContactSalutation (string, optional):
marketing contact salutation
,
marketingContactTitle (string, optional):
marketing contact title
,
marketingContactFirstName (string, optional):
marketing contact first name
,
marketingContactLastName (string, optional):
marketing contact last name
,
marketingContactPhoneNumber (string, optional):
marketing contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
marketingContactEmailAddress (string, optional):
marketing contact email address
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"mainContactSalutation": "string",
"mainContactTitle": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"mainContactPhoneNumber": "string",
"mainContactEmailAddress": "string",
"techContactSalutation": "string",
"techContactTitle": "string",
"techContactFirstName": "string",
"techContactLastName": "string",
"techContactPhoneNumber": "string",
"techContactEmailAddress": "string",
"adminContactSalutation": "string",
"adminContactTitle": "string",
"adminContactFirstName": "string",
"adminContactLastName": "string",
"adminContactPhoneNumber": "string",
"adminContactEmailAddress": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"commercialContactPhoneNumber": "string",
"commercialContactEmailAddress": "string",
"marketingContactSalutation": "string",
"marketingContactTitle": "string",
"marketingContactFirstName": "string",
"marketingContactLastName": "string",
"marketingContactPhoneNumber": "string",
"marketingContactEmailAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CUSTOMER/CONTACT_PERSON
* Updates customer contact person
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContactPersonResponse {
mainContactSalutation (string, optional):
main contact salutation
,
mainContactTitle (string, optional):
main contact title
,
mainContactFirstName (string, optional):
main contact first name
,
mainContactLastName (string, optional):
main contact last name
,
mainContactPhoneNumber (string, optional):
main contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
mainContactEmailAddress (string, optional):
main contact email address
,
techContactSalutation (string, optional):
tech contact salutation
,
techContactTitle (string, optional):
tech contact title
,
techContactFirstName (string, optional):
tech contact first name
,
techContactLastName (string, optional):
contact last name
,
techContactPhoneNumber (string, optional):
contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
techContactEmailAddress (string, optional):
contact email address
,
adminContactSalutation (string, optional):
admin contact salutation
,
adminContactTitle (string, optional):
admin contact title
,
adminContactFirstName (string, optional):
admin contact first name
,
adminContactLastName (string, optional):
admin contact last name
,
adminContactPhoneNumber (string, optional):
admin contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
adminContactEmailAddress (string, optional):
admin contact email address
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
commercialContactPhoneNumber (string, optional):
commercial contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
commercialContactEmailAddress (string, optional):
commercial contact email address
,
marketingContactSalutation (string, optional):
marketing contact salutation
,
marketingContactTitle (string, optional):
marketing contact title
,
marketingContactFirstName (string, optional):
marketing contact first name
,
marketingContactLastName (string, optional):
marketing contact last name
,
marketingContactPhoneNumber (string, optional):
marketing contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
marketingContactEmailAddress (string, optional):
marketing contact email address
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"mainContactSalutation": "string",
"mainContactTitle": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"mainContactPhoneNumber": "string",
"mainContactEmailAddress": "string",
"techContactSalutation": "string",
"techContactTitle": "string",
"techContactFirstName": "string",
"techContactLastName": "string",
"techContactPhoneNumber": "string",
"techContactEmailAddress": "string",
"adminContactSalutation": "string",
"adminContactTitle": "string",
"adminContactFirstName": "string",
"adminContactLastName": "string",
"adminContactPhoneNumber": "string",
"adminContactEmailAddress": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"commercialContactPhoneNumber": "string",
"commercialContactEmailAddress": "string",
"marketingContactSalutation": "string",
"marketingContactTitle": "string",
"marketingContactFirstName": "string",
"marketingContactLastName": "string",
"marketingContactPhoneNumber": "string",
"marketingContactEmailAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerContactPersonRequest {
mainContactSalutation (string, optional):
main contact salutation
,
mainContactTitle (string, optional):
main contact title
,
mainContactFirstName (string, optional):
main contact first name
,
mainContactLastName (string, optional):
main contact last name
,
mainContactPhoneNumber (string, optional):
main contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
mainContactEmailAddress (string, optional):
main contact email address
,
techContactSalutation (string, optional):
tech contact salutation
,
techContactTitle (string, optional):
tech contact title
,
techContactFirstName (string, optional):
tech contact first name
,
techContactLastName (string, optional):
contact last name
,
techContactPhoneNumber (string, optional):
contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
techContactEmailAddress (string, optional):
contact email address
,
adminContactSalutation (string, optional):
admin contact salutation
,
adminContactTitle (string, optional):
admin contact title
,
adminContactFirstName (string, optional):
admin contact first name
,
adminContactLastName (string, optional):
admin contact last name
,
adminContactPhoneNumber (string, optional):
admin contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
adminContactEmailAddress (string, optional):
admin contact email address
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
commercialContactPhoneNumber (string, optional):
commercial contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
commercialContactEmailAddress (string, optional):
commercial contact email address
,
marketingContactSalutation (string, optional):
marketing contact salutation
,
marketingContactTitle (string, optional):
marketing contact title
,
marketingContactFirstName (string, optional):
marketing contact first name
,
marketingContactLastName (string, optional):
marketing contact last name
,
marketingContactPhoneNumber (string, optional):
marketing contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
marketingContactEmailAddress (string, optional):
marketing contact email address
}
{
"mainContactSalutation": "string",
"mainContactTitle": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"mainContactPhoneNumber": "string",
"mainContactEmailAddress": "string",
"techContactSalutation": "string",
"techContactTitle": "string",
"techContactFirstName": "string",
"techContactLastName": "string",
"techContactPhoneNumber": "string",
"techContactEmailAddress": "string",
"adminContactSalutation": "string",
"adminContactTitle": "string",
"adminContactFirstName": "string",
"adminContactLastName": "string",
"adminContactPhoneNumber": "string",
"adminContactEmailAddress": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"commercialContactPhoneNumber": "string",
"commercialContactEmailAddress": "string",
"marketingContactSalutation": "string",
"marketingContactTitle": "string",
"marketingContactFirstName": "string",
"marketingContactLastName": "string",
"marketingContactPhoneNumber": "string",
"marketingContactEmailAddress": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 403
Update forbidden
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/CONTRACT_DETAIL
* Returns customer contract detail for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContractDetailResponse {
companyName (string, optional):
company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyStreet (string, optional):
company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
companySectorIndustryId (integer, optional):
sector industry id
,
companySizeId (integer, optional):
company size id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
invoicingCompanyName (string, optional):
invoicing company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyStreet (string, optional):
invoicing company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
invoiceRecipient (string, optional):
invoice recipient
,
geteInvoiceEmailAddress (string, optional):
einvoice email address
,
iseInvoiceEnabled (boolean, optional):
einvoice enabled
,
directDebitEnabled (boolean, optional):
direct debit enabled
,
vatId (string, optional):
vat id
,
links (Array[Link], optional):
links
,
changeRequest (CustomerContractDetailResponse, optional):
change request
}
Link {
rel (string, optional),
href (string, optional)
}
{
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"companySectorIndustryId": 0,
"companySizeId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"invoiceRecipient": "string",
"geteInvoiceEmailAddress": "string",
"iseInvoiceEnabled": true,
"directDebitEnabled": true,
"vatId": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"changeRequest": {}
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CUSTOMER/CONTRACT_DETAIL
* Updates customer contract detail
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContractDetailResponse {
companyName (string, optional):
company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyStreet (string, optional):
company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
companySectorIndustryId (integer, optional):
sector industry id
,
companySizeId (integer, optional):
company size id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
invoicingCompanyName (string, optional):
invoicing company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyStreet (string, optional):
invoicing company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
invoiceRecipient (string, optional):
invoice recipient
,
geteInvoiceEmailAddress (string, optional):
einvoice email address
,
iseInvoiceEnabled (boolean, optional):
einvoice enabled
,
directDebitEnabled (boolean, optional):
direct debit enabled
,
vatId (string, optional):
vat id
,
links (Array[Link], optional):
links
,
changeRequest (CustomerContractDetailResponse, optional):
change request
}
Link {
rel (string, optional),
href (string, optional)
}
{
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"companySectorIndustryId": 0,
"companySizeId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"invoiceRecipient": "string",
"geteInvoiceEmailAddress": "string",
"iseInvoiceEnabled": true,
"directDebitEnabled": true,
"vatId": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"changeRequest": {}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerContractDetailRequest {
companyName (string, optional):
company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyStreet (string, optional):
company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
companySectorIndustryId (integer, optional):
sector industry id
,
companySizeId (integer, optional):
company size id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
invoicingCompanyName (string, optional):
invoicing company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyStreet (string, optional):
invoicing company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
invoiceRecipient (string, optional):
invoice recipient
,
geteInvoiceEmailAddress (string, optional):
einvoice email address
,
iseInvoiceEnabled (boolean, optional):
einvoice enabled
,
directDebitEnabled (boolean, optional):
direct debit enabled
,
vatId (string, optional):
vat id
}
{
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"companySectorIndustryId": 0,
"companySizeId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"invoiceRecipient": "string",
"geteInvoiceEmailAddress": "string",
"iseInvoiceEnabled": true,
"directDebitEnabled": true,
"vatId": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 403
Update forbidden
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/CONTRACT_DETAIL/CHANGE_REQUEST
* Returns customer contract detail change request for the authenticated
user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContractDetailResponse {
companyName (string, optional):
company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyStreet (string, optional):
company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
companySectorIndustryId (integer, optional):
sector industry id
,
companySizeId (integer, optional):
company size id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
invoicingCompanyName (string, optional):
invoicing company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyStreet (string, optional):
invoicing company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
invoiceRecipient (string, optional):
invoice recipient
,
geteInvoiceEmailAddress (string, optional):
einvoice email address
,
iseInvoiceEnabled (boolean, optional):
einvoice enabled
,
directDebitEnabled (boolean, optional):
direct debit enabled
,
vatId (string, optional):
vat id
,
links (Array[Link], optional):
links
,
changeRequest (CustomerContractDetailResponse, optional):
change request
}
Link {
rel (string, optional),
href (string, optional)
}
{
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"companySectorIndustryId": 0,
"companySizeId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"invoiceRecipient": "string",
"geteInvoiceEmailAddress": "string",
"iseInvoiceEnabled": true,
"directDebitEnabled": true,
"vatId": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"changeRequest": {}
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/CONTRACT_PAYMENT
* Returns customer contract payment for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContractPaymentResponse {
paymentMethod (string, optional):
payment method
,
valid (boolean, optional):
payment method valid?
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"paymentMethod": "string",
"valid": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CUSTOMER/CONTRACT_PAYMENT
* Updates customer contract payment
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContractPaymentResponse {
paymentMethod (string, optional):
payment method
,
valid (boolean, optional):
payment method valid?
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"paymentMethod": "string",
"valid": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerContractPaymentRequest {
paymentMethod (string, optional):
payment method
}
{
"paymentMethod": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 403
Update forbidden
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CUSTOMER/CONTRACT_PAYMENT/CC/ORDER
* Adds contract payment order
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CcContractPaymentOrderResponseDto {
orderId (string, optional),
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"orderId": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/CONTRACT_PAYMENT/CC
* Returns customer contract payment cc details for the authenticated
user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CcPaymentApprovalResponse {
expirationMonth (integer, optional):
expirationMonth
,
expirationYear (integer, optional):
expirationYear
,
cardType (string, optional):
cardType
,
firstName (string, optional):
firstName
,
lastName (string, optional):
lastName
,
maskedAccountNumber (string, optional):
maskedAccountNumber
,
provider (string, optional):
provider
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"expirationMonth": 0,
"expirationYear": 0,
"cardType": "string",
"firstName": "string",
"lastName": "string",
"maskedAccountNumber": "string",
"provider": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/CONTRACT_PAYMENT/SEPA
* Returns customer contract payment sepa details for the authenticated
user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SepaPaymentApprovalResponse {
accountIban (string, optional):
account iban
,
accountBic (string, optional):
account bic
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountIban": "string",
"accountBic": "string",
"bankAccept": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/CUSTOMER/CONTRACT_PAYMENT/SEPA
* Updates customer contract payment sepa
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SepaPaymentApprovalResponse {
accountIban (string, optional):
account iban
,
accountBic (string, optional):
account bic
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountIban": "string",
"accountBic": "string",
"bankAccept": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
SepaPaymentApprovalRequest {
accountIban (string, optional):
account iban
,
accountBic (string, optional):
account bic
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
}
{
"accountIban": "string",
"accountBic": "string",
"bankAccept": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 403
Update forbidden
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/VOUCHERS
* Returns vouchers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
VoucherResponse
]
VoucherResponse {
type (string, optional):
voucher type
,
id (integer, optional):
voucher id
,
code (string, optional):
voucher code
,
redemptionUrl (string, optional):
redemption url
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"type": "string",
"id": 0,
"code": "string",
"redemptionUrl": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CUSTOMER/VOUCHERS
* Adds voucher
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
VoucherResponse {
type (string, optional):
voucher type
,
id (integer, optional):
voucher id
,
code (string, optional):
voucher code
,
redemptionUrl (string, optional):
redemption url
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"id": 0,
"code": "string",
"redemptionUrl": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
VoucherRequest {
type (string, optional):
voucher type
}
{
"type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 201
Created
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT
* Exports delivery details for the account
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
format
Export format (pdf, csv, xsl)
query string page
Request a specific page
query integer size
Sets size of a page
query integer search
Search string
query string filters
Filters
query string regionCodes
Region Codes
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT/TASKS
* Returns export tasks for account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT/TASKS
* Creates and executes export task for account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DeliveryDetailsExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
filters (string, optional):
Filters
,
regionCodes (string, optional):
Region Codes
,
search (string, optional):
Search
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"filters": "string",
"regionCodes": "string",
"search": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
DeliveryDetailsExportRequestDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
filters (string, optional):
Filters
,
regionCodes (string, optional):
Region Codes
,
search (string, optional):
Search
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"filters": "string",
"regionCodes": "string",
"search": "string"
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CUSTOMER/INITIATE_UPGRADE
* Initiates customer upgrade
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
InitiateUpgradeRequest {
mobile (string, optional):
mobile
stringReg. Exp.:\+[0-9]{1,15}
}
{
"mobile": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CUSTOMER/CONFIRM_UPGRADE
* Confirm customer upgrade
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ConfirmUpgradeRequestDto {
secret (string):
secret
}
{
"secret": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/NOTIFICATIONS
* Returns notifications
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
NotificationResponse
]
NotificationResponse {
id (integer):
notification id
,
type (string):
type
,
priority (string):
priority
,
sticky (boolean):
sticky
,
content (string):
content
,
read (boolean):
read?
,
created (string):
creation date
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"id": 0,
"type": "string",
"priority": "string",
"sticky": true,
"content": "string",
"read": true,
"created": "2024-06-20T13:22:51.927Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT
* Returns account information for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AccountResponse {
signature (string, optional):
signature
,
signatureEnabled (boolean, optional):
signature enabled?
,
defaultMsisdn (string, optional):
default MSISDN
,
messageLimit (integer, optional):
message limit for timegap
,
messageLimitTimegap (string, optional):
limit timegap (hour, day, week, month, year)
,
id (integer, optional):
account id
,
username (string, optional):
username
,
role (string, optional):
role
,
smtpEnabled (boolean, optional):
SMTP enabled
,
whatsappEnabled (boolean, optional):
Whatsapp enabled
,
whatsappAdmin (boolean, optional):
Whatsapp admin
,
smsEnabled (boolean, optional):
Sms enabled
,
urlshortenerEnabled (boolean, optional):
Urlshortener enabled
,
smtpWhitelist (Array[string], optional):
SMTP whitelist
,
remoteSms (string, optional):
remote SMS
,
httpForwardingAddress (string, optional):
HTTP forwarding address
,
smtpForwardingAddress (string, optional):
SMTP forwarding address
,
sentMessagesInTimegap (integer, optional):
Sent messages in timegap
,
freeMessages (integer, optional):
Free messages
,
active (boolean, optional):
active
,
locale (string, optional):
set language locale
,
contentCategory (string, optional):
content category
,
verifiedMsisdn (string, optional):
verified msisdn
,
urlshorteningTypeWhatsapp (string, optional):
urlshortening type whatsapp
,
urlshorteningTypeSms (string, optional):
urlshortening type sms
,
handleMoStop (boolean, optional):
handle mo stop?
,
smppEnabled (boolean, optional):
smpp enabled?
,
smsBoxEnabled (boolean, optional):
smsbox enabled?
,
serviceAssistantEnabled (boolean, optional):
service assistant enabled?
,
atmsCustomerFunctionsEnabled (boolean, optional):
atms customer functions enabled?
,
simplesmsCustomerFunctionsEnabled (boolean, optional):
simplesms customer functions enabled?
,
messengerEnabled (boolean, optional):
messenger functions enabled?
,
bulkEnabled (boolean, optional):
bulk functions enabled?
,
wabConfigured (boolean, optional):
wab configured?
,
use16BitReference (boolean, optional):
use 16bit reference?
,
convergedEnabled (boolean, optional):
converged enabled?
,
hlrEnabled (boolean, optional):
hlr enabled?
,
mfaEnabled (boolean, optional):
mfaEnabled
,
links (Array[Link], optional):
links
,
customer (CustomerResponse, optional):
customer
,
changeRequest (AccountResponse, optional):
change request
,
onboardingStatus (string, optional):
onboardingStatus
}
Link {
rel (string, optional),
href (string, optional)
}
CustomerResponse {
signature (string, optional):
signature
,
optInCssUrl (string, optional):
optin css url
,
optInCssContent (string, optional):
optin css content
,
id (integer, optional):
customer id
,
companyName (string, optional):
company name
,
diallingCodeId (integer, optional):
dialing code
,
siteId (integer, optional):
site id
,
locale (string, optional):
site id locale
,
trial (boolean, optional):
trial customer
,
upgradeUrl (string, optional):
trial customer upgrade url
,
status (string, optional):
status
,
links (Array[Link], optional):
links
,
validContractPayment (boolean, optional):
has valid contract payment?
,
accountManager (AccountManagerResponse, optional):
accountManager
}
AccountManagerResponse {
id (integer, optional):
id
,
firstname (string, optional):
firstname
,
surname (string, optional):
surname
}
{
"signature": "string",
"signatureEnabled": true,
"defaultMsisdn": "string",
"messageLimit": 0,
"messageLimitTimegap": "string",
"id": 0,
"username": "string",
"role": "string",
"smtpEnabled": true,
"whatsappEnabled": true,
"whatsappAdmin": true,
"smsEnabled": true,
"urlshortenerEnabled": true,
"smtpWhitelist": [
"string"
],
"remoteSms": "string",
"httpForwardingAddress": "string",
"smtpForwardingAddress": "string",
"sentMessagesInTimegap": 0,
"freeMessages": 0,
"active": true,
"locale": "string",
"contentCategory": "string",
"verifiedMsisdn": "string",
"urlshorteningTypeWhatsapp": "string",
"urlshorteningTypeSms": "string",
"handleMoStop": true,
"smppEnabled": true,
"smsBoxEnabled": true,
"serviceAssistantEnabled": true,
"atmsCustomerFunctionsEnabled": true,
"simplesmsCustomerFunctionsEnabled": true,
"messengerEnabled": true,
"bulkEnabled": true,
"wabConfigured": true,
"use16BitReference": true,
"convergedEnabled": true,
"hlrEnabled": true,
"mfaEnabled": true,
"links": [
{
"rel": "string",
"href": "string"
}
],
"customer": {
"signature": "string",
"optInCssUrl": "string",
"optInCssContent": "string",
"id": 0,
"companyName": "string",
"diallingCodeId": 0,
"siteId": 0,
"locale": "string",
"trial": true,
"upgradeUrl": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"validContractPayment": true,
"accountManager": {
"id": 0,
"firstname": "string",
"surname": "string"
}
},
"changeRequest": {},
"onboardingStatus": "string"
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/ACCOUNT
* Updates account information/settings
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AccountResponse {
signature (string, optional):
signature
,
signatureEnabled (boolean, optional):
signature enabled?
,
defaultMsisdn (string, optional):
default MSISDN
,
messageLimit (integer, optional):
message limit for timegap
,
messageLimitTimegap (string, optional):
limit timegap (hour, day, week, month, year)
,
id (integer, optional):
account id
,
username (string, optional):
username
,
role (string, optional):
role
,
smtpEnabled (boolean, optional):
SMTP enabled
,
whatsappEnabled (boolean, optional):
Whatsapp enabled
,
whatsappAdmin (boolean, optional):
Whatsapp admin
,
smsEnabled (boolean, optional):
Sms enabled
,
urlshortenerEnabled (boolean, optional):
Urlshortener enabled
,
smtpWhitelist (Array[string], optional):
SMTP whitelist
,
remoteSms (string, optional):
remote SMS
,
httpForwardingAddress (string, optional):
HTTP forwarding address
,
smtpForwardingAddress (string, optional):
SMTP forwarding address
,
sentMessagesInTimegap (integer, optional):
Sent messages in timegap
,
freeMessages (integer, optional):
Free messages
,
active (boolean, optional):
active
,
locale (string, optional):
set language locale
,
contentCategory (string, optional):
content category
,
verifiedMsisdn (string, optional):
verified msisdn
,
urlshorteningTypeWhatsapp (string, optional):
urlshortening type whatsapp
,
urlshorteningTypeSms (string, optional):
urlshortening type sms
,
handleMoStop (boolean, optional):
handle mo stop?
,
smppEnabled (boolean, optional):
smpp enabled?
,
smsBoxEnabled (boolean, optional):
smsbox enabled?
,
serviceAssistantEnabled (boolean, optional):
service assistant enabled?
,
atmsCustomerFunctionsEnabled (boolean, optional):
atms customer functions enabled?
,
simplesmsCustomerFunctionsEnabled (boolean, optional):
simplesms customer functions enabled?
,
messengerEnabled (boolean, optional):
messenger functions enabled?
,
bulkEnabled (boolean, optional):
bulk functions enabled?
,
wabConfigured (boolean, optional):
wab configured?
,
use16BitReference (boolean, optional):
use 16bit reference?
,
convergedEnabled (boolean, optional):
converged enabled?
,
hlrEnabled (boolean, optional):
hlr enabled?
,
mfaEnabled (boolean, optional):
mfaEnabled
,
links (Array[Link], optional):
links
,
customer (CustomerResponse, optional):
customer
,
changeRequest (AccountResponse, optional):
change request
,
onboardingStatus (string, optional):
onboardingStatus
}
Link {
rel (string, optional),
href (string, optional)
}
CustomerResponse {
signature (string, optional):
signature
,
optInCssUrl (string, optional):
optin css url
,
optInCssContent (string, optional):
optin css content
,
id (integer, optional):
customer id
,
companyName (string, optional):
company name
,
diallingCodeId (integer, optional):
dialing code
,
siteId (integer, optional):
site id
,
locale (string, optional):
site id locale
,
trial (boolean, optional):
trial customer
,
upgradeUrl (string, optional):
trial customer upgrade url
,
status (string, optional):
status
,
links (Array[Link], optional):
links
,
validContractPayment (boolean, optional):
has valid contract payment?
,
accountManager (AccountManagerResponse, optional):
accountManager
}
AccountManagerResponse {
id (integer, optional):
id
,
firstname (string, optional):
firstname
,
surname (string, optional):
surname
}
{
"signature": "string",
"signatureEnabled": true,
"defaultMsisdn": "string",
"messageLimit": 0,
"messageLimitTimegap": "string",
"id": 0,
"username": "string",
"role": "string",
"smtpEnabled": true,
"whatsappEnabled": true,
"whatsappAdmin": true,
"smsEnabled": true,
"urlshortenerEnabled": true,
"smtpWhitelist": [
"string"
],
"remoteSms": "string",
"httpForwardingAddress": "string",
"smtpForwardingAddress": "string",
"sentMessagesInTimegap": 0,
"freeMessages": 0,
"active": true,
"locale": "string",
"contentCategory": "string",
"verifiedMsisdn": "string",
"urlshorteningTypeWhatsapp": "string",
"urlshorteningTypeSms": "string",
"handleMoStop": true,
"smppEnabled": true,
"smsBoxEnabled": true,
"serviceAssistantEnabled": true,
"atmsCustomerFunctionsEnabled": true,
"simplesmsCustomerFunctionsEnabled": true,
"messengerEnabled": true,
"bulkEnabled": true,
"wabConfigured": true,
"use16BitReference": true,
"convergedEnabled": true,
"hlrEnabled": true,
"mfaEnabled": true,
"links": [
{
"rel": "string",
"href": "string"
}
],
"customer": {
"signature": "string",
"optInCssUrl": "string",
"optInCssContent": "string",
"id": 0,
"companyName": "string",
"diallingCodeId": 0,
"siteId": 0,
"locale": "string",
"trial": true,
"upgradeUrl": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"validContractPayment": true,
"accountManager": {
"id": 0,
"firstname": "string",
"surname": "string"
}
},
"changeRequest": {},
"onboardingStatus": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
AccountRequest {
signature (string, optional):
signature
,
signatureEnabled (boolean, optional):
signature enabled?
,
defaultMsisdn (string, optional):
default MSISDN
,
messageLimit (integer, optional):
message limit for timegap
,
messageLimitTimegap (string, optional):
limit timegap (hour, day, week, month, year)
}
{
"signature": "string",
"signatureEnabled": true,
"defaultMsisdn": "string",
"messageLimit": 0,
"messageLimitTimegap": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CHANGE_REQUEST
* Returns account change request for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AccountResponse {
signature (string, optional):
signature
,
signatureEnabled (boolean, optional):
signature enabled?
,
defaultMsisdn (string, optional):
default MSISDN
,
messageLimit (integer, optional):
message limit for timegap
,
messageLimitTimegap (string, optional):
limit timegap (hour, day, week, month, year)
,
id (integer, optional):
account id
,
username (string, optional):
username
,
role (string, optional):
role
,
smtpEnabled (boolean, optional):
SMTP enabled
,
whatsappEnabled (boolean, optional):
Whatsapp enabled
,
whatsappAdmin (boolean, optional):
Whatsapp admin
,
smsEnabled (boolean, optional):
Sms enabled
,
urlshortenerEnabled (boolean, optional):
Urlshortener enabled
,
smtpWhitelist (Array[string], optional):
SMTP whitelist
,
remoteSms (string, optional):
remote SMS
,
httpForwardingAddress (string, optional):
HTTP forwarding address
,
smtpForwardingAddress (string, optional):
SMTP forwarding address
,
sentMessagesInTimegap (integer, optional):
Sent messages in timegap
,
freeMessages (integer, optional):
Free messages
,
active (boolean, optional):
active
,
locale (string, optional):
set language locale
,
contentCategory (string, optional):
content category
,
verifiedMsisdn (string, optional):
verified msisdn
,
urlshorteningTypeWhatsapp (string, optional):
urlshortening type whatsapp
,
urlshorteningTypeSms (string, optional):
urlshortening type sms
,
handleMoStop (boolean, optional):
handle mo stop?
,
smppEnabled (boolean, optional):
smpp enabled?
,
smsBoxEnabled (boolean, optional):
smsbox enabled?
,
serviceAssistantEnabled (boolean, optional):
service assistant enabled?
,
atmsCustomerFunctionsEnabled (boolean, optional):
atms customer functions enabled?
,
simplesmsCustomerFunctionsEnabled (boolean, optional):
simplesms customer functions enabled?
,
messengerEnabled (boolean, optional):
messenger functions enabled?
,
bulkEnabled (boolean, optional):
bulk functions enabled?
,
wabConfigured (boolean, optional):
wab configured?
,
use16BitReference (boolean, optional):
use 16bit reference?
,
convergedEnabled (boolean, optional):
converged enabled?
,
hlrEnabled (boolean, optional):
hlr enabled?
,
mfaEnabled (boolean, optional):
mfaEnabled
,
links (Array[Link], optional):
links
,
customer (CustomerResponse, optional):
customer
,
changeRequest (AccountResponse, optional):
change request
,
onboardingStatus (string, optional):
onboardingStatus
}
Link {
rel (string, optional),
href (string, optional)
}
CustomerResponse {
signature (string, optional):
signature
,
optInCssUrl (string, optional):
optin css url
,
optInCssContent (string, optional):
optin css content
,
id (integer, optional):
customer id
,
companyName (string, optional):
company name
,
diallingCodeId (integer, optional):
dialing code
,
siteId (integer, optional):
site id
,
locale (string, optional):
site id locale
,
trial (boolean, optional):
trial customer
,
upgradeUrl (string, optional):
trial customer upgrade url
,
status (string, optional):
status
,
links (Array[Link], optional):
links
,
validContractPayment (boolean, optional):
has valid contract payment?
,
accountManager (AccountManagerResponse, optional):
accountManager
}
AccountManagerResponse {
id (integer, optional):
id
,
firstname (string, optional):
firstname
,
surname (string, optional):
surname
}
{
"signature": "string",
"signatureEnabled": true,
"defaultMsisdn": "string",
"messageLimit": 0,
"messageLimitTimegap": "string",
"id": 0,
"username": "string",
"role": "string",
"smtpEnabled": true,
"whatsappEnabled": true,
"whatsappAdmin": true,
"smsEnabled": true,
"urlshortenerEnabled": true,
"smtpWhitelist": [
"string"
],
"remoteSms": "string",
"httpForwardingAddress": "string",
"smtpForwardingAddress": "string",
"sentMessagesInTimegap": 0,
"freeMessages": 0,
"active": true,
"locale": "string",
"contentCategory": "string",
"verifiedMsisdn": "string",
"urlshorteningTypeWhatsapp": "string",
"urlshorteningTypeSms": "string",
"handleMoStop": true,
"smppEnabled": true,
"smsBoxEnabled": true,
"serviceAssistantEnabled": true,
"atmsCustomerFunctionsEnabled": true,
"simplesmsCustomerFunctionsEnabled": true,
"messengerEnabled": true,
"bulkEnabled": true,
"wabConfigured": true,
"use16BitReference": true,
"convergedEnabled": true,
"hlrEnabled": true,
"mfaEnabled": true,
"links": [
{
"rel": "string",
"href": "string"
}
],
"customer": {
"signature": "string",
"optInCssUrl": "string",
"optInCssContent": "string",
"id": 0,
"companyName": "string",
"diallingCodeId": 0,
"siteId": 0,
"locale": "string",
"trial": true,
"upgradeUrl": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"validContractPayment": true,
"accountManager": {
"id": 0,
"firstname": "string",
"surname": "string"
}
},
"changeRequest": {},
"onboardingStatus": "string"
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/CHANGE_PASSWORD
* Changes account password
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ChangePasswordRequest {
oldPassword (string):
old password
,
newPassword (string):
new password
}
{
"oldPassword": "string",
"newPassword": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/OPT_IN/DEFAULT
* Returns default Opt-in URLs
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
OptInResponse
]
OptInResponse {
showAllGroups (boolean, optional):
show all groups?
,
contactGroupIds (Array[integer], optional):
contact group id list
,
basic (string, optional):
basic version
,
business (string, optional):
business version
,
extended (string, optional):
extended version
,
unsubscribe (string, optional):
unsubscribe
}
[
{
"showAllGroups": true,
"contactGroupIds": [
0
],
"basic": "string",
"business": "string",
"extended": "string",
"unsubscribe": "string"
}
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/OPT_IN/GENERATE
* Generates Opt-in URLs
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
OptInResponse
]
OptInResponse {
showAllGroups (boolean, optional):
show all groups?
,
contactGroupIds (Array[integer], optional):
contact group id list
,
basic (string, optional):
basic version
,
business (string, optional):
business version
,
extended (string, optional):
extended version
,
unsubscribe (string, optional):
unsubscribe
}
[
{
"showAllGroups": true,
"contactGroupIds": [
0
],
"basic": "string",
"business": "string",
"extended": "string",
"unsubscribe": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
OptInRequestDto {
showAllGroups (boolean, optional):
show all groups?
,
contactGroupIds (Array[integer], optional):
contact group id list
}
{
"showAllGroups": true,
"contactGroupIds": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/MSISDNS
* Returns MSISDNS for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
AccountMsisdnResponse
]
AccountMsisdnResponse {
msisdn (string, optional):
MSISDN
,
active (boolean, optional):
active?
,
remoteSms (string, optional):
remote SMS
,
usedForMo (boolean, optional):
used for mo?
,
default (boolean, optional):
default?
}
[
{
"msisdn": "string",
"active": true,
"remoteSms": "string",
"usedForMo": true,
"default": true
}
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/SMSBOXES
* Returns SmsBoxes for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
SmsBoxResponse
]
SmsBoxResponse {
msisdn (string, optional):
smsBox msisdn
,
deactivated (boolean, optional):
deactivated?
,
replyMessageType (string, optional):
reply message type
,
sharedMsisdnPrefix (string, optional):
shared msisdn prefix
}
[
{
"msisdn": "string",
"deactivated": true,
"replyMessageType": "string",
"sharedMsisdnPrefix": "string"
}
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/STATISTICS/{SELECTOR}
* Returns statistics for the account
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageStatisticResponse
]
MessageStatisticResponse {
intervalStart (string):
interval start time
,
intervalEnd (string):
interval end time
,
smsAmount (integer):
amount of SMS messages sent
,
pushAmount (integer):
amount of push messages sent
,
voiceAmount (integer):
amount of voice messages sent
,
whatsappAmount (integer):
amount of whatsapp messages sent
,
total (integer):
total messages sent
}
[
{
"intervalStart": "2024-06-20T13:22:51.946Z",
"intervalEnd": "2024-06-20T13:22:51.946Z",
"smsAmount": 0,
"pushAmount": 0,
"voiceAmount": 0,
"whatsappAmount": 0,
"total": 0
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/STATISTICS
* Returns statistics for account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageStatisticResponse
]
MessageStatisticResponse {
intervalStart (string):
interval start time
,
intervalEnd (string):
interval end time
,
smsAmount (integer):
amount of SMS messages sent
,
pushAmount (integer):
amount of push messages sent
,
voiceAmount (integer):
amount of voice messages sent
,
whatsappAmount (integer):
amount of whatsapp messages sent
,
total (integer):
total messages sent
}
[
{
"intervalStart": "2024-06-20T13:22:51.948Z",
"intervalEnd": "2024-06-20T13:22:51.948Z",
"smsAmount": 0,
"pushAmount": 0,
"voiceAmount": 0,
"whatsappAmount": 0,
"total": 0
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type filter
Filter
query string regionCode
Region Code
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/DELIVERY_DETAILS
* Returns delivery details for customer
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeliveryDetailResponse
]
DeliveryDetailResponse {
id (integer):
monthly record id
,
sentOn (string):
sent on
,
recipient (string):
recipient
,
sender (string):
sender
,
messageType (string):
message type
,
username (string):
username
,
productId (integer, optional):
product id
,
productName (string, optional):
product name
,
origin (string, optional):
message origin
= ['api_http', 'api_http_simple', 'api_rest', 'api_rest_simple',
'api_rest_converged', 'api_rest_customer_channel', 'api_smpp',
'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp', 'sdk_perl',
'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php', 'api_smtp_email2sms',
'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
detail (string, optional):
detail
,
message (string, optional):
message
,
statusOn (string, optional):
status on (date of delivery state)
,
status (string, optional):
delivery state
,
deliveryReport (boolean, optional):
delivery report requested
,
contentCategory (string, optional):
contentCategory
,
directionType (string, optional):
directionType
,
links (Array[Link], optional):
links
,
recipientContact (ContactResponse, optional):
recipient contact details, if available
,
product (ProductResponse, optional):
product
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
ProductResponse {
id (integer, optional):
product id
,
name (string, optional):
name
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"sentOn": "2024-06-20T13:22:51.949Z",
"recipient": "string",
"sender": "string",
"messageType": "string",
"username": "string",
"productId": 0,
"productName": "string",
"origin": "api_http",
"detail": "string",
"message": "string",
"statusOn": "2024-06-20T13:22:51.949Z",
"status": "string",
"deliveryReport": true,
"contentCategory": "string",
"directionType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"recipientContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.949Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.949Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"product": {
"id": 0,
"name": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer search
Search string
query string filters
Filters
query string regionCodes
Region Codes
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad Request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/DELIVERY_DETAILS/{SELECTOR}
* Returns delivery details for account
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeliveryDetailResponse
]
DeliveryDetailResponse {
id (integer):
monthly record id
,
sentOn (string):
sent on
,
recipient (string):
recipient
,
sender (string):
sender
,
messageType (string):
message type
,
username (string):
username
,
productId (integer, optional):
product id
,
productName (string, optional):
product name
,
origin (string, optional):
message origin
= ['api_http', 'api_http_simple', 'api_rest', 'api_rest_simple',
'api_rest_converged', 'api_rest_customer_channel', 'api_smpp',
'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp', 'sdk_perl',
'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php', 'api_smtp_email2sms',
'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
detail (string, optional):
detail
,
message (string, optional):
message
,
statusOn (string, optional):
status on (date of delivery state)
,
status (string, optional):
delivery state
,
deliveryReport (boolean, optional):
delivery report requested
,
contentCategory (string, optional):
contentCategory
,
directionType (string, optional):
directionType
,
links (Array[Link], optional):
links
,
recipientContact (ContactResponse, optional):
recipient contact details, if available
,
product (ProductResponse, optional):
product
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
ProductResponse {
id (integer, optional):
product id
,
name (string, optional):
name
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"sentOn": "2024-06-20T13:22:51.952Z",
"recipient": "string",
"sender": "string",
"messageType": "string",
"username": "string",
"productId": 0,
"productName": "string",
"origin": "api_http",
"detail": "string",
"message": "string",
"statusOn": "2024-06-20T13:22:51.952Z",
"status": "string",
"deliveryReport": true,
"contentCategory": "string",
"directionType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"recipientContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:51.952Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:51.952Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"product": {
"id": 0,
"name": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/NOTIFICATIONS/{ID}
* Returns notification
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
NotificationResponse {
id (integer):
notification id
,
type (string):
type
,
priority (string):
priority
,
sticky (boolean):
sticky
,
content (string):
content
,
read (boolean):
read?
,
created (string):
creation date
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"type": "string",
"priority": "string",
"sticky": true,
"content": "string",
"read": true,
"created": "2024-06-20T13:22:51.954Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/ACCOUNT/NOTIFICATIONS/{ID}/READ
* Marks notification as read
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/CONVERGED/FILES
* Uploads converged sender display image file
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
PublicFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
url (string, optional):
url
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"url": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type file
formData undefined
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/ACCOUNT/CONVERGED/FILES/{ID}
* Deletes converged sender display image file
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CONVERGED/FILES/{ID}
* Returns converged sender display image file information
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PublicFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
url (string, optional):
url
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"url": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CONVERGED/CONFIGURATION
* Returns converged configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ConvergedConfigurationResponse {
senderDisplayName (string, optional):
sender display name
,
senderDisplayImageUrl (string, optional):
sender display image URL
,
failoverTimeout (integer, optional):
failover time in seconds
,
links (Array[Link], optional):
links
,
changeRequest (ConvergedConfigurationResponse, optional):
change request
}
Link {
rel (string, optional),
href (string, optional)
}
{
"senderDisplayName": "string",
"senderDisplayImageUrl": "string",
"failoverTimeout": 0,
"links": [
{
"rel": "string",
"href": "string"
}
],
"changeRequest": {}
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/ACCOUNT/CONVERGED/CONFIGURATION
* Updates converged configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ConvergedConfigurationResponse {
senderDisplayName (string, optional):
sender display name
,
senderDisplayImageUrl (string, optional):
sender display image URL
,
failoverTimeout (integer, optional):
failover time in seconds
,
links (Array[Link], optional):
links
,
changeRequest (ConvergedConfigurationResponse, optional):
change request
}
Link {
rel (string, optional),
href (string, optional)
}
{
"senderDisplayName": "string",
"senderDisplayImageUrl": "string",
"failoverTimeout": 0,
"links": [
{
"rel": "string",
"href": "string"
}
],
"changeRequest": {}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ConvergedConfigurationRequest {
senderDisplayName (string, optional):
sender display name
,
senderDisplayImageUrl (string, optional):
sender display image URL
,
failoverTimeout (integer, optional):
failover time in seconds
}
{
"senderDisplayName": "string",
"senderDisplayImageUrl": "string",
"failoverTimeout": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CONVERGED/CONFIGURATION/CHANGE_REQUEST
* Returns converged configuration change request
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ConvergedConfigurationResponse {
senderDisplayName (string, optional):
sender display name
,
senderDisplayImageUrl (string, optional):
sender display image URL
,
failoverTimeout (integer, optional):
failover time in seconds
,
links (Array[Link], optional):
links
,
changeRequest (ConvergedConfigurationResponse, optional):
change request
}
Link {
rel (string, optional),
href (string, optional)
}
{
"senderDisplayName": "string",
"senderDisplayImageUrl": "string",
"failoverTimeout": 0,
"links": [
{
"rel": "string",
"href": "string"
}
],
"changeRequest": {}
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/WHATSAPP/CONFIGURATION
* Returns whatsapp configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappConfigurationResponse {
defaultContactGroupIds (Array[integer], optional):
default contact group ids
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"defaultContactGroupIds": [
0
],
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/ACCOUNT/WHATSAPP/CONFIGURATION
* Updates whatsapp configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
WhatsappConfigurationResponse {
defaultContactGroupIds (Array[integer], optional):
default contact group ids
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"defaultContactGroupIds": [
0
],
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
WhatsappConfigurationRequest {
defaultContactGroupIds (Array[integer], optional):
default contact group ids
}
{
"defaultContactGroupIds": [
0
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/DELIVERY_DETAILS/EXPORT
* Exports delivery details for the customer
PARAMETERS
Parameter Value Description Parameter Type Data Type format
Export format (pdf, csv, xsl)
query string page
Request a specific page
query integer size
Sets size of a page
query integer search
Search string
query string filters
Filters
query string regionCodes
Region Codes
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/DELIVERY_DETAILS/{SELECTOR}/EXPORT
* Exports delivery details for the account
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
format
Export format (pdf, csv, xsl)
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS
* Returns export tasks
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS
* Creates and executes export task
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/DELIVERY_DETAILS/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/DELIVERY_DETAILS/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DeliveryDetailsExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
filters (string, optional):
Filters
,
regionCodes (string, optional):
Region Codes
,
search (string, optional):
Search
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"filters": "string",
"regionCodes": "string",
"search": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DeliveryDetailsExportRequestDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
filters (string, optional):
Filters
,
regionCodes (string, optional):
Region Codes
,
search (string, optional):
Search
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"filters": "string",
"regionCodes": "string",
"search": "string"
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/ACCOUNT/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/ACCOUNT/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS/{TASKID}
* Returns export task
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/IDENTITIES
* Returns linked identities
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
IdentityResponseDto
]
IdentityResponseDto {
id (integer, optional):
id
,
issuer (string, optional):
issuer
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
picture (string, optional):
picture URL
,
emailAddress (string, optional):
email address
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"id": 0,
"issuer": "string",
"firstName": "string",
"lastName": "string",
"picture": "string",
"emailAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/ACCOUNT/IDENTITIES/{IDENTITYID}
* Deletes linked identity
PARAMETERS
Parameter Value Description Parameter Type Data Type identityId path
integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/IDENTITIES/JWT
* Creates external identity for jwt
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
IdentityResponseDto {
id (integer, optional):
id
,
issuer (string, optional):
issuer
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
picture (string, optional):
picture URL
,
emailAddress (string, optional):
email address
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"issuer": "string",
"firstName": "string",
"lastName": "string",
"picture": "string",
"emailAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
JwtRequest {
value (string, optional):
base64 encoded JWT
}
{
"value": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/ACTIVATE_MESSENGER
*
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/ACTIVATE_BULK
*
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/PROFILE
* Returns profile configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileRequest {
firstname (string, optional):
account profile display firstname
,
lastname (string, optional):
account profile display lastname
,
msisdn (string, optional):
account profile display msisdn
stringReg. Exp.:^|\+[0-9]{1,15}
}
{
"firstname": "string",
"lastname": "string",
"msisdn": "string"
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/ACCOUNT/PROFILE
* Updates profile configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileRequest {
firstname (string, optional):
account profile display firstname
,
lastname (string, optional):
account profile display lastname
,
msisdn (string, optional):
account profile display msisdn
stringReg. Exp.:^|\+[0-9]{1,15}
}
{
"firstname": "string",
"lastname": "string",
"msisdn": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ProfileRequest {
firstname (string, optional):
account profile display firstname
,
lastname (string, optional):
account profile display lastname
,
msisdn (string, optional):
account profile display msisdn
stringReg. Exp.:^|\+[0-9]{1,15}
}
{
"firstname": "string",
"lastname": "string",
"msisdn": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/ACCOUNT/PROFILE/IMAGE
* Deletes profile display image file
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/PROFILE/IMAGE
* Uploads profile display image file
RESPONSE CLASS (STATUS 201)
* Model
* Model Schema
PublicFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
url (string, optional):
url
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"url": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type file
formData undefined
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/PROFILE/IMAGE/CONTENT
* Returns profile display image file
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PublicFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
url (string, optional):
url
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"url": "string"
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/PROFILE/IMAGE/THUMBNAIL
* Returns porfile display image thumbnail file
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PublicFileResponse {
id (integer):
id
,
name (string):
file name
,
size (integer, optional):
file size in bytes
,
md5sum (string, optional):
MD5 sum
,
links (Array[Link], optional):
links
,
url (string, optional):
url
}
Link {
rel (string, optional),
href (string, optional)
}
{
"id": 0,
"name": "string",
"size": 0,
"md5sum": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"url": "string"
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/TWO_FACTOR/REQUEST_IDENTITY_TOKEN
* Requests two factor identity token
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
RequestIdentityTokenResponseDto {
identityType (string, optional):
identity type
stringReg. Exp.:^(?i)(msisdn)$
,
value (string, optional):
value (e.g. msisdn)
stringReg. Exp.:\+?[0-9]{1,15}
,
identityToken (string, optional):
identity token
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"identityType": "string",
"value": "string",
"identityToken": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
RequestIdentityTokenRequestDto {
identityType (string, optional):
identity type
stringReg. Exp.:^(?i)(msisdn)$
,
value (string, optional):
value (e.g. msisdn)
stringReg. Exp.:\+?[0-9]{1,15}
}
{
"identityType": "string",
"value": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/TWO_FACTOR/CONFIRM_IDENTITY_TOKEN
* Confirms identity
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ConfirmIdentityTokenResponseDto {
identityToken (string, optional):
identity token
,
secret (string, optional):
secret
}
{
"identityToken": "string",
"secret": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ConfirmIdentityTokenRequestDto {
identityToken (string, optional):
identity token
,
secret (string, optional):
secret
}
{
"identityToken": "string",
"secret": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/TWO_FACTOR/ENABLE
* Enables two factor (with information provided from given identityToken
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
EnableTwoFactor {
identityToken (string, optional)
}
{
"identityToken": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/TWO_FACTOR/DISABLE
* Disables two factor (with information provided from given
identityToken
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DisableTwoFactor {
identityToken (string, optional)
}
{
"identityToken": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/TWO_FACTOR
* Returns two factor configuration
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TwoFactorResponseDto {
enabled (boolean, optional):
enabled
,
identityType (string, optional):
identityType
,
identityValue (string, optional):
identityValue
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"enabled": true,
"identityType": "string",
"identityValue": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/PERMISSIONS
* Returns permissions for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
string
]
[
"string"
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/LICENCES
* Returns operating and quitting licences
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
LicenceResponse
]
LicenceResponse {
licenceTypeId (integer, optional):
licence type
,
quantity (integer, optional):
quantity
,
startDate (string, optional):
start date
,
endDate (string, optional):
end date
,
id (integer, optional):
licence id
,
productName (string, optional):
product name
,
productDescription (string, optional):
product description
,
productPrice (number, optional):
product price
,
invoiceRemarks (string, optional):
invoice remarks
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"licenceTypeId": 0,
"quantity": 0,
"startDate": "string",
"endDate": "string",
"id": 0,
"productName": "string",
"productDescription": "string",
"productPrice": 0,
"invoiceRemarks": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/LICENCES
* Places a licence order
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
LicenceResponse {
licenceTypeId (integer, optional):
licence type
,
quantity (integer, optional):
quantity
,
startDate (string, optional):
start date
,
endDate (string, optional):
end date
,
id (integer, optional):
licence id
,
productName (string, optional):
product name
,
productDescription (string, optional):
product description
,
productPrice (number, optional):
product price
,
invoiceRemarks (string, optional):
invoice remarks
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"licenceTypeId": 0,
"quantity": 0,
"startDate": "string",
"endDate": "string",
"id": 0,
"productName": "string",
"productDescription": "string",
"productPrice": 0,
"invoiceRemarks": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
LicenceRequest {
licenceTypeId (integer, optional):
licence type
,
quantity (integer, optional):
quantity
,
startDate (string, optional):
start date
,
endDate (string, optional):
end date
}
{
"licenceTypeId": 0,
"quantity": 0,
"startDate": "string",
"endDate": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/LICENCES/{ID}
* Returns a licence
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
LicenceResponse {
licenceTypeId (integer, optional):
licence type
,
quantity (integer, optional):
quantity
,
startDate (string, optional):
start date
,
endDate (string, optional):
end date
,
id (integer, optional):
licence id
,
productName (string, optional):
product name
,
productDescription (string, optional):
product description
,
productPrice (number, optional):
product price
,
invoiceRemarks (string, optional):
invoice remarks
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"licenceTypeId": 0,
"quantity": 0,
"startDate": "string",
"endDate": "string",
"id": 0,
"productName": "string",
"productDescription": "string",
"productPrice": 0,
"invoiceRemarks": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/LICENCES/ORDERABLE
* Returns orderable licences
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
LicenceResponse
]
LicenceResponse {
licenceTypeId (integer, optional):
licence type
,
quantity (integer, optional):
quantity
,
startDate (string, optional):
start date
,
endDate (string, optional):
end date
,
id (integer, optional):
licence id
,
productName (string, optional):
product name
,
productDescription (string, optional):
product description
,
productPrice (number, optional):
product price
,
invoiceRemarks (string, optional):
invoice remarks
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"licenceTypeId": 0,
"quantity": 0,
"startDate": "string",
"endDate": "string",
"id": 0,
"productName": "string",
"productDescription": "string",
"productPrice": 0,
"invoiceRemarks": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type search
Search string
query string sort
Sorts response by given fields
query string filter
Filter predefined categories (BASE, ADDON, SMS, WAB, …)
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/LICENCES/VERIFY
* Verifies if a licence for a give type exists
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
LicenceVerifyResponse {
licenceType (string):
licence type
,
licenceSubType (string, optional):
optional sub type
,
licenceEndDate (string, optional):
licence end date
,
licenceState (string, optional):
licence state
,
licenceOrderUrl (string, optional):
licence order url
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"licenceType": "string",
"licenceSubType": "string",
"licenceEndDate": "2024-06-20T13:22:52.031Z",
"licenceState": "string",
"licenceOrderUrl": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
LicenceVerifyRequest {
licenceType (string):
licence type
,
licenceSubType (string, optional):
optional sub type
}
{
"licenceType": "string",
"licenceSubType": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/STATISTICS/{SELECTOR}
* Returns statistics for the customer
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageStatisticResponse
]
MessageStatisticResponse {
intervalStart (string):
interval start time
,
intervalEnd (string):
interval end time
,
smsAmount (integer):
amount of SMS messages sent
,
pushAmount (integer):
amount of push messages sent
,
voiceAmount (integer):
amount of voice messages sent
,
whatsappAmount (integer):
amount of whatsapp messages sent
,
total (integer):
total messages sent
}
[
{
"intervalStart": "2024-06-20T13:22:52.034Z",
"intervalEnd": "2024-06-20T13:22:52.034Z",
"smsAmount": 0,
"pushAmount": 0,
"voiceAmount": 0,
"whatsappAmount": 0,
"total": 0
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/STATISTICS
* Returns statistics for the customer
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageStatisticResponse
]
MessageStatisticResponse {
intervalStart (string):
interval start time
,
intervalEnd (string):
interval end time
,
smsAmount (integer):
amount of SMS messages sent
,
pushAmount (integer):
amount of push messages sent
,
voiceAmount (integer):
amount of voice messages sent
,
whatsappAmount (integer):
amount of whatsapp messages sent
,
total (integer):
total messages sent
}
[
{
"intervalStart": "2024-06-20T13:22:52.037Z",
"intervalEnd": "2024-06-20T13:22:52.037Z",
"smsAmount": 0,
"pushAmount": 0,
"voiceAmount": 0,
"whatsappAmount": 0,
"total": 0
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type filter
Filter
query string regionCode
Region Code
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}
* Returns delivery details for customer
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeliveryDetailResponse
]
DeliveryDetailResponse {
id (integer):
monthly record id
,
sentOn (string):
sent on
,
recipient (string):
recipient
,
sender (string):
sender
,
messageType (string):
message type
,
username (string):
username
,
productId (integer, optional):
product id
,
productName (string, optional):
product name
,
origin (string, optional):
message origin
= ['api_http', 'api_http_simple', 'api_rest', 'api_rest_simple',
'api_rest_converged', 'api_rest_customer_channel', 'api_smpp',
'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp', 'sdk_perl',
'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php', 'api_smtp_email2sms',
'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
detail (string, optional):
detail
,
message (string, optional):
message
,
statusOn (string, optional):
status on (date of delivery state)
,
status (string, optional):
delivery state
,
deliveryReport (boolean, optional):
delivery report requested
,
contentCategory (string, optional):
contentCategory
,
directionType (string, optional):
directionType
,
links (Array[Link], optional):
links
,
recipientContact (ContactResponse, optional):
recipient contact details, if available
,
product (ProductResponse, optional):
product
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
ProductResponse {
id (integer, optional):
product id
,
name (string, optional):
name
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"sentOn": "2024-06-20T13:22:52.040Z",
"recipient": "string",
"sender": "string",
"messageType": "string",
"username": "string",
"productId": 0,
"productName": "string",
"origin": "api_http",
"detail": "string",
"message": "string",
"statusOn": "2024-06-20T13:22:52.040Z",
"status": "string",
"deliveryReport": true,
"contentCategory": "string",
"directionType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"recipientContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:52.040Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:52.040Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"product": {
"id": 0,
"name": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS
* Returns delivery details for customer
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeliveryDetailResponse
]
DeliveryDetailResponse {
id (integer):
monthly record id
,
sentOn (string):
sent on
,
recipient (string):
recipient
,
sender (string):
sender
,
messageType (string):
message type
,
username (string):
username
,
productId (integer, optional):
product id
,
productName (string, optional):
product name
,
origin (string, optional):
message origin
= ['api_http', 'api_http_simple', 'api_rest', 'api_rest_simple',
'api_rest_converged', 'api_rest_customer_channel', 'api_smpp',
'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp', 'sdk_perl',
'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php', 'api_smtp_email2sms',
'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
detail (string, optional):
detail
,
message (string, optional):
message
,
statusOn (string, optional):
status on (date of delivery state)
,
status (string, optional):
delivery state
,
deliveryReport (boolean, optional):
delivery report requested
,
contentCategory (string, optional):
contentCategory
,
directionType (string, optional):
directionType
,
links (Array[Link], optional):
links
,
recipientContact (ContactResponse, optional):
recipient contact details, if available
,
product (ProductResponse, optional):
product
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
ProductResponse {
id (integer, optional):
product id
,
name (string, optional):
name
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"sentOn": "2024-06-20T13:22:52.044Z",
"recipient": "string",
"sender": "string",
"messageType": "string",
"username": "string",
"productId": 0,
"productName": "string",
"origin": "api_http",
"detail": "string",
"message": "string",
"statusOn": "2024-06-20T13:22:52.044Z",
"status": "string",
"deliveryReport": true,
"contentCategory": "string",
"directionType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"recipientContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:52.044Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:52.044Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"product": {
"id": 0,
"name": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer search
Search string
query string filters
Filters
query string regionCodes
Region Codes
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad Request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/EXPORT
* Exports delivery details for the customer
PARAMETERS
Parameter Value Description Parameter Type Data Type format
Export format (pdf, csv, xsl)
query string page
Request a specific page
query integer size
Sets size of a page
query integer search
Search string
query string filters
Filters
query string regionCodes
Region Codes
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT
* Exports delivery details for the customer
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
format
Export format (pdf, csv, xsl)
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/EXPORT/TASKS
* Returns export tasks
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/EXPORT/TASKS
* Creates and executes export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DeliveryDetailsExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
filters (string, optional):
Filters
,
regionCodes (string, optional):
Region Codes
,
search (string, optional):
Search
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"filters": "string",
"regionCodes": "string",
"search": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DeliveryDetailsExportRequestDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
filters (string, optional):
Filters
,
regionCodes (string, optional):
Region Codes
,
search (string, optional):
Search
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"filters": "string",
"regionCodes": "string",
"search": "string"
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS
* Returns export tasks
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS
* Creates and executes export task
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
body
Parameter content type: application/json
body
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE
/V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/{SELECTOR}/EXPORT/TASKS/{TASKID}
* Returns export task
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type selector path string
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/EXPORT/TASKS/{TASKID}
* Returns export task
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE
/V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT/TASKS/{TASKID}
* Deletes/cancels export task for account
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No content
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT/TASKS/{TASKID}
* Returns export task for account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/ACCOUNTS
* Returns accounts for customer
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MinimalAccountResponse {
id (integer, optional):
account id
,
username (string, optional):
user
,
active (boolean, optional):
active
}
{
"id": 0,
"username": "string",
"active": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string sort
Sorts response by given fields
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER
* Returns customer information for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerResponse {
signature (string, optional):
signature
,
optInCssUrl (string, optional):
optin css url
,
optInCssContent (string, optional):
optin css content
,
id (integer, optional):
customer id
,
companyName (string, optional):
company name
,
diallingCodeId (integer, optional):
dialing code
,
siteId (integer, optional):
site id
,
locale (string, optional):
site id locale
,
trial (boolean, optional):
trial customer
,
upgradeUrl (string, optional):
trial customer upgrade url
,
status (string, optional):
status
,
links (Array[Link], optional):
links
,
validContractPayment (boolean, optional):
has valid contract payment?
,
accountManager (AccountManagerResponse, optional):
accountManager
}
Link {
rel (string, optional),
href (string, optional)
}
AccountManagerResponse {
id (integer, optional):
id
,
firstname (string, optional):
firstname
,
surname (string, optional):
surname
}
{
"signature": "string",
"optInCssUrl": "string",
"optInCssContent": "string",
"id": 0,
"companyName": "string",
"diallingCodeId": 0,
"siteId": 0,
"locale": "string",
"trial": true,
"upgradeUrl": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"validContractPayment": true,
"accountManager": {
"id": 0,
"firstname": "string",
"surname": "string"
}
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/ACCOUNT/CUSTOMER
* Updates customer information/settings
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerResponse {
signature (string, optional):
signature
,
optInCssUrl (string, optional):
optin css url
,
optInCssContent (string, optional):
optin css content
,
id (integer, optional):
customer id
,
companyName (string, optional):
company name
,
diallingCodeId (integer, optional):
dialing code
,
siteId (integer, optional):
site id
,
locale (string, optional):
site id locale
,
trial (boolean, optional):
trial customer
,
upgradeUrl (string, optional):
trial customer upgrade url
,
status (string, optional):
status
,
links (Array[Link], optional):
links
,
validContractPayment (boolean, optional):
has valid contract payment?
,
accountManager (AccountManagerResponse, optional):
accountManager
}
Link {
rel (string, optional),
href (string, optional)
}
AccountManagerResponse {
id (integer, optional):
id
,
firstname (string, optional):
firstname
,
surname (string, optional):
surname
}
{
"signature": "string",
"optInCssUrl": "string",
"optInCssContent": "string",
"id": 0,
"companyName": "string",
"diallingCodeId": 0,
"siteId": 0,
"locale": "string",
"trial": true,
"upgradeUrl": "string",
"status": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"validContractPayment": true,
"accountManager": {
"id": 0,
"firstname": "string",
"surname": "string"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerRequest {
signature (string, optional):
signature
,
optInCssUrl (string, optional):
optin css url
,
optInCssContent (string, optional):
optin css content
}
{
"signature": "string",
"optInCssUrl": "string",
"optInCssContent": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/STATISTICS/ACCOUNTS
* Returns statistics for the customer grouped by accounts
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageStatisticGroupedByAccountResponse
]
MessageStatisticGroupedByAccountResponse {
intervalStart (string):
interval start time
,
intervalEnd (string):
interval end time
,
smsAmount (integer):
amount of SMS messages sent
,
pushAmount (integer):
amount of push messages sent
,
voiceAmount (integer):
amount of voice messages sent
,
whatsappAmount (integer):
amount of whatsapp messages sent
,
total (integer):
total messages sent
,
account (MinimalAccountResponse, optional)
}
MinimalAccountResponse {
id (integer, optional):
account id
,
username (string, optional):
user
,
active (boolean, optional):
active
}
[
{
"intervalStart": "2024-06-20T13:22:52.082Z",
"intervalEnd": "2024-06-20T13:22:52.082Z",
"smsAmount": 0,
"pushAmount": 0,
"voiceAmount": 0,
"whatsappAmount": 0,
"total": 0,
"account": {
"id": 0,
"username": "string",
"active": true
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type filter
Filter
query string regionCode
Region Code
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/STATISTICS/ACCOUNTS/{ID}
* Returns statistics for the account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
MessageStatisticResponse
]
MessageStatisticResponse {
intervalStart (string):
interval start time
,
intervalEnd (string):
interval end time
,
smsAmount (integer):
amount of SMS messages sent
,
pushAmount (integer):
amount of push messages sent
,
voiceAmount (integer):
amount of voice messages sent
,
whatsappAmount (integer):
amount of whatsapp messages sent
,
total (integer):
total messages sent
}
[
{
"intervalStart": "2024-06-20T13:22:52.085Z",
"intervalEnd": "2024-06-20T13:22:52.085Z",
"smsAmount": 0,
"pushAmount": 0,
"voiceAmount": 0,
"whatsappAmount": 0,
"total": 0
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
filter
Filter
query string regionCode
Region Code
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}
* Returns delivery details for the account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
DeliveryDetailResponse
]
DeliveryDetailResponse {
id (integer):
monthly record id
,
sentOn (string):
sent on
,
recipient (string):
recipient
,
sender (string):
sender
,
messageType (string):
message type
,
username (string):
username
,
productId (integer, optional):
product id
,
productName (string, optional):
product name
,
origin (string, optional):
message origin
= ['api_http', 'api_http_simple', 'api_rest', 'api_rest_simple',
'api_rest_converged', 'api_rest_customer_channel', 'api_smpp',
'api_smtp', 'api_ftp', 'sdk_java', 'sdk_cpp', 'sdk_csharp', 'sdk_perl',
'sdk_ruby', 'sdk_python', 'sdk_node', 'sdk_php', 'api_smtp_email2sms',
'api_smtp_email2voice', 'api_smtp_email2sms_ucs',
'api_smtp_email2whatsapp', 'oms', 'oms_reply', 'remotesms',
'remotesms_msisdn_change', 'remotesms_error', 'group_subscription',
'trigger_rule', 'registration', 'birthday_sms', 'mycokemusic', 'optin',
'applet_optin', 'applet_optout', 'applet_quick_optin', 'internex',
'onlinesms_v2', 'onlinesms_v3', 'api_v1', 'plugin_excel_365',
'plugin_excel_2010', 'plugin_google_sheets', 'plugin_google_chrome',
'unknown']
stringEnum:"api_http", "api_http_simple", "api_rest", "api_rest_simple",
"api_rest_converged", "api_rest_customer_channel", "api_smpp",
"api_smtp", "api_ftp", "sdk_java", "sdk_cpp", "sdk_csharp", "sdk_perl",
"sdk_ruby", "sdk_python", "sdk_node", "sdk_php", "api_smtp_email2sms",
"api_smtp_email2voice", "api_smtp_email2sms_ucs",
"api_smtp_email2whatsapp", "oms", "oms_reply", "remotesms",
"remotesms_msisdn_change", "remotesms_error", "group_subscription",
"trigger_rule", "registration", "birthday_sms", "mycokemusic", "optin",
"applet_optin", "applet_optout", "applet_quick_optin", "internex",
"onlinesms_v2", "onlinesms_v3", "api_v1", "plugin_excel_365",
"plugin_excel_2010", "plugin_google_sheets", "plugin_google_chrome",
"unknown"
,
detail (string, optional):
detail
,
message (string, optional):
message
,
statusOn (string, optional):
status on (date of delivery state)
,
status (string, optional):
delivery state
,
deliveryReport (boolean, optional):
delivery report requested
,
contentCategory (string, optional):
contentCategory
,
directionType (string, optional):
directionType
,
links (Array[Link], optional):
links
,
recipientContact (ContactResponse, optional):
recipient contact details, if available
,
product (ProductResponse, optional):
product
}
Link {
rel (string, optional),
href (string, optional)
}
ContactResponse {
title (string, optional):
title
,
firstName (string, optional):
first name
,
lastName (string, optional):
last name
,
nickname (string, optional):
nickname
,
mobile (string, optional):
mobile phone number
stringReg. Exp.:^|\+[0-9]{1,15}
,
landline (string, optional):
landline phone number
stringReg. Exp.:^|\+[0-9]{1,20}
,
fax (string, optional):
fax number
stringReg. Exp.:^|\+[0-9]{1,20}
,
emailAddress (string, optional):
email address
,
birthday (string, optional):
birthday
,
homepage (string, optional):
homepage
,
instantMessenger (string, optional):
instant messenger user
,
skype (string, optional):
skype name
,
remarks (string, optional):
custom remarks
,
street (string, optional):
street
,
zipCode (string, optional):
zip code
,
city (string, optional):
city
,
country (string, optional):
country
,
company (string, optional):
company name
,
department (string, optional):
department
,
bureau (string, optional):
bureau
,
jobTitle (string, optional):
job title
,
remoteSmsEnabled (boolean, optional):
remote SMS enabled?
,
whatsapp (string, optional):
whatsapp recipient
stringReg. Exp.:^|\+[0-9]{1,15}
,
id (integer, optional):
contact id
,
age (integer, optional):
age
,
numberOfContactGroups (integer, optional):
number of contact groups
,
lastModified (string, optional):
last modified
,
lastModifiedBy (string, optional):
last modified by
,
origin (string, optional):
origin
,
originDetails (string, optional):
origin details
,
createdBy (string, optional):
created by
,
created (string, optional):
created
,
links (Array[Link], optional):
links
}
ProductResponse {
id (integer, optional):
product id
,
name (string, optional):
name
,
links (Array[Link], optional):
links
}
[
{
"id": 0,
"sentOn": "2024-06-20T13:22:52.088Z",
"recipient": "string",
"sender": "string",
"messageType": "string",
"username": "string",
"productId": 0,
"productName": "string",
"origin": "api_http",
"detail": "string",
"message": "string",
"statusOn": "2024-06-20T13:22:52.088Z",
"status": "string",
"deliveryReport": true,
"contentCategory": "string",
"directionType": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"recipientContact": {
"title": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"mobile": "string",
"landline": "string",
"fax": "string",
"emailAddress": "string",
"birthday": "string",
"homepage": "string",
"instantMessenger": "string",
"skype": "string",
"remarks": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"country": "string",
"company": "string",
"department": "string",
"bureau": "string",
"jobTitle": "string",
"remoteSmsEnabled": true,
"whatsapp": "string",
"id": 0,
"age": 0,
"numberOfContactGroups": 0,
"lastModified": "2024-06-20T13:22:52.088Z",
"lastModifiedBy": "string",
"origin": "string",
"originDetails": "string",
"createdBy": "string",
"created": "2024-06-20T13:22:52.088Z",
"links": [
{
"rel": "string",
"href": "string"
}
]
},
"product": {
"id": 0,
"name": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer search
Search string
query string filters
Filters
query string regionCodes
Region Codes
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad Request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/CONTACT_PERSON
* Returns customer contact person for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContactPersonResponse {
mainContactSalutation (string, optional):
main contact salutation
,
mainContactTitle (string, optional):
main contact title
,
mainContactFirstName (string, optional):
main contact first name
,
mainContactLastName (string, optional):
main contact last name
,
mainContactPhoneNumber (string, optional):
main contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
mainContactEmailAddress (string, optional):
main contact email address
,
techContactSalutation (string, optional):
tech contact salutation
,
techContactTitle (string, optional):
tech contact title
,
techContactFirstName (string, optional):
tech contact first name
,
techContactLastName (string, optional):
contact last name
,
techContactPhoneNumber (string, optional):
contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
techContactEmailAddress (string, optional):
contact email address
,
adminContactSalutation (string, optional):
admin contact salutation
,
adminContactTitle (string, optional):
admin contact title
,
adminContactFirstName (string, optional):
admin contact first name
,
adminContactLastName (string, optional):
admin contact last name
,
adminContactPhoneNumber (string, optional):
admin contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
adminContactEmailAddress (string, optional):
admin contact email address
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
commercialContactPhoneNumber (string, optional):
commercial contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
commercialContactEmailAddress (string, optional):
commercial contact email address
,
marketingContactSalutation (string, optional):
marketing contact salutation
,
marketingContactTitle (string, optional):
marketing contact title
,
marketingContactFirstName (string, optional):
marketing contact first name
,
marketingContactLastName (string, optional):
marketing contact last name
,
marketingContactPhoneNumber (string, optional):
marketing contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
marketingContactEmailAddress (string, optional):
marketing contact email address
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"mainContactSalutation": "string",
"mainContactTitle": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"mainContactPhoneNumber": "string",
"mainContactEmailAddress": "string",
"techContactSalutation": "string",
"techContactTitle": "string",
"techContactFirstName": "string",
"techContactLastName": "string",
"techContactPhoneNumber": "string",
"techContactEmailAddress": "string",
"adminContactSalutation": "string",
"adminContactTitle": "string",
"adminContactFirstName": "string",
"adminContactLastName": "string",
"adminContactPhoneNumber": "string",
"adminContactEmailAddress": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"commercialContactPhoneNumber": "string",
"commercialContactEmailAddress": "string",
"marketingContactSalutation": "string",
"marketingContactTitle": "string",
"marketingContactFirstName": "string",
"marketingContactLastName": "string",
"marketingContactPhoneNumber": "string",
"marketingContactEmailAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/ACCOUNT/CUSTOMER/CONTACT_PERSON
* Updates customer contact person
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContactPersonResponse {
mainContactSalutation (string, optional):
main contact salutation
,
mainContactTitle (string, optional):
main contact title
,
mainContactFirstName (string, optional):
main contact first name
,
mainContactLastName (string, optional):
main contact last name
,
mainContactPhoneNumber (string, optional):
main contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
mainContactEmailAddress (string, optional):
main contact email address
,
techContactSalutation (string, optional):
tech contact salutation
,
techContactTitle (string, optional):
tech contact title
,
techContactFirstName (string, optional):
tech contact first name
,
techContactLastName (string, optional):
contact last name
,
techContactPhoneNumber (string, optional):
contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
techContactEmailAddress (string, optional):
contact email address
,
adminContactSalutation (string, optional):
admin contact salutation
,
adminContactTitle (string, optional):
admin contact title
,
adminContactFirstName (string, optional):
admin contact first name
,
adminContactLastName (string, optional):
admin contact last name
,
adminContactPhoneNumber (string, optional):
admin contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
adminContactEmailAddress (string, optional):
admin contact email address
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
commercialContactPhoneNumber (string, optional):
commercial contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
commercialContactEmailAddress (string, optional):
commercial contact email address
,
marketingContactSalutation (string, optional):
marketing contact salutation
,
marketingContactTitle (string, optional):
marketing contact title
,
marketingContactFirstName (string, optional):
marketing contact first name
,
marketingContactLastName (string, optional):
marketing contact last name
,
marketingContactPhoneNumber (string, optional):
marketing contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
marketingContactEmailAddress (string, optional):
marketing contact email address
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"mainContactSalutation": "string",
"mainContactTitle": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"mainContactPhoneNumber": "string",
"mainContactEmailAddress": "string",
"techContactSalutation": "string",
"techContactTitle": "string",
"techContactFirstName": "string",
"techContactLastName": "string",
"techContactPhoneNumber": "string",
"techContactEmailAddress": "string",
"adminContactSalutation": "string",
"adminContactTitle": "string",
"adminContactFirstName": "string",
"adminContactLastName": "string",
"adminContactPhoneNumber": "string",
"adminContactEmailAddress": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"commercialContactPhoneNumber": "string",
"commercialContactEmailAddress": "string",
"marketingContactSalutation": "string",
"marketingContactTitle": "string",
"marketingContactFirstName": "string",
"marketingContactLastName": "string",
"marketingContactPhoneNumber": "string",
"marketingContactEmailAddress": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerContactPersonRequest {
mainContactSalutation (string, optional):
main contact salutation
,
mainContactTitle (string, optional):
main contact title
,
mainContactFirstName (string, optional):
main contact first name
,
mainContactLastName (string, optional):
main contact last name
,
mainContactPhoneNumber (string, optional):
main contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
mainContactEmailAddress (string, optional):
main contact email address
,
techContactSalutation (string, optional):
tech contact salutation
,
techContactTitle (string, optional):
tech contact title
,
techContactFirstName (string, optional):
tech contact first name
,
techContactLastName (string, optional):
contact last name
,
techContactPhoneNumber (string, optional):
contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
techContactEmailAddress (string, optional):
contact email address
,
adminContactSalutation (string, optional):
admin contact salutation
,
adminContactTitle (string, optional):
admin contact title
,
adminContactFirstName (string, optional):
admin contact first name
,
adminContactLastName (string, optional):
admin contact last name
,
adminContactPhoneNumber (string, optional):
admin contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
adminContactEmailAddress (string, optional):
admin contact email address
,
commercialContactSalutation (string, optional):
commercial contact salutation
,
commercialContactTitle (string, optional):
commercial contact title
,
commercialContactFirstName (string, optional):
commercial contact first name
,
commercialContactLastName (string, optional):
commercial contact last name
,
commercialContactPhoneNumber (string, optional):
commercial contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
commercialContactEmailAddress (string, optional):
commercial contact email address
,
marketingContactSalutation (string, optional):
marketing contact salutation
,
marketingContactTitle (string, optional):
marketing contact title
,
marketingContactFirstName (string, optional):
marketing contact first name
,
marketingContactLastName (string, optional):
marketing contact last name
,
marketingContactPhoneNumber (string, optional):
marketing contact phone number
stringReg. Exp.:(\+[0-9]{1,15})?
,
marketingContactEmailAddress (string, optional):
marketing contact email address
}
{
"mainContactSalutation": "string",
"mainContactTitle": "string",
"mainContactFirstName": "string",
"mainContactLastName": "string",
"mainContactPhoneNumber": "string",
"mainContactEmailAddress": "string",
"techContactSalutation": "string",
"techContactTitle": "string",
"techContactFirstName": "string",
"techContactLastName": "string",
"techContactPhoneNumber": "string",
"techContactEmailAddress": "string",
"adminContactSalutation": "string",
"adminContactTitle": "string",
"adminContactFirstName": "string",
"adminContactLastName": "string",
"adminContactPhoneNumber": "string",
"adminContactEmailAddress": "string",
"commercialContactSalutation": "string",
"commercialContactTitle": "string",
"commercialContactFirstName": "string",
"commercialContactLastName": "string",
"commercialContactPhoneNumber": "string",
"commercialContactEmailAddress": "string",
"marketingContactSalutation": "string",
"marketingContactTitle": "string",
"marketingContactFirstName": "string",
"marketingContactLastName": "string",
"marketingContactPhoneNumber": "string",
"marketingContactEmailAddress": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 403
Update forbidden
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/CONTRACT_DETAIL
* Returns customer contract detail for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContractDetailResponse {
companyName (string, optional):
company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyStreet (string, optional):
company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
companySectorIndustryId (integer, optional):
sector industry id
,
companySizeId (integer, optional):
company size id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
invoicingCompanyName (string, optional):
invoicing company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyStreet (string, optional):
invoicing company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
invoiceRecipient (string, optional):
invoice recipient
,
geteInvoiceEmailAddress (string, optional):
einvoice email address
,
iseInvoiceEnabled (boolean, optional):
einvoice enabled
,
directDebitEnabled (boolean, optional):
direct debit enabled
,
vatId (string, optional):
vat id
,
links (Array[Link], optional):
links
,
changeRequest (CustomerContractDetailResponse, optional):
change request
}
Link {
rel (string, optional),
href (string, optional)
}
{
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"companySectorIndustryId": 0,
"companySizeId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"invoiceRecipient": "string",
"geteInvoiceEmailAddress": "string",
"iseInvoiceEnabled": true,
"directDebitEnabled": true,
"vatId": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"changeRequest": {}
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/ACCOUNT/CUSTOMER/CONTRACT_DETAIL
* Updates customer contract detail
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContractDetailResponse {
companyName (string, optional):
company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyStreet (string, optional):
company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
companySectorIndustryId (integer, optional):
sector industry id
,
companySizeId (integer, optional):
company size id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
invoicingCompanyName (string, optional):
invoicing company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyStreet (string, optional):
invoicing company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
invoiceRecipient (string, optional):
invoice recipient
,
geteInvoiceEmailAddress (string, optional):
einvoice email address
,
iseInvoiceEnabled (boolean, optional):
einvoice enabled
,
directDebitEnabled (boolean, optional):
direct debit enabled
,
vatId (string, optional):
vat id
,
links (Array[Link], optional):
links
,
changeRequest (CustomerContractDetailResponse, optional):
change request
}
Link {
rel (string, optional),
href (string, optional)
}
{
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"companySectorIndustryId": 0,
"companySizeId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"invoiceRecipient": "string",
"geteInvoiceEmailAddress": "string",
"iseInvoiceEnabled": true,
"directDebitEnabled": true,
"vatId": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"changeRequest": {}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerContractDetailRequest {
companyName (string, optional):
company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyStreet (string, optional):
company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
companySectorIndustryId (integer, optional):
sector industry id
,
companySizeId (integer, optional):
company size id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
invoicingCompanyName (string, optional):
invoicing company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyStreet (string, optional):
invoicing company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
invoiceRecipient (string, optional):
invoice recipient
,
geteInvoiceEmailAddress (string, optional):
einvoice email address
,
iseInvoiceEnabled (boolean, optional):
einvoice enabled
,
directDebitEnabled (boolean, optional):
direct debit enabled
,
vatId (string, optional):
vat id
}
{
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"companySectorIndustryId": 0,
"companySizeId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"invoiceRecipient": "string",
"geteInvoiceEmailAddress": "string",
"iseInvoiceEnabled": true,
"directDebitEnabled": true,
"vatId": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 403
Update forbidden
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/CONTRACT_DETAIL/CHANGE_REQUEST
* Returns customer contract detail change request for the authenticated
user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContractDetailResponse {
companyName (string, optional):
company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyStreet (string, optional):
company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
companyZipCode (string, optional):
company zip code
,
companyCity (string, optional):
company city
,
companyCountry (string, optional):
company country
,
companySectorIndustryId (integer, optional):
sector industry id
,
companySizeId (integer, optional):
company size id
,
companyUseCaseId (integer, optional):
company use case id
,
companyUseCase (string, optional):
company use case other text
,
invoicingCompanyName (string, optional):
invoicing company name
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyStreet (string, optional):
invoicing company street
stringReg. Exp.:^$|^([^ ]{1,50})( [^ ]{0,50})?$
,
invoicingCompanyZipCode (string, optional):
invoicing company zip code
,
invoicingCompanyCity (string, optional):
invoicing company city
,
invoicingCompanyCountry (string, optional):
invoicing company country
,
accountBic (string, optional):
account bic
,
accountIban (string, optional):
account iban
,
invoiceRecipient (string, optional):
invoice recipient
,
geteInvoiceEmailAddress (string, optional):
einvoice email address
,
iseInvoiceEnabled (boolean, optional):
einvoice enabled
,
directDebitEnabled (boolean, optional):
direct debit enabled
,
vatId (string, optional):
vat id
,
links (Array[Link], optional):
links
,
changeRequest (CustomerContractDetailResponse, optional):
change request
}
Link {
rel (string, optional),
href (string, optional)
}
{
"companyName": "string",
"companyStreet": "string",
"companyZipCode": "string",
"companyCity": "string",
"companyCountry": "string",
"companySectorIndustryId": 0,
"companySizeId": 0,
"companyUseCaseId": 0,
"companyUseCase": "string",
"invoicingCompanyName": "string",
"invoicingCompanyStreet": "string",
"invoicingCompanyZipCode": "string",
"invoicingCompanyCity": "string",
"invoicingCompanyCountry": "string",
"accountBic": "string",
"accountIban": "string",
"invoiceRecipient": "string",
"geteInvoiceEmailAddress": "string",
"iseInvoiceEnabled": true,
"directDebitEnabled": true,
"vatId": "string",
"links": [
{
"rel": "string",
"href": "string"
}
],
"changeRequest": {}
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/CONTRACT_PAYMENT
* Returns customer contract payment for the authenticated user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContractPaymentResponse {
paymentMethod (string, optional):
payment method
,
valid (boolean, optional):
payment method valid?
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"paymentMethod": "string",
"valid": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/ACCOUNT/CUSTOMER/CONTRACT_PAYMENT
* Updates customer contract payment
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomerContractPaymentResponse {
paymentMethod (string, optional):
payment method
,
valid (boolean, optional):
payment method valid?
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"paymentMethod": "string",
"valid": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
CustomerContractPaymentRequest {
paymentMethod (string, optional):
payment method
}
{
"paymentMethod": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 403
Update forbidden
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/CUSTOMER/CONTRACT_PAYMENT/CC/ORDER
* Adds contract payment order
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CcContractPaymentOrderResponseDto {
orderId (string, optional),
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"orderId": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/CONTRACT_PAYMENT/CC
* Returns customer contract payment cc details for the authenticated
user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CcPaymentApprovalResponse {
expirationMonth (integer, optional):
expirationMonth
,
expirationYear (integer, optional):
expirationYear
,
cardType (string, optional):
cardType
,
firstName (string, optional):
firstName
,
lastName (string, optional):
lastName
,
maskedAccountNumber (string, optional):
maskedAccountNumber
,
provider (string, optional):
provider
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"expirationMonth": 0,
"expirationYear": 0,
"cardType": "string",
"firstName": "string",
"lastName": "string",
"maskedAccountNumber": "string",
"provider": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/CONTRACT_PAYMENT/SEPA
* Returns customer contract payment sepa details for the authenticated
user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SepaPaymentApprovalResponse {
accountIban (string, optional):
account iban
,
accountBic (string, optional):
account bic
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountIban": "string",
"accountBic": "string",
"bankAccept": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/ACCOUNT/CUSTOMER/CONTRACT_PAYMENT/SEPA
* Updates customer contract payment sepa
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SepaPaymentApprovalResponse {
accountIban (string, optional):
account iban
,
accountBic (string, optional):
account bic
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"accountIban": "string",
"accountBic": "string",
"bankAccept": true,
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
SepaPaymentApprovalRequest {
accountIban (string, optional):
account iban
,
accountBic (string, optional):
account bic
,
bankAccept (boolean, optional):
bank accept debit and bank confirm business
}
{
"accountIban": "string",
"accountBic": "string",
"bankAccept": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 403
Update forbidden
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/VOUCHERS
* Returns vouchers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
VoucherResponse
]
VoucherResponse {
type (string, optional):
voucher type
,
id (integer, optional):
voucher id
,
code (string, optional):
voucher code
,
redemptionUrl (string, optional):
redemption url
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"type": "string",
"id": 0,
"code": "string",
"redemptionUrl": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type query
FIQL/RSQL query string
query string search
Search string
query string sort
Sorts response by given fields
query string page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/CUSTOMER/VOUCHERS
* Adds voucher
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
VoucherResponse {
type (string, optional):
voucher type
,
id (integer, optional):
voucher id
,
code (string, optional):
voucher code
,
redemptionUrl (string, optional):
redemption url
,
links (Array[Link], optional):
links
}
Link {
rel (string, optional),
href (string, optional)
}
{
"type": "string",
"id": 0,
"code": "string",
"redemptionUrl": "string",
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
VoucherRequest {
type (string, optional):
voucher type
}
{
"type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 201
Created
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT
* Exports delivery details for the account
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
format
Export format (pdf, csv, xsl)
query string page
Request a specific page
query integer size
Sets size of a page
query integer search
Search string
query string filters
Filters
query string regionCodes
Region Codes
query string from
Start date
query string to
End date
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT/TASKS
* Returns export tasks for account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Inline Model [
ExportResponseDto
]
ExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
[
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer page
Request a specific page
query integer size
Sets size of a page
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT/TASKS
* Creates and executes export task for account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DeliveryDetailsExportResponseDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
filters (string, optional):
Filters
,
regionCodes (string, optional):
Region Codes
,
search (string, optional):
Search
,
id (integer):
id
,
state (AsyncState, optional):
state
,
links (Array[Link], optional):
links
}
AsyncState {
done (boolean, optional):
task done?
,
progress (integer, optional):
progress in percentage
,
error (boolean, optional):
task error?
}
Link {
rel (string, optional),
href (string, optional)
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"filters": "string",
"regionCodes": "string",
"search": "string",
"id": 0,
"state": {
"done": true,
"progress": 0,
"error": true
},
"links": [
{
"rel": "string",
"href": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer body
Parameter content type: application/json
body
* Model
* Model Schema
DeliveryDetailsExportRequestDto {
query (string, optional):
FIQL/RSQL query string
,
sort (string, optional):
Sorts response by given fields
,
page (integer, optional):
Request a specific page
,
size (integer, optional):
Sets size of a page
,
format (string, optional):
Export format (pdf, csv, xsl)
,
from (string, optional):
Start date
,
to (string, optional):
End date
,
filters (string, optional):
Filters
,
regionCodes (string, optional):
Region Codes
,
search (string, optional):
Search
}
{
"query": "string",
"sort": "string",
"page": 0,
"size": 0,
"format": "string",
"from": "string",
"to": "string",
"filters": "string",
"regionCodes": "string",
"search": "string"
}
Click to set as parameter value
async true (default) false
Process request asynchronous
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
Bad request
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/V1/ACCOUNT/CUSTOMER/DELIVERY_DETAILS/ACCOUNTS/{ID}/EXPORT/TASKS/{TASKID}/FILE
* Returns export file
PARAMETERS
Parameter Value Description Parameter Type Data Type id path integer
taskId path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/CUSTOMER/INITIATE_UPGRADE
* Initiates customer upgrade
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
InitiateUpgradeRequest {
mobile (string, optional):
mobile
stringReg. Exp.:\+[0-9]{1,15}
}
{
"mobile": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/ACCOUNT/CUSTOMER/CONFIRM_UPGRADE
* Confirm customer upgrade
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
ConfirmUpgradeRequestDto {
secret (string):
secret
}
{
"secret": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
400
Bad request
404
Not found
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MISC/FEEDBACK
* Sends feedback
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
FeedbackRequest {
content (string):
content
,
replyTo (string, optional):
reply to (optional)
}
{
"content": "string",
"replyTo": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MISC/LOG/PUBLIC
* Writes log
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
LogRequest {
level (string):
level (debug, info, warn, error)
,
category (string, optional):
category
,
message (string):
message
,
stacktrace (Array[string], optional):
message
,
screenshot (string, optional):
screenshot (base64)
}
{
"level": "string",
"category": "string",
"message": "string",
"stacktrace": [
"string"
],
"screenshot": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/MISC/LOG
* Writes log
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
LogRequest {
level (string):
level (debug, info, warn, error)
,
category (string, optional):
category
,
message (string):
message
,
stacktrace (Array[string], optional):
message
,
screenshot (string, optional):
screenshot (base64)
}
{
"level": "string",
"category": "string",
"message": "string",
"stacktrace": [
"string"
],
"screenshot": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
500
Internal server error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
[ BASE URL: /API , API VERSION: 1.0.0 ]