pubapi.t-mobile.bigtincan.info
Open in
urlscan Pro
54.69.184.53
Public Scan
Submitted URL: http://pubapi.t-mobile.bigtincan.info/
Effective URL: https://pubapi.t-mobile.bigtincan.info/doc/interactive/
Submission: On March 06 via api from DE — Scanned from DE
Effective URL: https://pubapi.t-mobile.bigtincan.info/doc/interactive/
Submission: On March 06 via api from DE — Scanned from DE
Form analysis 55 forms found in the DOM
<form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mgroup_id0.9259557381911949">group_id</label></td>
<td>
<input class="parameter required" minlength="1" name="group_id" placeholder="(required)" id="mgroup_id0.9259557381911949" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Group ID</p>
</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Group object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="muser_id0.885151982987612">user_id</label></td>
<td>
<input class="parameter required" minlength="1" name="user_id" placeholder="(required)" id="muser_id0.885151982987612" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>User ID</p>
</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>User object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mchannel_id0.09898185860699038">channel_id</label></td>
<td>
<input class="parameter" minlength="0" name="channel_id" placeholder="" id="mchannel_id0.09898185860699038" type="text" value="">
</td>
<td class="markdown">
<p>Filter groups by channel ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfilter0.9156847636643235">filter</label></td>
<td>
<input class="parameter" minlength="0" name="filter" placeholder="" id="mfilter0.9156847636643235" type="text" value="">
</td>
<td class="markdown">
<p>Set filter</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="minclude_child_data0.31522682801117985">include_child_data</label></td>
<td>
<select class="parameter " name="include_child_data" id="minclude_child_data0.31522682801117985">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Set to true to retrieve an array of users for each group</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="minclude_parent_ids0.2347055016245918">include_parent_ids</label></td>
<td>
<select class="parameter " name="include_parent_ids" id="minclude_parent_ids0.2347055016245918">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Set to true to retrieve an array of channel IDs for each group (admin only)</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="minclude_personal_groups0.43703660361603713">include_personal_groups</label></td>
<td>
<select class="parameter " name="include_personal_groups" id="minclude_personal_groups0.43703660361603713">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Set to true to include personal user groups</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="msort_by0.0708379546443545">sort_by</label></td>
<td>
<input class="parameter" minlength="0" name="sort_by" placeholder="" id="msort_by0.0708379546443545" type="text" value="">
</td>
<td class="markdown">
<p>Sort by fields</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.8534657832728714">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.8534657832728714" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.06000131658010699">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.06000131658010699" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of groups</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mgroup_id0.9769488808453102">group_id</label></td>
<td>
<input class="parameter" minlength="0" name="group_id" placeholder="" id="mgroup_id0.9769488808453102" type="text" value="">
</td>
<td class="markdown">
<p>Filter users by group ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mrole0.9914678184843781">role</label></td>
<td>
<select class="parameter " name="role" id="mrole0.9914678184843781">
<option selected="" value=""></option>
<option value="user"> user </option>
<option value="structure_admin"> structure_admin </option>
<option value="admin"> admin </option>
<option value="company_manager"> company_manager </option>
<option value="super_admin"> super_admin </option>
</select>
</td>
<td class="markdown">
<p>Filter users by role.</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="msearch0.5364926421874514">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.5364926421874514" type="text" value="">
</td>
<td class="markdown">
<p>Key word for searching by user full name or email</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="minclude_groups0.22608903701074223">include_groups</label></td>
<td>
<select class="parameter " name="include_groups" id="minclude_groups0.22608903701074223">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Include user group information.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="msort_by0.2976899579833767">sort_by</label></td>
<td>
<select class="parameter " name="sort_by" id="msort_by0.2976899579833767">
<option selected="" value=""></option>
<option value="badges"> badges </option>
<option value="firstname"> firstname </option>
<option value="jobtitle"> jobtitle </option>
<option value="lastname"> lastname </option>
</select>
</td>
<td class="markdown">
<p>Sort by fields</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.15221457270870897">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.15221457270870897" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.7839837908967877">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.7839837908967877" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of users</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mtab_id0.6252610535158445">tab_id</label></td>
<td>
<input class="parameter" minlength="0" name="tab_id" placeholder="" id="mtab_id0.6252610535158445" type="text" value="">
</td>
<td class="markdown">
<p>Tab ID to filter channels</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.4337960829616414">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.4337960829616414" type="text" value="">
</td>
<td class="markdown">
<p>Key word for searching by channel name</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.5479616881646203">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.5479616881646203" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.5148127216860836">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.5148127216860836" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.6242505846305271">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.6242505846305271" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of channels</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mchannel_id0.23624019965980403">channel_id</label></td>
<td>
<input class="parameter required" minlength="1" name="channel_id" placeholder="(required)" id="mchannel_id0.23624019965980403" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Channel ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="marchive_stories0.34462910193669116">archive_stories</label></td>
<td>
<select class="parameter " name="archive_stories" id="marchive_stories0.34462910193669116">
<option value=""></option>
<option value="true"> true </option>
<option selected="" value="false"> false (default) </option>
</select>
</td>
<td class="markdown">
<p>Whether to archive the stories in the channel</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.6654489147153553">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.6654489147153553" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>Channel deleted.</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mchannel_id0.10980211021316166">channel_id</label></td>
<td>
<input class="parameter required" minlength="1" name="channel_id" placeholder="(required)" id="mchannel_id0.10980211021316166" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Channel id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mbody0.9289649956641264">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.9289649956641264"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6416618272646493" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6416618272646493">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Channel object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Update channel Request {</span>
<div><span class="propName ">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Channel name</p>
</span>,</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Channel description</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cover_art_url</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Cover Art URL</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td></td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">description</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">cover_art_url</span></span>": <span class="hljs-string"><span class="hljs-string">""</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.568097930862991">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.568097930862991" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Channel updated</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.8441784562274304">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.8441784562274304"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7972505289739853" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7972505289739853">
<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="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Add Personal Channel Request {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Channel name</p>
</span>,</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Channel description</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">description</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.10668791052629123">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.10668791052629123" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Channel object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.369020069070388">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.369020069070388"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5255871041859337" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5255871041859337">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Channel object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Add Public Channel Request {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Channel name</p>
</span>,</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Channel description</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">is_hidden</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Use to create a hidden channel</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">tab_id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Tab assigned to the new channel</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cover_art_url</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Cover Art URL</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td></td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">groups</span> (<span class="propType">Array[inline_model_1]</span>): <span class="propDesc markdown">
<p>Groups to be assigned to the new channel</p>
</span></div><span class="strong">}</span><br><span class="strong">inline_model_1 {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Group ID</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">permissions</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Read Write Permission. 1 - Read, 2 - Write, 3 - Read and Write</p>
</span> = <span class="propVals">['1', '2', '3']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2, 3</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">description</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">is_hidden</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">tab_id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">cover_art_url</span></span>": <span class="hljs-string"><span class="hljs-string">""</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">groups</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">permissions</span></span>": <span class="hljs-number"><span class="hljs-number">1</span></span>
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.8586936011703117">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.8586936011703117" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td class="markdown">
<p>Channel object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mopportunity_id0.6185194804736671">opportunity_id</label></td>
<td>
<input class="parameter required" minlength="1" name="opportunity_id" placeholder="(required)" id="mopportunity_id0.6185194804736671" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>CRM opportunity ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mopportunity_stage0.37706263783663996">opportunity_stage</label></td>
<td>
<input class="parameter required" minlength="1" name="opportunity_stage" placeholder="(required)" id="mopportunity_stage0.37706263783663996" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>CRM opportunity stage</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mopportunity_description0.03010353224565776">opportunity_description</label></td>
<td>
<input class="parameter" minlength="0" name="opportunity_description" placeholder="" id="mopportunity_description0.03010353224565776" type="text" value="">
</td>
<td class="markdown">
<p>CRM opportunity description</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msize0.581235976803615">size</label></td>
<td>
<input class="parameter" minlength="0" name="size" placeholder="" id="msize0.581235976803615" type="text" value="">
</td>
<td class="markdown">
<p>Number of recommendations</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch_keywords0.3104168894306347">search_keywords</label></td>
<td>
<input class="parameter" minlength="0" name="search_keywords" placeholder="" id="msearch_keywords0.3104168894306347" type="text" value="">
</td>
<td class="markdown">
<p>Keywords separated by a semi-colon</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcrm_products0.09160982220697345">crm_products</label></td>
<td>
<input class="parameter" minlength="0" name="crm_products" placeholder="" id="mcrm_products0.09160982220697345" type="text" value="">
</td>
<td class="markdown">
<p>JSON array of strings of CRM product names</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Recommendations</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbetween[start]0.23528004739150465">between[start]</label></td>
<td>
<input class="parameter required" minlength="1" name="between[start]" placeholder="(required)" id="mbetween[start]0.23528004739150465" type="text" value="2019-08-01T00:00:00+00:00">
</td>
<td>
<strong><span class="markdown">
<p>Start date filter for events in RFC3339 format</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mbetween[end]0.39311808693288475">between[end]</label></td>
<td>
<input class="parameter required" minlength="1" name="between[end]" placeholder="(required)" id="mbetween[end]0.39311808693288475" type="text" value="2019-08-30T00:00:00+00:00">
</td>
<td>
<strong><span class="markdown">
<p>End date filter for events in RFC3339 format</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mlimit0.30683982556874834">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.30683982556874834" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.2510570994105097">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.2510570994105097" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current 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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>List of events.</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="minclude_groups0.5550466730126717">include_groups</label></td>
<td>
<select class="parameter " name="include_groups" id="minclude_groups0.5550466730126717">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Include groups</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.45380032296775874">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.45380032296775874" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.17724565180772656">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.17724565180772656" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.4438821145985783">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.4438821145985783" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of form categories</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mcategory_id0.6413030054380295">category_id</label></td>
<td>
<input class="parameter" minlength="0" name="category_id" placeholder="" id="mcategory_id0.6413030054380295" type="text" value="">
</td>
<td class="markdown">
<p>Category ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="minclude_groups0.3392011372668109">include_groups</label></td>
<td>
<select class="parameter " name="include_groups" id="minclude_groups0.3392011372668109">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Include groups</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.5651286689151456">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.5651286689151456" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.3061180704571971">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.3061180704571971" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.040182762504288316">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.040182762504288316" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of forms</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mform_id0.3429798909975119">form_id</label></td>
<td>
<input class="parameter required" minlength="1" name="form_id" placeholder="(required)" id="mform_id0.3429798909975119" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Form ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="minclude_data_sources0.9609935484130945">include_data_sources</label></td>
<td>
<select class="parameter " name="include_data_sources" id="minclude_data_sources0.9609935484130945">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Include data sources</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.15378874018687516">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.15378874018687516" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Form object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mform_id0.17491070033141032">form_id</label></td>
<td>
<input class="parameter required" minlength="1" name="form_id" placeholder="(required)" id="mform_id0.17491070033141032" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Form ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="msort0.9366887739565168">sort</label></td>
<td>
<select class="parameter " name="sort" id="msort0.9366887739565168">
<option selected="" value=""></option>
<option value="asc"> asc </option>
<option value="desc"> desc </option>
</select>
</td>
<td class="markdown">
<p>Sort order</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mcursor0.6195921211360664">cursor</label></td>
<td>
<input class="parameter" minlength="0" name="cursor" placeholder="" id="mcursor0.6195921211360664" type="text" value="">
</td>
<td class="markdown">
<p>Form submission ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.6497732511580758">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.6497732511580758" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.25725003377761224">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.25725003377761224" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.4702850364153759">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.4702850364153759" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Form submission data</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mform_id0.4040414808657127">form_id</label></td>
<td>
<input class="parameter required" minlength="1" name="form_id" placeholder="(required)" id="mform_id0.4040414808657127" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Form ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="msubmission_key0.7817571787173418">submission_key</label></td>
<td>
<input class="parameter required" minlength="1" name="submission_key" placeholder="(required)" id="msubmission_key0.7817571787173418" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Submission key</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfilename0.01435836884823316">filename</label></td>
<td>
<input class="parameter required" minlength="1" name="filename" placeholder="(required)" id="mfilename0.01435836884823316" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Filename</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.3710659879473963">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.3710659879473963" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>File download</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="msearch0.0934833680557996">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.0934833680557996" type="text" value="">
</td>
<td class="markdown">
<p>Search keywords</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="minclude_personal_group0.8306477066513263">include_personal_group</label></td>
<td>
<select class="parameter " name="include_personal_group" id="minclude_personal_group0.8306477066513263">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Include personal groups</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.70211712322512">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.70211712322512" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.024508072234054268">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.024508072234054268" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.4348183280210982">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.4348183280210982" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of groups</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.6097269057618038">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.6097269057618038"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6932322772959283" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6932322772959283">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Group object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Add Group Request {</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 ">notes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Group notes</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">notes</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.907246204620572">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.907246204620572" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td class="markdown">
<p>Group object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mgroup_id0.678734368740987">group_id</label></td>
<td>
<input class="parameter required" minlength="1" name="group_id" placeholder="(required)" id="mgroup_id0.678734368740987" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Group ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mbody0.08295928797335606">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.08295928797335606"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2237899782281063" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2237899782281063">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>User ID array</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Add User to Group Request [</span>
<div>Inline Model 1</div><span class="strong">]</span><br><span class="strong">Inline Model 1 {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>User ID</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">is_admin</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Make user a group admin</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">[
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">is_admin</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.19914413921213114">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.19914413921213114" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>User added to group</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.815921624018421">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.815921624018421"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6530056956518511" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6530056956518511">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Interaction object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Record Interaction Request {</span>
<div><span class="propName ">eventid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Event ID</p>
</span>,</div>
<div><span class="propName required">actions</span> (<span class="propType">Array[inline_model_0]</span>): <span class="propDesc markdown">
<p>Interactions.</p>
</span></div><span class="strong">}</span><br><span class="strong">inline_model_0 {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Object ID</p>
</span>,</div>
<div><span class="propName required">action</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Action name</p>
</span>,</div>
<div><span class="propName ">duration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Action duration</p>
</span>,</div>
<div><span class="propName ">on_screen_duration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Action on-screen duration</p>
</span>,</div>
<div><span class="propName ">timestamp</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>When the interaction occurred. Unix timestamp</p>
</span>,</div>
<div><span class="propName ">device_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Device ID</p>
</span>,</div>
<div><span class="propName ">platform</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Platform</p>
</span>,</div>
<div><span class="propName ">latitude</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Latitude</p>
</span>,</div>
<div><span class="propName ">longitude</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Longitude</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">eventid</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">actions</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">action</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">duration</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">on_screen_duration</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">timestamp</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">device_id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">platform</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">latitude</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">longitude</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.5976915279337109">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.5976915279337109" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Interaction recorded</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.46035175267981154">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.46035175267981154" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.5085328514284952">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.5085328514284952" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Share details.</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.12366597714670591">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.12366597714670591"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6353900407827437" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6353900407827437">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Share object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Create Share Request {</span>
<div><span class="propName required">allow_downloads</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Allow file downloads in share</p>
</span>,</div>
<div><span class="propName ">expires_at</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Share expiry datetime in RFC3339 format</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">allow_downloads</span></span>": <span class="hljs-literal"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">expires_at</span></span>": <span class="hljs-string"><span class="hljs-string">"2019-07-17T06:02:43+00:00"</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td class="markdown">
<p>Share successfully created.</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mshare_id0.2519474605953369">share_id</label></td>
<td>
<input class="parameter required" minlength="1" name="share_id" placeholder="(required)" id="mshare_id0.2519474605953369" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Share hash id</p>
</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>Share successfully deleted</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mshare_id0.7684922630194102">share_id</label></td>
<td>
<input class="parameter required" minlength="1" name="share_id" placeholder="(required)" id="mshare_id0.7684922630194102" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Share hash id</p>
</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Share details.</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mshare_id0.25789633606398343">share_id</label></td>
<td>
<input class="parameter required" minlength="1" name="share_id" placeholder="(required)" id="mshare_id0.25789633606398343" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Share hash id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfile_id0.8344208318276956">file_id</label></td>
<td>
<input class="parameter required" minlength="1" name="file_id" placeholder="(required)" id="mfile_id0.8344208318276956" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>File id</p>
</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>File successfully removed from share</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>File does not exist in the share.</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mshare_id0.6371352569020055">share_id</label></td>
<td>
<input class="parameter required" minlength="1" name="share_id" placeholder="(required)" id="mshare_id0.6371352569020055" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Share hash id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfile_id0.6908398074426347">file_id</label></td>
<td>
<input class="parameter required" minlength="1" name="file_id" placeholder="(required)" id="mfile_id0.6908398074426347" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>File id</p>
</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>File successfully added to share</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>File already exists in the share.</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mq0.719797717728891">q</label></td>
<td>
<input class="parameter required" minlength="1" name="q" placeholder="(required)" id="mq0.719797717728891" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Keyword or phrase to search by. Enclose in double quotes for exact matching. Supports asterisks for wildcards.</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mcategory0.3269690341161593">category</label></td>
<td>
<input class="parameter" minlength="0" name="category" placeholder="" id="mcategory0.3269690341161593" type="text" value="">
</td>
<td class="markdown">
<p>Filter files by the internal Hub category classification.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mhidden0.7682728977541635">hidden</label></td>
<td>
<select class="parameter " name="hidden" id="mhidden0.7682728977541635">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Filter files that appear in a hidden primary channel. Null includes all files. True for hidden content only. False for non-hidden content only.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mshareable0.4319677721234785">shareable</label></td>
<td>
<select class="parameter " name="shareable" id="mshareable0.4319677721234785">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Filter shareable files. Null returns all files. True returns files with share_status mandatory or optional. False returns files with share_status blocked.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mcreated_at[gte]0.29754412434014266">created_at[gte]</label></td>
<td>
<input class="parameter" minlength="0" name="created_at[gte]" placeholder="" id="mcreated_at[gte]0.29754412434014266" type="text" value="">
</td>
<td class="markdown">
<p>Filter files that are greater than equal to the created_at date and use with created_at[lte]. Date format must be Y-m-d\TH:i:sP'</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcreated_at[lte]0.9159333921939614">created_at[lte]</label></td>
<td>
<input class="parameter" minlength="0" name="created_at[lte]" placeholder="" id="mcreated_at[lte]0.9159333921939614" type="text" value="">
</td>
<td class="markdown">
<p>Filter files that are less than equal to the created_at date and use with created_at[gte]. Date format must be Y-m-d\TH:i:sP</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mupdated_at[gte]0.011274532730435771">updated_at[gte]</label></td>
<td>
<input class="parameter" minlength="0" name="updated_at[gte]" placeholder="" id="mupdated_at[gte]0.011274532730435771" type="text" value="">
</td>
<td class="markdown">
<p>Filter files that are greater than equal to the updated_at date and use with updated_at[lte]. Date format must be Y-m-d\TH:i:sP</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mupdated_at[lte]0.5105462430533831">updated_at[lte]</label></td>
<td>
<input class="parameter" minlength="0" name="updated_at[lte]" placeholder="" id="mupdated_at[lte]0.5105462430533831" type="text" value="">
</td>
<td class="markdown">
<p>Filter files that are less than equal to the updated_at date and use with updated_at[gte]. Date format must be Y-m-d\TH:i:sP</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort[key]0.6177161137891538">sort[key]</label></td>
<td>
<input class="parameter" minlength="0" name="sort[key]" placeholder="" id="msort[key]0.6177161137891538" type="text" value="">
</td>
<td class="markdown">
<p>Sorts files by key and used with sort[order]. The value for this field are 'title' or 'description' or 'created_at' or 'updated_at'</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort[order]0.8347064119632828">sort[order]</label></td>
<td>
<input class="parameter" minlength="0" name="sort[order]" placeholder="" id="msort[order]0.8347064119632828" type="text" value="">
</td>
<td class="markdown">
<p>Sorts the file search results and used with sort[key]. The value for this field are 'asc' or 'desc'.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mhighlighted_excerpt_length0.13042906800291942">highlighted_excerpt_length</label></td>
<td>
<input class="parameter" minlength="0" name="highlighted_excerpt_length" placeholder="" id="mhighlighted_excerpt_length0.13042906800291942" type="text" value="600">
</td>
<td class="markdown">
<p>Return the number of highlighted excerpt text in search result. Default is 600, min is 100, max is 1000.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="moffset0.00756991829202569">offset</label></td>
<td>
<input class="parameter" minlength="0" name="offset" placeholder="" id="moffset0.00756991829202569" type="text" value="0">
</td>
<td class="markdown">
<p>Starting point to return rows from a result set. Default is 0, min and max is greater than or equal 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.1385189405449574">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.1385189405449574" type="text" value="50">
</td>
<td class="markdown">
<p>Number of results to return. Default is 50, min is 1, max is 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.18306710594122855">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.18306710594122855" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of files</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mq0.8647306076152486">q</label></td>
<td>
<input class="parameter required" minlength="1" name="q" placeholder="(required)" id="mq0.8647306076152486" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Keyword or phrase to search by. Enclose in double quotes for exact matching. Supports asterisks for wildcards.</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mhidden0.6673684982043773">hidden</label></td>
<td>
<select class="parameter " name="hidden" id="mhidden0.6673684982043773">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Filter stories that appear in a hidden primary channel. Null includes all stories. True for hidden content only. False for non-hidden content only.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mshareable0.18874342493317875">shareable</label></td>
<td>
<select class="parameter " name="shareable" id="mshareable0.18874342493317875">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Filter shareable stories. Null returns all stories. True returns stories with sharing enabled. False returns stories with sharing disabled.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mcreated_at[gte]0.13747704569196006">created_at[gte]</label></td>
<td>
<input class="parameter" minlength="0" name="created_at[gte]" placeholder="" id="mcreated_at[gte]0.13747704569196006" type="text" value="">
</td>
<td class="markdown">
<p>Filter stories that are greater than equal to the created_at date and use with created_at[lte]. Date format must be Y-m-d\TH:i:sP'</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcreated_at[lte]0.33318695205076465">created_at[lte]</label></td>
<td>
<input class="parameter" minlength="0" name="created_at[lte]" placeholder="" id="mcreated_at[lte]0.33318695205076465" type="text" value="">
</td>
<td class="markdown">
<p>Filter stories that are less than equal to the created_at date and use with created_at[gte]. Date format must be Y-m-d\TH:i:sP</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mupdated_at[gte]0.27312186177326625">updated_at[gte]</label></td>
<td>
<input class="parameter" minlength="0" name="updated_at[gte]" placeholder="" id="mupdated_at[gte]0.27312186177326625" type="text" value="">
</td>
<td class="markdown">
<p>Filter stories that are greater than equal to the updated_at date and use with updated_at[lte]. Date format must be Y-m-d\TH:i:sP</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mupdated_at[lte]0.4546968427781586">updated_at[lte]</label></td>
<td>
<input class="parameter" minlength="0" name="updated_at[lte]" placeholder="" id="mupdated_at[lte]0.4546968427781586" type="text" value="">
</td>
<td class="markdown">
<p>Filter stories that are less than equal to the updated_at date and use with updated_at[gte]. Date format must be Y-m-d\TH:i:sP</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort[key]0.11646728734513956">sort[key]</label></td>
<td>
<input class="parameter" minlength="0" name="sort[key]" placeholder="" id="msort[key]0.11646728734513956" type="text" value="">
</td>
<td class="markdown">
<p>Sorts stories by key and used with sort[order]. The value for this field are 'title' or 'description' or 'created_at' or 'updated_at'</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort[order]0.6471765607017499">sort[order]</label></td>
<td>
<input class="parameter" minlength="0" name="sort[order]" placeholder="" id="msort[order]0.6471765607017499" type="text" value="">
</td>
<td class="markdown">
<p>Sort the search results and used with sort[key]. The value for this field are 'asc' or 'desc'.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mhighlighted_excerpt_length0.64253832014593">highlighted_excerpt_length</label></td>
<td>
<input class="parameter" minlength="0" name="highlighted_excerpt_length" placeholder="" id="mhighlighted_excerpt_length0.64253832014593" type="text" value="600">
</td>
<td class="markdown">
<p>Return the number of highlighted excerpt text in search result. Default is 600, min is 100, max is 1000.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="moffset0.7733318106207148">offset</label></td>
<td>
<input class="parameter" minlength="0" name="offset" placeholder="" id="moffset0.7733318106207148" type="text" value="0">
</td>
<td class="markdown">
<p>Starting point to return rows from a result set. Default is 0, min and max is greater than or equal 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.7167040376960947">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.7167040376960947" type="text" value="50">
</td>
<td class="markdown">
<p>Number of results to return. Default is 50, min is 1, max is 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.6253454501159412">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.6253454501159412" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of stories</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Settings object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mstory_perm_id0.009604151939262895">story_perm_id</label></td>
<td>
<input class="parameter required" minlength="1" name="story_perm_id" placeholder="(required)" id="mstory_perm_id0.009604151939262895" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Story Perm ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtag0.4906674996499467">tag</label></td>
<td>
<input class="parameter required" minlength="1" name="tag" placeholder="(required)" id="mtag0.4906674996499467" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Tag name</p>
</span></strong>
</td>
<td>formData</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.3713425975680096">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.3713425975680096" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Tag object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrevision_id0.9862917634775819">revision_id</label></td>
<td>
<input class="parameter required" minlength="1" name="revision_id" placeholder="(required)" id="mrevision_id0.9862917634775819" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Active story revision ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.9762974350292679">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.9762974350292679" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Story archived</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrevision_id0.5023058535898028">revision_id</label></td>
<td>
<input class="parameter required" minlength="1" name="revision_id" placeholder="(required)" id="mrevision_id0.5023058535898028" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Story revision ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mcomment0.9969530495897025">comment</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="comment" id="mcomment0.9969530495897025"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6067767478886397" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6067767478886397">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Comment object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Add Comment Request {</span>
<div><span class="propName required">comment</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Comment</p>
</span>,</div>
<div><span class="propName ">reply_to_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Reply to comment ID</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">comment</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">reply_to_id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.3373946185213601">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.3373946185213601" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Comment object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mkeyword0.8069551717666141">keyword</label></td>
<td>
<input class="parameter required" minlength="1" name="keyword" placeholder="(required)" id="mkeyword0.8069551717666141" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Keywords</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.14981818416028836">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.14981818416028836" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.058161450168604745">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.058161450168604745" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfields0.3545668432487863">fields</label></td>
<td>
<input class="parameter" minlength="0" name="fields" placeholder="" id="mfields0.3545668432487863" type="text" value="">
</td>
<td class="markdown">
<p>JSON object of Fields within search type</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtype0.3106000253865633">type</label></td>
<td>
<select class="parameter " name="type" id="mtype0.3106000253865633">
<option selected="" value=""></option>
<option value="stories"> stories </option>
<option value="files"> files </option>
<option value="tags"> tags </option>
</select>
</td>
<td class="markdown">
<p>Search Type</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mfilters0.00976003299760908">filters</label></td>
<td>
<input class="parameter" minlength="0" name="filters" placeholder="" id="mfilters0.00976003299760908" type="text" value="">
</td>
<td class="markdown">
<p>JSON object with array of IDs - List of possible filters are described above</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mdate_filter0.831634231179543">date_filter</label></td>
<td>
<input class="parameter" minlength="0" name="date_filter" placeholder="" id="mdate_filter0.831634231179543" type="text" value="">
</td>
<td class="markdown">
<p>JSON object of Date filter</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mexclude_internal_files0.40051104766219825">exclude_internal_files</label></td>
<td>
<select class="parameter " name="exclude_internal_files" id="mexclude_internal_files0.40051104766219825">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Exclude internal files like btc, btcf, btca, btce</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.6091275305410033">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.6091275305410033" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of stories</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrevision_id0.8793145083885627">revision_id</label></td>
<td>
<input class="parameter required" minlength="1" name="revision_id" placeholder="(required)" id="mrevision_id0.8793145083885627" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Story revision ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mbody0.18113901592109727">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.18113901592109727"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6828451740453054" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6828451740453054">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Share object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Share Story Request {</span>
<div><span class="propName required">subject</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Share subject</p>
</span>,</div>
<div><span class="propName ">note</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Share description</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">lang_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Language code</p>
</span> = <span class="propVals">['en-us', 'en-gb', 'zh-cn', 'zh-hk', 'fr', 'it', 'ja', 'ko', 'pt-br', 'ru', 'es', 'th', 'da', 'de', 'no', 'sv', 'tr', 'vi']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>en-us</td>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"en-us", "en-gb", "zh-cn", "zh-hk", "fr", "it", "ja", "ko", "pt-br", "ru", "es", "th", "da", "de", "no", "sv", "tr", "vi"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">emails</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>Email addresses</p>
</span>,</div>
<div><span class="propName ">cc_emails</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>CC email addresses</p>
</span>,</div>
<div><span class="propName ">file_id</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>File IDs</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">subject</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">note</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">lang_code</span></span>": <span class="hljs-string"><span class="hljs-string">"en-us"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">emails</span></span>": [
<span class="hljs-string"><span class="hljs-string">"string"</span></span>
],
"<span class="hljs-attr"><span class="hljs-attr">cc_emails</span></span>": [
<span class="hljs-string"><span class="hljs-string">"string"</span></span>
],
"<span class="hljs-attr"><span class="hljs-attr">file_id</span></span>": [
<span class="hljs-string"><span class="hljs-string">"string"</span></span>
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.39642189718591103">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.39642189718591103" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Share sent</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mupload_type0.7844499119151662">upload_type</label></td>
<td>
<select class="parameter required " name="upload_type" id="mupload_type0.7844499119151662">
<option value="file"> file </option>
</select>
</td>
<td class="markdown">
<p><strong>Upload type</strong></p>
</td>
<td>formData</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfiles0.10941076509713032">files</label></td>
<td>
<input class="parameter" type="file" name="files" id="mfiles0.10941076509713032">
</td>
<td>
<strong><span class="markdown">
<p>Files</p>
</span></strong>
</td>
<td>formData</td>
<td><span class="model-signature">file</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.7600046357818877">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.7600046357818877" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>File object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mstory_perm_id0.394107110579516">story_perm_id</label></td>
<td>
<input class="parameter required" minlength="1" name="story_perm_id" placeholder="(required)" id="mstory_perm_id0.394107110579516" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Story Perm ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.8511744996507955">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.8511744996507955" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Story object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.8745599644659103">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.8745599644659103"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.720752189965099" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.720752189965099">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Story object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Add Story Request {</span>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Story title</p>
</span>,</div>
<div><span class="propName required">channels</span> (<span class="propType">Array[inline_model_2]</span>): <span class="propDesc markdown">
<p>Channels</p>
</span>,</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">excerpt</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">new_files</span> (<span class="propType">Array[Story File Request Object]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Files</p>
</span>,</div>
<div><span class="propName ">events</span> (<span class="propType">Array[Story Event Request Object]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Events</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[Story Tag Request Object]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Tag objects</p>
</span>,</div>
<div><span class="propName ">sharing_bitmask</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">is_password_protected</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">can_annotate</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>true</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">is_notifications_enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>true</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">is_publicly_accessible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">quicklink_url</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">quicklink_fallback</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">quickfile</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">cover_art_url</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">Default:</td>
<td></td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span><br><span class="strong">inline_model_2 {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Channel ID</p>
</span></div><span class="strong">}</span><br><span class="strong">Story File Request Object {</span>
<div><span class="propName required">filename</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">description</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">share_status</span> (<span class="propType">string</span>) = <span class="propVals">['mandatory', 'optional', 'blocked']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"mandatory", "optional", "blocked"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[Story Tag Request Object]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Tag objects</p>
</span></div><span class="strong">}</span><br><span class="strong">Story Event Request Object {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">title</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">tz</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">start</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Unix timestamp</p>
</span>,</div>
<div><span class="propName required">end</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Unix timestamp</p>
</span>,</div>
<div><span class="propName required">all_day</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>All day event</p>
</span></div><span class="strong">}</span><br><span class="strong">Story Tag Request Object {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">title</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">channels</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
],
"<span class="hljs-attr"><span class="hljs-attr">description</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">excerpt</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">new_files</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">filename</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">description</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">share_status</span></span>": <span class="hljs-string"><span class="hljs-string">"mandatory"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">tags</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
]
}
],
"<span class="hljs-attr"><span class="hljs-attr">events</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">title</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">tz</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">start</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">end</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">all_day</span></span>": <span class="hljs-literal"><span class="hljs-literal">true</span></span>
}
],
"<span class="hljs-attr"><span class="hljs-attr">tags</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
],
"<span class="hljs-attr"><span class="hljs-attr">sharing_bitmask</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">is_password_protected</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">can_annotate</span></span>": <span class="hljs-literal"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">is_notifications_enabled</span></span>": <span class="hljs-literal"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">is_publicly_accessible</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">quicklink_url</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">quicklink_fallback</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">quickfile</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">cover_art_url</span></span>": <span class="hljs-string"><span class="hljs-string">""</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.7358741587996918">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.7358741587996918" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td class="markdown">
<p>Story object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrevision_id0.34964347268140283">revision_id</label></td>
<td>
<input class="parameter required" minlength="1" name="revision_id" placeholder="(required)" id="mrevision_id0.34964347268140283" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Story revision ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mbody0.20446299732392315">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.20446299732392315"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.08622344487600286" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.08622344487600286">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Story object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Update Story Request {</span>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Story title</p>
</span>,</div>
<div><span class="propName required">channels</span> (<span class="propType">Array[inline_model_3]</span>): <span class="propDesc markdown">
<p>Channels</p>
</span>,</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">excerpt</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">new_files</span> (<span class="propType">Array[Story File Request Object]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>New files</p>
</span>,</div>
<div><span class="propName ">files</span> (<span class="propType">Array[Story File Request Object]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Existing files</p>
</span>,</div>
<div><span class="propName ">append_files</span> (<span class="propType">Array[Story File Request Object]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Append files to the story</p>
</span>,</div>
<div><span class="propName ">remove_files</span> (<span class="propType">Array[inline_model_4]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Remove files from the story</p>
</span>,</div>
<div><span class="propName ">events</span> (<span class="propType">Array[Story Event Request Object]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Event objects</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[Story Tag Request Object]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Tag objects</p>
</span>,</div>
<div><span class="propName ">sharing_bitmask</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">is_password_protected</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">can_annotate</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>true</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">is_notifications_enabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>true</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">is_publicly_accessible</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">quicklink_url</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">quicklink_fallback</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">quickfile</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">cover_art_url</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">inline_model_3 {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Channel ID</p>
</span></div><span class="strong">}</span><br><span class="strong">Story File Request Object {</span>
<div><span class="propName required">filename</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">description</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">share_status</span> (<span class="propType">string</span>) = <span class="propVals">['mandatory', 'optional', 'blocked']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"mandatory", "optional", "blocked"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[Story Tag Request Object]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Tag objects</p>
</span></div><span class="strong">}</span><br><span class="strong">inline_model_4 {</span>
<div><span class="propName ">filename</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Story Event Request Object {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">title</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">tz</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">start</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Unix timestamp</p>
</span>,</div>
<div><span class="propName required">end</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Unix timestamp</p>
</span>,</div>
<div><span class="propName required">all_day</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>All day event</p>
</span></div><span class="strong">}</span><br><span class="strong">Story Tag Request Object {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">title</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">channels</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
],
"<span class="hljs-attr"><span class="hljs-attr">description</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">excerpt</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">new_files</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">filename</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">description</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">share_status</span></span>": <span class="hljs-string"><span class="hljs-string">"mandatory"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">tags</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
]
}
],
"<span class="hljs-attr"><span class="hljs-attr">files</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">filename</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">description</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">share_status</span></span>": <span class="hljs-string"><span class="hljs-string">"mandatory"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">tags</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
]
}
],
"<span class="hljs-attr"><span class="hljs-attr">append_files</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">filename</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">description</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">share_status</span></span>": <span class="hljs-string"><span class="hljs-string">"mandatory"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">tags</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
]
}
],
"<span class="hljs-attr"><span class="hljs-attr">remove_files</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">filename</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
],
"<span class="hljs-attr"><span class="hljs-attr">events</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">title</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">tz</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">start</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">end</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">all_day</span></span>": <span class="hljs-literal"><span class="hljs-literal">true</span></span>
}
],
"<span class="hljs-attr"><span class="hljs-attr">tags</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
],
"<span class="hljs-attr"><span class="hljs-attr">sharing_bitmask</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">is_password_protected</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">can_annotate</span></span>": <span class="hljs-literal"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">is_notifications_enabled</span></span>": <span class="hljs-literal"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">is_publicly_accessible</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">quicklink_url</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">quicklink_fallback</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">quickfile</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">cover_art_url</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.8159062126304446">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.8159062126304446" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td class="markdown">
<p>Story object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mchannel_id0.37961546989856454">channel_id</label></td>
<td>
<input class="parameter" minlength="0" name="channel_id" placeholder="" id="mchannel_id0.37961546989856454" type="text" value="">
</td>
<td class="markdown">
<p>Channel ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.6749009767963148">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.6749009767963148" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.15989679638328225">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.15989679638328225" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort_by0.7726464415593679">sort_by</label></td>
<td>
<select class="parameter " name="sort_by" id="msort_by0.7726464415593679">
<option selected="" value=""></option>
<option value="date"> date </option>
<option value="likes"> likes </option>
<option value="most_read"> most_read </option>
<option value="least_read"> least_read </option>
<option value="author_first_name"> author_first_name </option>
<option value="author_last_name"> author_last_name </option>
<option value="priority_order"> priority_order </option>
<option value="content_score"> content_score </option>
<option value="title"> title </option>
</select>
</td>
<td class="markdown">
<p>Sort by fields</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="minclude_comments0.49820556920731707">include_comments</label></td>
<td>
<select class="parameter " name="include_comments" id="minclude_comments0.49820556920731707">
<option value=""></option>
<option value="true"> true </option>
<option selected="" value="false"> false (default) </option>
</select>
</td>
<td class="markdown">
<p>Include comments to story</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.49004932742383067">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.49004932742383067" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of stories</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="msearch0.038266576181744894">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.038266576181744894" type="text" value="">
</td>
<td class="markdown">
<p>Search by tab name</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpage0.06483977577128397">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.06483977577128397" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.021104494396075868">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.021104494396075868" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.21145409866487985">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.21145409866487985" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of tabs</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.2836257933253328">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.2836257933253328"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.911260684432466" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.911260684432466">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Tab object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Add Tab Request {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Tab name</p>
</span>,</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Tab description</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">description</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.1183757482183252">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.1183757482183252" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td class="markdown">
<p>Tab object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtab_id0.21982317938612406">tab_id</label></td>
<td>
<input class="parameter required" minlength="1" name="tab_id" placeholder="(required)" id="mtab_id0.21982317938612406" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Tab ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mchannel_id0.1732339189978649">channel_id</label></td>
<td>
<input class="parameter required" minlength="1" name="channel_id" placeholder="(required)" id="mchannel_id0.1732339189978649" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Channel ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mbody0.5055342385115777">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.5055342385115777"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9299819827997027" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9299819827997027">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Group object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Add Group To Tab Request {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Group ID</p>
</span>,</div>
<div><span class="propName required">permissions</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Permissions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">permissions</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.7408594874745917">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.7408594874745917" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Relationship object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtab_id0.46468603122217345">tab_id</label></td>
<td>
<input class="parameter required" minlength="1" name="tab_id" placeholder="(required)" id="mtab_id0.46468603122217345" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Tab ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mchannel_id0.4381302634947619">channel_id</label></td>
<td>
<input class="parameter required" minlength="1" name="channel_id" placeholder="(required)" id="mchannel_id0.4381302634947619" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Channel ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mgroup_id0.2519156001944418">group_id</label></td>
<td>
<input class="parameter required" minlength="1" name="group_id" placeholder="(required)" id="mgroup_id0.2519156001944418" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Group ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.15957422783454045">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.15957422783454045" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>Group removed from tab</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtab_id0.864047203109467">tab_id</label></td>
<td>
<input class="parameter required" minlength="1" name="tab_id" placeholder="(required)" id="mtab_id0.864047203109467" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Tab ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.9526823392191948">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.9526823392191948" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>Tab deleted</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="muser_id0.02830741539524939">user_id</label></td>
<td>
<input class="parameter required" minlength="1" name="user_id" placeholder="(required)" id="muser_id0.02830741539524939" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Active user id</p>
</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>User Delete</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.13049718547207645">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.13049718547207645"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.316097691578185" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.316097691578185">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Change password object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Change Password Request {</span>
<div><span class="propName required">currentPassword</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Current 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">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">currentPassword</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">newPassword</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Password reset successfully</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.6704290877129213">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.6704290877129213"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.35786566346247106" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.35786566346247106">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Reset password object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Reset Password Request {</span>
<div><span class="propName required">email</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Email address</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">email</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Reset password email sent</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mAs-User0.4149956445894065">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.4149956445894065" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>User object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="muser_id0.1304578568796948">user_id</label></td>
<td>
<input class="parameter required" minlength="1" name="user_id" placeholder="(required)" id="muser_id0.1304578568796948" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>User ID</p>
</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of a user's metadata.</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="muser_id0.015065547940244395">user_id</label></td>
<td>
<input class="parameter required" minlength="1" name="user_id" placeholder="(required)" id="muser_id0.015065547940244395" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>User ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muser_metadata_values0.06476793435104344">user_metadata_values</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="user_metadata_values" id="muser_metadata_values0.06476793435104344"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4586817889220902" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4586817889220902">
<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="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Update User Metadata Request [</span>
<div>Inline Model 1</div><span class="strong">]</span><br><span class="strong">Inline Model 1 {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>User Metadata Value ID</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">[
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>User metadata updated successfully.</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.321359032786666">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.321359032786666"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3423740671752251" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3423740671752251">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>User object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Update User Request {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>User ID</p>
</span>,</div>
<div><span class="propName ">first_name</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 ">last_name</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 ">email</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 ">new_password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Updated password</p>
</span>,</div>
<div><span class="propName ">configuration_bundle</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Configuration bundle ID</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">digest_email</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>0: Never, 1: Daily, 2: Weekly, 3: Monthly</p>
</span> = <span class="propVals">['0', '1', '2', '3']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2, 3</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">send_invite</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Send invitation email</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">access</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>User access level. 0: User, 2: Structure Admin, 4: Administrator</p>
</span> = <span class="propVals">['0', '2', '4']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 2, 4</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">job_title</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 ">can_promote</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Can promote stories</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">lang_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Language code</p>
</span> = <span class="propVals">['en-us', 'en-gb', 'zh-cn', 'zh-hk', 'fr', 'it', 'ja', 'ko', 'pt-br', 'ru', 'es', 'th', 'da', 'de', 'no', 'sv', 'tr', 'vi']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>en-us</td>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"en-us", "en-gb", "zh-cn", "zh-hk", "fr", "it", "ja", "ko", "pt-br", "ru", "es", "th", "da", "de", "no", "sv", "tr", "vi"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">user_timezone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Timezone</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">status</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>User status</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>active</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">enable_company_reports</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">enable_personal_reports</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">enable_advanced_reports</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">groups</span> (<span class="propType">Array[inline_model_6]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">platforms</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">inline_model_6 {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Group ID</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">is_group_admin</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Is group administrator</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">first_name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">last_name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">email</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">new_password</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">configuration_bundle</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">digest_email</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">send_invite</span></span>": <span class="hljs-literal"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">access</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">job_title</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">can_promote</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">lang_code</span></span>": <span class="hljs-string"><span class="hljs-string">"en-us"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">user_timezone</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">status</span></span>": <span class="hljs-string"><span class="hljs-string">"active"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">enable_company_reports</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">enable_personal_reports</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">enable_advanced_reports</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">groups</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">is_group_admin</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>
}
],
"<span class="hljs-attr"><span class="hljs-attr">platforms</span></span>": [
<span class="hljs-string"><span class="hljs-string">"web"</span></span>
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.7571867426008307">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.7571867426008307" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>User object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbody0.1751359031177102">body</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body" id="mbody0.1751359031177102"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1548304972831298" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1548304972831298">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>User object</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Add User Request {</span>
<div><span class="propName required">first_name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>First name</p>
</span>,</div>
<div><span class="propName required">last_name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Last name</p>
</span>,</div>
<div><span class="propName required">email</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Email address</p>
</span>,</div>
<div><span class="propName ">new_password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Updated password</p>
</span>,</div>
<div><span class="propName ">configuration_bundle</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Configuration bundle ID</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">digest_email</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>0: Never, 1: Daily, 2: Weekly, 3: Monthly</p>
</span> = <span class="propVals">['0', '1', '2', '3']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2, 3</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">send_invite</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Send invitation email</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">access</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>User access level. 0: User, 2: Structure Admin, 4: Administrator</p>
</span> = <span class="propVals">['0', '2', '4']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 2, 4</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">job_title</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 ">can_promote</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Can promote stories</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">lang_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Language code</p>
</span> = <span class="propVals">['en-us', 'en-gb', 'zh-cn', 'zh-hk', 'fr', 'it', 'ja', 'ko', 'pt-br', 'ru', 'es', 'th', 'da', 'de', 'no', 'sv', 'tr', 'vi']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>en-us</td>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"en-us", "en-gb", "zh-cn", "zh-hk", "fr", "it", "ja", "ko", "pt-br", "ru", "es", "th", "da", "de", "no", "sv", "tr", "vi"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">user_timezone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Timezone</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">status</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>User status</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>invited</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">enable_company_reports</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">enable_personal_reports</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">enable_advanced_reports</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">groups</span> (<span class="propType">Array[inline_model_5]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">platforms</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">inline_model_5 {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Group ID</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">is_group_admin</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Is group administrator</p>
</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">boolean</th>
</tr>
<tr>
<td class="optionName">Default:</td>
<td>false</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">{
"<span class="hljs-attr"><span class="hljs-attr">first_name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">last_name</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">email</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">new_password</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">configuration_bundle</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">digest_email</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">send_invite</span></span>": <span class="hljs-literal"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">access</span></span>": <span class="hljs-number"><span class="hljs-number">0</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">job_title</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">can_promote</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">lang_code</span></span>": <span class="hljs-string"><span class="hljs-string">"en-us"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">user_timezone</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">status</span></span>": <span class="hljs-string"><span class="hljs-string">"invited"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">enable_company_reports</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">enable_personal_reports</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">enable_advanced_reports</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">groups</span></span>": [
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>,
"<span class="hljs-attr"><span class="hljs-attr">is_group_admin</span></span>": <span class="hljs-literal"><span class="hljs-literal">false</span></span>
}
],
"<span class="hljs-attr"><span class="hljs-attr">platforms</span></span>": [
<span class="hljs-string"><span class="hljs-string">"web"</span></span>
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mAs-User0.16428758272656996">As-User</label></td>
<td>
<input class="parameter" minlength="0" name="As-User" placeholder="" id="mAs-User0.16428758272656996" type="text" value="">
</td>
<td class="markdown">
<p>Perform action on behalf of this user ID.</p>
</td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td class="markdown">
<p>User object</p>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Bad request</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mpage0.47194290508389125">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.47194290508389125" type="text" value="">
</td>
<td class="markdown">
<p>Pagination: current page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.6882909747089316">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.6882909747089316" type="text" value="10">
</td>
<td class="markdown">
<p>Pagination: results per page. Max 100</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of user metadata.</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="muser_id0.8423506548969586">user_id</label></td>
<td>
<input class="parameter required" minlength="1" name="user_id" placeholder="(required)" id="muser_id0.8423506548969586" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>User ID</p>
</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 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>A list of a user's metadata.</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="muser_id0.6723458164464751">user_id</label></td>
<td>
<input class="parameter required" minlength="1" name="user_id" placeholder="(required)" id="muser_id0.6723458164464751" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>User ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muser_metadata_values0.48602101036377876">user_metadata_values</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="user_metadata_values" id="muser_metadata_values0.48602101036377876"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7737103506668068" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7737103506668068">
<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="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Update User Metadata Request [</span>
<div>Inline Model 1</div><span class="strong">]</span><br><span class="strong">Inline Model 1 {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>User Metadata Value ID</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet">
<div class="snippet_json">
<pre><code class="hljs json">[
{
"<span class="hljs-attr"><span class="hljs-attr">id</span></span>": <span class="hljs-string"><span class="hljs-string">"string"</span></span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth error-response-table">
<thead>
<tr>
<th data-sw-translate="">HTTP Status & Error Code</th>
<th data-sw-translate="">Reason</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>User metadata updated successfully.</p>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Not found</p>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Validation error</p>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form>Text Content
BigtincanTM
BIGTINCAN HUB PUBLIC API
API KEY AUTHENTICATION
Use your OAuth2.0 details to explore the API.
Client ID
Client Secret
API Key
Access Token
Extra configuration
ADDITIONAL HEADERS
These headers are only available when using API Key Authentication.
The As-User field allows applications to perform actions on behalf of users
within their tenant.
Admin APIs do not support the As-User header.
To perform an action on behalf of a user you will need to pass this as a header:
As-User: USER_ID
As-User
Get Token
Refresh Token
USER AUTHENTICATION
Alternatively, log in using your Bigtincan Hub account.
User Login
Bigtincan Hub Public API
* ADMIN
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/ADMIN/GROUP/GET/{GROUP_ID}
* Get a group.
IMPLEMENTATION NOTES
Get a group.
PARAMETERS
Parameter Value Description Parameter Type Data Type group_id
Group ID
path string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Group object
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/ADMIN/USER/GET/{USER_ID}
* Get a user.
IMPLEMENTATION NOTES
Get a user.
PARAMETERS
Parameter Value Description Parameter Type Data Type user_id
User ID
path string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
User object
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.1/ADMIN/GROUP/ALL
* Retrieve groups.
IMPLEMENTATION NOTES
Retrieve groups.
PARAMETERS
Parameter Value Description Parameter Type Data Type channel_id
Filter groups by channel ID
query string filter
Set filter
query string include_child_data true false
Set to true to retrieve an array of users for each group
query boolean include_parent_ids true false
Set to true to retrieve an array of channel IDs for each group (admin
only)
query boolean include_personal_groups true false
Set to true to include personal user groups
query boolean sort_by
Sort by fields
query string page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of groups
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.1/ADMIN/USER/ALL
* Retrieve users.
IMPLEMENTATION NOTES
Retrieve users.
PARAMETERS
Parameter Value Description Parameter Type Data Type group_id
Filter users by group ID
query string role user structure_admin admin company_manager super_admin
Filter users by role.
query string search
Key word for searching by user full name or email
query string include_groups true false
Include user group information.
query boolean sort_by badges firstname jobtitle lastname
Sort by fields
query string page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of users
401
Unauthorized
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CHANNEL
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/CHANNEL/ALL
* Retrieve channels.
IMPLEMENTATION NOTES
Retrieve channels. Channel access is limited to the requester's group
associations.
PARAMETERS
Parameter Value Description Parameter Type Data Type tab_id
Tab ID to filter channels
query string search
Key word for searching by channel name
query string page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of channels
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/CHANNEL/{CHANNEL_ID}
* Delete a channel.
IMPLEMENTATION NOTES
Delete a channel.
PARAMETERS
Parameter Value Description Parameter Type Data Type channel_id
Channel ID
path string archive_stories true false (default)
Whether to archive the stories in the channel
query boolean As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 204
Channel deleted.
401
Unauthorized
403
Forbidden
404
Not found
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /V1/CHANNEL/{CHANNEL_ID}
* Update a channel.
IMPLEMENTATION NOTES
Update a channel.
PARAMETERS
Parameter Value Description Parameter Type Data Type channel_id
Channel id
path string body
Parameter content type: application/json
Channel object
body
* Model
* Example Value
Update channel Request {
name (string, optional):
Channel name
,
description (string, optional):
Channel description
,
cover_art_url (string, optional):
Cover Art URL
stringDefault:
}
{
"name": "string",
"description": "string",
"cover_art_url": ""
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Channel updated
400
Bad request
401
Unauthorized
403
Forbidden
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/CHANNEL/PERSONAL/ADD
* Create a personal channel.
IMPLEMENTATION NOTES
Create a personal channel.
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Example Value
Add Personal Channel Request {
name (string):
Channel name
,
description (string, optional):
Channel description
}
{
"name": "string",
"description": "string"
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Channel object
400
Bad request
401
Unauthorized
403
Forbidden
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.1/CHANNEL
* Create a channel.
IMPLEMENTATION NOTES
Create a channel.
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Channel object
body
* Model
* Example Value
Add Public Channel Request {
name (string):
Channel name
,
description (string, optional):
Channel description
,
is_hidden (boolean, optional):
Use to create a hidden channel
booleanDefault:false
,
tab_id (string):
Tab assigned to the new channel
,
cover_art_url (string, optional):
Cover Art URL
stringDefault:
,
groups (Array[inline_model_1]):
Groups to be assigned to the new channel
}
inline_model_1 {
id (string):
Group ID
,
permissions (integer):
Read Write Permission. 1 - Read, 2 - Write, 3 - Read and Write
= ['1', '2', '3']
integerEnum:1, 2, 3
}
{
"name": "string",
"description": "string",
"is_hidden": false,
"tab_id": "string",
"cover_art_url": "",
"groups": [
{
"id": "string",
"permissions": 1
}
]
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 201
Channel object
400
Bad request
401
Unauthorized
403
Forbidden
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CRM
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/STORY/CRM/RECOMMENDATION
* Retrieve story CRM recommendations.
IMPLEMENTATION NOTES
Story CRM recommendations are based on the provided keywords and CRM metadata set on stories.
Files will be returned based on the provided keywords.
Stories will be returned based on CRM metadata. If no results are found via metadata then stories will be returned based on the provided keywords.
PARAMETERS
Parameter Value Description Parameter Type Data Type opportunity_id
CRM opportunity ID
query string opportunity_stage
CRM opportunity stage
query string opportunity_description
CRM opportunity description
query string size
Number of recommendations
query integer search_keywords
Keywords separated by a semi-colon
query string crm_products
JSON array of strings of CRM product names
query string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Recommendations
401
Unauthorized
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* EVENT
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/EVENTS
* Retrieve a user's events.
IMPLEMENTATION NOTES
Retrieve a user's events.
PARAMETERS
Parameter Value Description Parameter Type Data Type between[start]
Start date filter for events in RFC3339 format
query string between[end]
End date filter for events in RFC3339 format
query string limit
Pagination: results per page. Max 100
query integer page
Pagination: current page
query integer
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
List of events.
401
Unauthorized
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* FORM
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/FORM_CATEGORY/ALL
* Retrieve form categories.
IMPLEMENTATION NOTES
Retrieve form categories.
PARAMETERS
Parameter Value Description Parameter Type Data Type include_groups true
false
Include groups
query boolean page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of form categories
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/FORM/ALL
* Retrieve forms.
IMPLEMENTATION NOTES
Retrieve forms.
PARAMETERS
Parameter Value Description Parameter Type Data Type category_id
Category ID
query string include_groups true false
Include groups
query boolean page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of forms
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/FORM/GET/{FORM_ID}
* Get a form.
IMPLEMENTATION NOTES
Get a form.
PARAMETERS
Parameter Value Description Parameter Type Data Type form_id
Form ID
path string include_data_sources true false
Include data sources
query boolean As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Form object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/FORM/DATA/{FORM_ID}
* Retrieve form data.
IMPLEMENTATION NOTES
Retrieve form data.
PARAMETERS
Parameter Value Description Parameter Type Data Type form_id
Form ID
path string sort asc desc
Sort order
query string cursor
Form submission ID
query string page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Form submission data
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/FORM/GET_FILE/{FORM_ID}/{SUBMISSION_KEY}/{FILENAME}
* Get a form file.
IMPLEMENTATION NOTES
Get a form file.
PARAMETERS
Parameter Value Description Parameter Type Data Type form_id
Form ID
path string submission_key
Submission key
path string filename
Filename
path string As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
File download
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* GROUP
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/GROUP/ALL
* Retrieve groups.
IMPLEMENTATION NOTES
Retrieve groups.
PARAMETERS
Parameter Value Description Parameter Type Data Type search
Search keywords
query string include_personal_group true false
Include personal groups
query boolean page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of groups
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/GROUP
* Create a group.
IMPLEMENTATION NOTES
Create a group.
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Group object
body
* Model
* Example Value
Add Group Request {
name (string):
Group name
,
notes (string, optional):
Group notes
}
{
"name": "string",
"notes": "string"
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 201
Group object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/GROUP/{GROUP_ID}/USERS
* Adds users to a group.
IMPLEMENTATION NOTES
Adds users to a group.
PARAMETERS
Parameter Value Description Parameter Type Data Type group_id
Group ID
path string body
Parameter content type: application/json
User ID array
body
* Model
* Example Value
Add User to Group Request [
Inline Model 1
]
Inline Model 1 {
id (string, optional):
User ID
,
is_admin (boolean, optional):
Make user a group admin
booleanDefault:false
}
[
{
"id": "string",
"is_admin": false
}
]
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
User added to group
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* HISTORY
* Show/Hide
* List Operations
* Expand Operations
* * POST /V1/TRACK_INTERACTIONS
* Record user interactions.
IMPLEMENTATION NOTES
Record user interactions.
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Interaction object
body
* Model
* Example Value
Record Interaction Request {
eventid (string, optional):
Event ID
,
actions (Array[inline_model_0]):
Interactions.
}
inline_model_0 {
id (string):
Object ID
,
action (string):
Action name
,
duration (integer, optional):
Action duration
,
on_screen_duration (integer, optional):
Action on-screen duration
,
timestamp (integer, optional):
When the interaction occurred. Unix timestamp
,
device_id (string, optional):
Device ID
,
platform (string, optional):
Platform
,
latitude (string, optional):
Latitude
,
longitude (string, optional):
Longitude
}
{
"eventid": "string",
"actions": [
{
"id": "string",
"action": "string",
"duration": 0,
"on_screen_duration": 0,
"timestamp": 0,
"device_id": "string",
"platform": "string",
"latitude": "string",
"longitude": "string"
}
]
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Interaction recorded
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PUBLIC FILE SHARE
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/SHARES
* Retrieve a user's shares.
IMPLEMENTATION NOTES
Retrieve a user's shares.
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Share details.
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/SHARES
* Create a share.
IMPLEMENTATION NOTES
Create a share.
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Share object
body
* Model
* Example Value
Create Share Request {
allow_downloads (boolean):
Allow file downloads in share
,
expires_at (string, optional):
Share expiry datetime in RFC3339 format
}
{
"allow_downloads": true,
"expires_at": "2019-07-17T06:02:43+00:00"
}
RESPONSE MESSAGES
HTTP Status & Error Code Reason 201
Share successfully created.
401
Unauthorized
404
Not found
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/SHARES/{SHARE_ID}
* Delete a share.
IMPLEMENTATION NOTES
Delete a share.
PARAMETERS
Parameter Value Description Parameter Type Data Type share_id
Share hash id
path string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 204
Share successfully deleted
401
Unauthorized
403
Forbidden
404
Not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/SHARES/{SHARE_ID}
* Retrieve a share.
IMPLEMENTATION NOTES
Retrieve a share.
PARAMETERS
Parameter Value Description Parameter Type Data Type share_id
Share hash id
path string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Share details.
401
Unauthorized
403
Forbidden
404
Not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/SHARES/{SHARE_ID}/FILES/{FILE_ID}
* Remove a file from a share.
IMPLEMENTATION NOTES
Remove a file from a share.
PARAMETERS
Parameter Value Description Parameter Type Data Type share_id
Share hash id
path string file_id
File id
path string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 204
File successfully removed from share
401
Unauthorized
403
Forbidden
404
Not found
422
File does not exist in the share.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/SHARES/{SHARE_ID}/FILES/{FILE_ID}
* Add a file to a share.
IMPLEMENTATION NOTES
Add a file to a share. Returns a Content-Location header that contains a
landing page URL with the added file selected.
PARAMETERS
Parameter Value Description Parameter Type Data Type share_id
Share hash id
path string file_id
File id
path string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 204
File successfully added to share
401
Unauthorized
403
Forbidden
404
Not found
422
File already exists in the share.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SEARCH
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1.2/SEARCH/FILES
* Search for files.
IMPLEMENTATION NOTES
Search for files.
PARAMETERS
Parameter Value Description Parameter Type Data Type q
Keyword or phrase to search by. Enclose in double quotes for exact
matching. Supports asterisks for wildcards.
query string category
Filter files by the internal Hub category classification.
query string hidden true false
Filter files that appear in a hidden primary channel. Null includes all
files. True for hidden content only. False for non-hidden content only.
query boolean shareable true false
Filter shareable files. Null returns all files. True returns files with
share_status mandatory or optional. False returns files with share_status
blocked.
query boolean created_at[gte]
Filter files that are greater than equal to the created_at date and use
with created_at[lte]. Date format must be Y-m-d\TH:i:sP'
query string created_at[lte]
Filter files that are less than equal to the created_at date and use with
created_at[gte]. Date format must be Y-m-d\TH:i:sP
query string updated_at[gte]
Filter files that are greater than equal to the updated_at date and use
with updated_at[lte]. Date format must be Y-m-d\TH:i:sP
query string updated_at[lte]
Filter files that are less than equal to the updated_at date and use with
updated_at[gte]. Date format must be Y-m-d\TH:i:sP
query string sort[key]
Sorts files by key and used with sort[order]. The value for this field
are 'title' or 'description' or 'created_at' or 'updated_at'
query string sort[order]
Sorts the file search results and used with sort[key]. The value for this
field are 'asc' or 'desc'.
query string highlighted_excerpt_length
Return the number of highlighted excerpt text in search result. Default
is 600, min is 100, max is 1000.
query integer offset
Starting point to return rows from a result set. Default is 0, min and
max is greater than or equal 0
query integer limit
Number of results to return. Default is 50, min is 1, max is 100
query integer As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of files
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.2/SEARCH/STORIES
* Search for stories.
IMPLEMENTATION NOTES
Search for stories.
PARAMETERS
Parameter Value Description Parameter Type Data Type q
Keyword or phrase to search by. Enclose in double quotes for exact
matching. Supports asterisks for wildcards.
query string hidden true false
Filter stories that appear in a hidden primary channel. Null includes all
stories. True for hidden content only. False for non-hidden content only.
query boolean shareable true false
Filter shareable stories. Null returns all stories. True returns stories
with sharing enabled. False returns stories with sharing disabled.
query boolean created_at[gte]
Filter stories that are greater than equal to the created_at date and use
with created_at[lte]. Date format must be Y-m-d\TH:i:sP'
query string created_at[lte]
Filter stories that are less than equal to the created_at date and use
with created_at[gte]. Date format must be Y-m-d\TH:i:sP
query string updated_at[gte]
Filter stories that are greater than equal to the updated_at date and use
with updated_at[lte]. Date format must be Y-m-d\TH:i:sP
query string updated_at[lte]
Filter stories that are less than equal to the updated_at date and use
with updated_at[gte]. Date format must be Y-m-d\TH:i:sP
query string sort[key]
Sorts stories by key and used with sort[order]. The value for this field
are 'title' or 'description' or 'created_at' or 'updated_at'
query string sort[order]
Sort the search results and used with sort[key]. The value for this field
are 'asc' or 'desc'.
query string highlighted_excerpt_length
Return the number of highlighted excerpt text in search result. Default
is 600, min is 100, max is 1000.
query integer offset
Starting point to return rows from a result set. Default is 0, min and
max is greater than or equal 0
query integer limit
Number of results to return. Default is 50, min is 1, max is 100
query integer As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of stories
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SETTINGS
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/SETTINGS
* Retrieve settings.
IMPLEMENTATION NOTES
Retrieve settings. Includes: story defaults
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Settings object
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* STORY
* Show/Hide
* List Operations
* Expand Operations
* * POST /V1/STORY/ADD/TAG/{STORY_PERM_ID}
* Tag a story.
IMPLEMENTATION NOTES
Tag a story.
PARAMETERS
Parameter Value Description Parameter Type Data Type story_perm_id
Story Perm ID
path string tag
Tag name
formData string As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Tag object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/STORY/ARCHIVE/{REVISION_ID}
* Archive a story.
IMPLEMENTATION NOTES
Archive a story.
PARAMETERS
Parameter Value Description Parameter Type Data Type revision_id
Active story revision ID
path string As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Story archived
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/STORY/COMMENT/{REVISION_ID}
* Comment on a story.
IMPLEMENTATION NOTES
Comment on a story.
PARAMETERS
Parameter Value Description Parameter Type Data Type revision_id
Story revision ID
path string comment
Parameter content type: application/json
Comment object
body
* Model
* Example Value
Add Comment Request {
comment (string):
Comment
,
reply_to_id (string, optional):
Reply to comment ID
}
{
"comment": "string",
"reply_to_id": "string"
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Comment object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/STORY/SEARCH
* Search for stories.
IMPLEMENTATION NOTES
DEPRECATED: use /search/stories instead. Search for stories.
Generic Search (For example find all documents with term 'test')
Send 'test' as the keyword.
Search Types
- Stories returns stories.
- Files returns files.
- Tags returns stories and files with the requested tag.
You can search in following sections. Fields for each search type will be as follows:
Stories - title, description
Files - filename, content, extension
Comments - comment, user
Meetings - title, description
People - firstname, lastname, email, jobtitle, skill
Tags - tagNotes - title,content
Examples:
Request format for searching text 'test' only in story title - fields[0]=title or you can even send fields=title if
there is only one field Request format for searching text 'test' in both story title and description -
fields[0]=title, fields[1]=description Fields depend on type selected
Filters
The following aggregation filters are provided:
tab, channel, author, range and (tag - for stories or mime - for files)
The search result contains aggregated results with id, term and count which can be used to narrow down searchresults
Example:
To filter search results by specific tabs:
Keyword: test
Filters would contain the JSON object:
{'tab_id':['dbAUxa', 'sFicvuF']}
If you want to drill down further by channel and author:
Filters would contain the JSON object:
{'tab_id':['dbAUxa', 'sFicvuF'], 'channel_id':['cuydsy', 'dsoivwP], 'author_id':['XMudha'], 'range':[{'unit':'months','value':1}]}
Date Filter
You can specify three units - days, weeks and months.
Example:
Last Month - date filter to be used for last month is [{'unit':'months','value':1}]
Last Week - [{'unit':'weeks','value':1}]
Last 24 Hours - [{'unit':'days','value':1}]
Last 6 Months - [{'unit':'months', 'value':6}]
PARAMETERS
Parameter Value Description Parameter Type Data Type keyword
Keywords
query string page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer fields
JSON object of Fields within search type
query string type stories files tags
Search Type
query string filters
JSON object with array of IDs - List of possible filters are described
above
query string date_filter
JSON object of Date filter
query string exclude_internal_files true false
Exclude internal files like btc, btcf, btca, btce
query boolean As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of stories
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/STORY/SHARE/{REVISION_ID}
* Share a story.
IMPLEMENTATION NOTES
Share a story.
PARAMETERS
Parameter Value Description Parameter Type Data Type revision_id
Story revision ID
path string body
Parameter content type: application/json
Share object
body
* Model
* Example Value
Share Story Request {
subject (string):
Share subject
,
note (string, optional):
Share description
,
lang_code (string, optional):
Language code
= ['en-us', 'en-gb', 'zh-cn', 'zh-hk', 'fr', 'it', 'ja', 'ko', 'pt-br',
'ru', 'es', 'th', 'da', 'de', 'no', 'sv', 'tr', 'vi']
stringDefault:en-usEnum:"en-us", "en-gb", "zh-cn", "zh-hk", "fr", "it",
"ja", "ko", "pt-br", "ru", "es", "th", "da", "de", "no", "sv", "tr", "vi"
,
emails (Array[string]):
Email addresses
,
cc_emails (Array[string], optional):
CC email addresses
,
file_id (Array[string], optional):
File IDs
}
{
"subject": "string",
"note": "string",
"lang_code": "en-us",
"emails": [
"string"
],
"cc_emails": [
"string"
],
"file_id": [
"string"
]
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Share sent
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/STORY/UPLOAD/FILE
* Upload a file to attach to a new or existing story.
IMPLEMENTATION NOTES
Upload a file to attach to a new or existing story.
Upon success an array of objects will be returned with the following keys: filename, description, category, size
Upon failure an array of objects will be returned with the following keys: code, message, filename
The order in which files were uploaded is maintained when output is returned.
PARAMETERS
Parameter Value Description Parameter Type Data Type upload_type file
Upload type
formData string files
Files
formData file As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
File object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.1/STORY/GET/{STORY_PERM_ID}
* Retrieve a story.
IMPLEMENTATION NOTES
Retrieve a story.
PARAMETERS
Parameter Value Description Parameter Type Data Type story_perm_id
Story Perm ID
path string As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Story object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.1/STORY/ADD
* Publish a story.
IMPLEMENTATION NOTES
Publish a story.
Sharing bitmask:
The field 'sharing_bitmask' is a combination of the following bits:
- No sharing: 0
- Device sharing: 1
- Share with Audit: 2
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Story object
body
* Model
* Example Value
Add Story Request {
title (string, optional):
Story title
,
channels (Array[inline_model_2]):
Channels
,
description (string, optional),
excerpt (string, optional),
new_files (Array[Story File Request Object], optional):
Files
,
events (Array[Story Event Request Object], optional):
Events
,
tags (Array[Story Tag Request Object], optional):
Tag objects
,
sharing_bitmask (integer, optional),
is_password_protected (boolean, optional)
booleanDefault:false
,
can_annotate (boolean, optional)
booleanDefault:true
,
is_notifications_enabled (boolean, optional)
booleanDefault:true
,
is_publicly_accessible (boolean, optional)
booleanDefault:false
,
quicklink_url (string, optional),
quicklink_fallback (string, optional),
quickfile (boolean, optional)
booleanDefault:false
,
cover_art_url (string, optional)
stringDefault:
}
inline_model_2 {
id (string, optional):
Channel ID
}
Story File Request Object {
filename (string),
description (string),
share_status (string) = ['mandatory', 'optional', 'blocked']
stringEnum:"mandatory", "optional", "blocked"
,
tags (Array[Story Tag Request Object], optional):
Tag objects
}
Story Event Request Object {
id (string, optional),
title (string),
tz (string),
start (integer):
Unix timestamp
,
end (integer):
Unix timestamp
,
all_day (boolean):
All day event
}
Story Tag Request Object {
name (string)
}
{
"title": "string",
"channels": [
{
"id": "string"
}
],
"description": "string",
"excerpt": "string",
"new_files": [
{
"filename": "string",
"description": "string",
"share_status": "mandatory",
"tags": [
{
"name": "string"
}
]
}
],
"events": [
{
"id": "string",
"title": "string",
"tz": "string",
"start": 0,
"end": 0,
"all_day": true
}
],
"tags": [
{
"name": "string"
}
],
"sharing_bitmask": 0,
"is_password_protected": false,
"can_annotate": true,
"is_notifications_enabled": true,
"is_publicly_accessible": false,
"quicklink_url": "string",
"quicklink_fallback": "string",
"quickfile": false,
"cover_art_url": ""
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 201
Story object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1.1/STORY/EDIT/{REVISION_ID}
* Update a story.
IMPLEMENTATION NOTES
Update a story.
How to edit files
You can use either of following ways to edit files and you cannot mix both ways together:
1. files/new_files
files: the existing files you want to keep, [] means removing all existing files
new_files: the new files you want to add
2. append_files/remove_files
append_files: files you want to append/add
remove_files: files you want to remove from the existing files
Sharing bitmask:
The field 'sharing_bitmask' is a combination of the following bits:
- No sharing: 0
- Device sharing: 1
- Share with Audit: 2
PARAMETERS
Parameter Value Description Parameter Type Data Type revision_id
Story revision ID
path string body
Parameter content type: application/json
Story object
body
* Model
* Example Value
Update Story Request {
title (string, optional):
Story title
,
channels (Array[inline_model_3]):
Channels
,
description (string, optional),
excerpt (string, optional),
new_files (Array[Story File Request Object], optional):
New files
,
files (Array[Story File Request Object], optional):
Existing files
,
append_files (Array[Story File Request Object], optional):
Append files to the story
,
remove_files (Array[inline_model_4], optional):
Remove files from the story
,
events (Array[Story Event Request Object], optional):
Event objects
,
tags (Array[Story Tag Request Object], optional):
Tag objects
,
sharing_bitmask (integer, optional),
is_password_protected (boolean, optional)
booleanDefault:false
,
can_annotate (boolean, optional)
booleanDefault:true
,
is_notifications_enabled (boolean, optional)
booleanDefault:true
,
is_publicly_accessible (boolean, optional)
booleanDefault:false
,
quicklink_url (string, optional),
quicklink_fallback (string, optional),
quickfile (boolean, optional)
booleanDefault:false
,
cover_art_url (string, optional)
}
inline_model_3 {
id (string, optional):
Channel ID
}
Story File Request Object {
filename (string),
description (string),
share_status (string) = ['mandatory', 'optional', 'blocked']
stringEnum:"mandatory", "optional", "blocked"
,
tags (Array[Story Tag Request Object], optional):
Tag objects
}
inline_model_4 {
filename (string, optional)
}
Story Event Request Object {
id (string, optional),
title (string),
tz (string),
start (integer):
Unix timestamp
,
end (integer):
Unix timestamp
,
all_day (boolean):
All day event
}
Story Tag Request Object {
name (string)
}
{
"title": "string",
"channels": [
{
"id": "string"
}
],
"description": "string",
"excerpt": "string",
"new_files": [
{
"filename": "string",
"description": "string",
"share_status": "mandatory",
"tags": [
{
"name": "string"
}
]
}
],
"files": [
{
"filename": "string",
"description": "string",
"share_status": "mandatory",
"tags": [
{
"name": "string"
}
]
}
],
"append_files": [
{
"filename": "string",
"description": "string",
"share_status": "mandatory",
"tags": [
{
"name": "string"
}
]
}
],
"remove_files": [
{
"filename": "string"
}
],
"events": [
{
"id": "string",
"title": "string",
"tz": "string",
"start": 0,
"end": 0,
"all_day": true
}
],
"tags": [
{
"name": "string"
}
],
"sharing_bitmask": 0,
"is_password_protected": false,
"can_annotate": true,
"is_notifications_enabled": true,
"is_publicly_accessible": false,
"quicklink_url": "string",
"quicklink_fallback": "string",
"quickfile": false,
"cover_art_url": "string"
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 201
Story object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.2/STORY/ALL
* Retrieve stories.
IMPLEMENTATION NOTES
Retrieve stories. Story access limited to the requester's group
associations.
PARAMETERS
Parameter Value Description Parameter Type Data Type channel_id
Channel ID
query string page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer sort_by date likes most_read least_read author_first_name
author_last_name priority_order content_score title
Sort by fields
query string include_comments true false (default)
Include comments to story
query boolean As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of stories
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TAB
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/TAB/ALL
* Retrieve tabs.
IMPLEMENTATION NOTES
Retrieve tabs. Tab access is limited to the requester's group
associations.
PARAMETERS
Parameter Value Description Parameter Type Data Type search
Search by tab name
query string page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of tabs
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1/TAB
* Create a tab.
IMPLEMENTATION NOTES
Create a tab.
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Tab object
body
* Model
* Example Value
Add Tab Request {
name (string):
Tab name
,
description (string, optional):
Tab description
}
{
"name": "string",
"description": "string"
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 201
Tab object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1/TABS/{TAB_ID}/CHANNELS/{CHANNEL_ID}/GROUPS
* Add groups to a tab.
IMPLEMENTATION NOTES
Add one or more groups to a tab-channel relationship to complete a full
relationship. The tab and channel will become visible to all users in the
groups based on the permissions set.
PARAMETERS
Parameter Value Description Parameter Type Data Type tab_id
Tab ID
path string channel_id
Channel ID
path string body
Parameter content type: application/json
Group object
body
* Model
* Example Value
Add Group To Tab Request {
id (string):
Group ID
,
permissions (string):
Permissions
}
{
"id": "string",
"permissions": "string"
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Relationship object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/TABS/{TAB_ID}/CHANNELS/{CHANNEL_ID}/GROUPS/{GROUP_ID}
* Remove a group from a tab.
IMPLEMENTATION NOTES
Remove a group from a tab.
PARAMETERS
Parameter Value Description Parameter Type Data Type tab_id
Tab ID
path string channel_id
Channel ID
path string group_id
Group ID
path string As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 204
Group removed from tab
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /V1/TAB/{TAB_ID}
* Delete a tab.
IMPLEMENTATION NOTES
Delete a tab.
PARAMETERS
Parameter Value Description Parameter Type Data Type tab_id
Tab ID
path string As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 204
Tab deleted
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USER
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /V1/USER/{USER_ID}
* Delete a user.
IMPLEMENTATION NOTES
Delete a user.
PARAMETERS
Parameter Value Description Parameter Type Data Type user_id
Active user id
path string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
User Delete
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /V1/USER/CHANGE-PASSWORD
* Change the current user's password.
IMPLEMENTATION NOTES
Change the current user's password.
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Change password object
body
* Model
* Example Value
Change Password Request {
currentPassword (string):
Current password
,
newPassword (string):
New password
}
{
"currentPassword": "string",
"newPassword": "string"
}
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Password reset successfully
400
Bad request
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /V1/USER/FORGOT-PASSWORD
* Send a reset password email.
IMPLEMENTATION NOTES
Send a reset password email to an email address when a user has forgotten
their password.
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Reset password object
body
* Model
* Example Value
Reset Password Request {
email (string):
Email address
}
{
"email": "string"
}
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
Reset password email sent
400
Bad request
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/USER/ME
* Get information about the current user.
IMPLEMENTATION NOTES
Get information about the current user.
PARAMETERS
Parameter Value Description Parameter Type Data Type As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
User object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/USER/{USER_ID}/METADATA
* Retrieve a user's metadata.
IMPLEMENTATION NOTES
Retrieve a user's metadata
PARAMETERS
Parameter Value Description Parameter Type Data Type user_id
User ID
path string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of a user's metadata.
401
Unauthorized
404
Not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /V1/USER/{USER_ID}/METADATA
* Update user metadata.
IMPLEMENTATION NOTES
Replaces all the existing user metadata with the ones provided in the
json body. Wipes a user's assigned metadata with an empty array [ ]
PARAMETERS
Parameter Value Description Parameter Type Data Type user_id
User ID
path string user_metadata_values
Parameter content type: application/json
body
* Model
* Example Value
Update User Metadata Request [
Inline Model 1
]
Inline Model 1 {
id (string):
User Metadata Value ID
}
[
{
"id": "string"
}
]
RESPONSE MESSAGES
HTTP Status & Error Code Reason 204
User metadata updated successfully.
401
Unauthorized
404
Not found
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /V1.1/USER
* Update an existing user.
IMPLEMENTATION NOTES
Update an existing user. All fields other than id are optional. Setting a
new password for the user would result in the also updating the status as
“active” (if not already active) for the given user.
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
User object
body
* Model
* Example Value
Update User Request {
id (string):
User ID
,
first_name (string, optional):
First name
,
last_name (string, optional):
Last name
,
email (string, optional):
Email address
,
new_password (string, optional):
Updated password
,
configuration_bundle (integer, optional):
Configuration bundle ID
,
digest_email (integer, optional):
0: Never, 1: Daily, 2: Weekly, 3: Monthly
= ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
send_invite (boolean, optional):
Send invitation email
,
access (integer, optional):
User access level. 0: User, 2: Structure Admin, 4: Administrator
= ['0', '2', '4']
integerEnum:0, 2, 4
,
job_title (string, optional):
Job title
,
can_promote (boolean, optional):
Can promote stories
booleanDefault:false
,
lang_code (string, optional):
Language code
= ['en-us', 'en-gb', 'zh-cn', 'zh-hk', 'fr', 'it', 'ja', 'ko', 'pt-br',
'ru', 'es', 'th', 'da', 'de', 'no', 'sv', 'tr', 'vi']
stringDefault:en-usEnum:"en-us", "en-gb", "zh-cn", "zh-hk", "fr", "it",
"ja", "ko", "pt-br", "ru", "es", "th", "da", "de", "no", "sv", "tr", "vi"
,
user_timezone (string, optional):
Timezone
,
status (string, optional):
User status
stringDefault:active
,
enable_company_reports (boolean, optional)
booleanDefault:false
,
enable_personal_reports (boolean, optional)
booleanDefault:false
,
enable_advanced_reports (boolean, optional)
booleanDefault:false
,
groups (Array[inline_model_6], optional),
platforms (Array[string], optional)
}
inline_model_6 {
id (string, optional):
Group ID
,
is_group_admin (boolean, optional):
Is group administrator
booleanDefault:false
}
{
"id": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"new_password": "string",
"configuration_bundle": 0,
"digest_email": 0,
"send_invite": true,
"access": 0,
"job_title": "string",
"can_promote": false,
"lang_code": "en-us",
"user_timezone": "string",
"status": "active",
"enable_company_reports": false,
"enable_personal_reports": false,
"enable_advanced_reports": false,
"groups": [
{
"id": "string",
"is_group_admin": false
}
],
"platforms": [
"web"
]
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
User object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.1/USER
* Create a new user.
IMPLEMENTATION NOTES
Create a new user.
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
User object
body
* Model
* Example Value
Add User Request {
first_name (string):
First name
,
last_name (string):
Last name
,
email (string):
Email address
,
new_password (string, optional):
Updated password
,
configuration_bundle (integer, optional):
Configuration bundle ID
,
digest_email (integer, optional):
0: Never, 1: Daily, 2: Weekly, 3: Monthly
= ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
send_invite (boolean, optional):
Send invitation email
,
access (integer, optional):
User access level. 0: User, 2: Structure Admin, 4: Administrator
= ['0', '2', '4']
integerEnum:0, 2, 4
,
job_title (string, optional):
Job title
,
can_promote (boolean, optional):
Can promote stories
booleanDefault:false
,
lang_code (string, optional):
Language code
= ['en-us', 'en-gb', 'zh-cn', 'zh-hk', 'fr', 'it', 'ja', 'ko', 'pt-br',
'ru', 'es', 'th', 'da', 'de', 'no', 'sv', 'tr', 'vi']
stringDefault:en-usEnum:"en-us", "en-gb", "zh-cn", "zh-hk", "fr", "it",
"ja", "ko", "pt-br", "ru", "es", "th", "da", "de", "no", "sv", "tr", "vi"
,
user_timezone (string, optional):
Timezone
,
status (string, optional):
User status
stringDefault:invited
,
enable_company_reports (boolean, optional)
booleanDefault:false
,
enable_personal_reports (boolean, optional)
booleanDefault:false
,
enable_advanced_reports (boolean, optional)
booleanDefault:false
,
groups (Array[inline_model_5], optional),
platforms (Array[string], optional)
}
inline_model_5 {
id (string, optional):
Group ID
,
is_group_admin (boolean, optional):
Is group administrator
booleanDefault:false
}
{
"first_name": "string",
"last_name": "string",
"email": "string",
"new_password": "string",
"configuration_bundle": 0,
"digest_email": 0,
"send_invite": true,
"access": 0,
"job_title": "string",
"can_promote": false,
"lang_code": "en-us",
"user_timezone": "string",
"status": "invited",
"enable_company_reports": false,
"enable_personal_reports": false,
"enable_advanced_reports": false,
"groups": [
{
"id": "string",
"is_group_admin": false
}
],
"platforms": [
"web"
]
}
As-User
Perform action on behalf of this user ID.
header string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 201
User object
400
Bad request
401
Unauthorized
403
Forbidden
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USER METADATA
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1/USER-METADATA
* Retrieve all user metadata.
IMPLEMENTATION NOTES
Retrieve user metadata.
PARAMETERS
Parameter Value Description Parameter Type Data Type page
Pagination: current page
query integer limit
Pagination: results per page. Max 100
query integer
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of user metadata.
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1/USER/{USER_ID}/METADATA
* Retrieve a user's metadata.
IMPLEMENTATION NOTES
Retrieve a user's metadata
PARAMETERS
Parameter Value Description Parameter Type Data Type user_id
User ID
path string
RESPONSE MESSAGES
HTTP Status & Error Code Reason 200
A list of a user's metadata.
401
Unauthorized
404
Not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /V1/USER/{USER_ID}/METADATA
* Update user metadata.
IMPLEMENTATION NOTES
Replaces all the existing user metadata with the ones provided in the
json body. Wipes a user's assigned metadata with an empty array [ ]
PARAMETERS
Parameter Value Description Parameter Type Data Type user_id
User ID
path string user_metadata_values
Parameter content type: application/json
body
* Model
* Example Value
Update User Metadata Request [
Inline Model 1
]
Inline Model 1 {
id (string):
User Metadata Value ID
}
[
{
"id": "string"
}
]
RESPONSE MESSAGES
HTTP Status & Error Code Reason 204
User metadata updated successfully.
401
Unauthorized
404
Not found
422
Validation error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
[ BASE URL: , API VERSION: 1.0 ]