api.iterable.com
Open in
urlscan Pro
52.5.248.176
Public Scan
Submitted URL: http://api.iterable.com/
Effective URL: https://api.iterable.com/api/docs
Submission: On May 30 via api from DE — Scanned from DE
Effective URL: https://api.iterable.com/api/docs
Submission: On May 30 via api from DE — Scanned from DE
Form analysis 119 forms found in the DOM
<form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-campaigns_trigger_campaign">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">TriggerCampaignRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Trigger campaign</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-campaigns_trigger_campaign">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-campaigns_trigger_campaign">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-campaigns_create_campaign">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">CreateCampaignRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Create campaign</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-campaigns_create_campaign">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-campaigns_create_campaign">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-campaigns_abort_campaign">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">CampaignIdRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Abort campaign</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-campaigns_abort_campaign">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-campaigns_abort_campaign">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-campaigns_cancel_campaign">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">CampaignIdRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Cancel campaign</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-campaigns_cancel_campaign">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-campaigns_cancel_campaign">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-campaigns_child_campaigns">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> id:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="id">
<input class="parameter form-control required" minlength="1" name="id" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted"></small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-campaigns_child_campaigns">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-campaigns_child_campaigns">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div id="test-campaigns_campaigns">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-campaigns_campaigns">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-campaigns_metrics">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> campaignId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="campaignId">
<input class="parameter form-control required" minlength="1" name="campaignId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">array</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Campaign(s) to export</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> startDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="startDateTime">
<input class="parameter form-control " minlength="0" name="startDateTime" placeholder="" type="text" value="2018-06-25">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Export starting from (>=). Accepted formats include YYYY-MM-DD and other ISO 8601 formats.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> endDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="endDateTime">
<input class="parameter form-control " minlength="0" name="endDateTime" placeholder="" type="text" value="2018-07-25">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Export ending at (<). Accepted formats include YYYY-MM-DD and other ISO 8601 formats.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-campaigns_metrics">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="text/plain">text/plain</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-campaigns_metrics">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_listCatalogs">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> page:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="page">
<input class="parameter form-control " minlength="0" name="page" placeholder="" type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Page number to list (starting at 1).</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> pageSize:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="pageSize">
<input class="parameter form-control " minlength="0" name="pageSize" placeholder="" type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Number of results to display per page (defaults to 10).</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_listCatalogs">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_listCatalogs">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_getFieldMappings">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_getFieldMappings">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_getFieldMappings">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_updateFieldTypes">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">CatalogMappingsUpdateRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog Field Types</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_updateFieldTypes">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_updateFieldTypes">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>200</strong></div>
<div class="col-10 col-lg-11 py-3">Catalog field mappings updated</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_deleteCatalog">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_deleteCatalog">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_deleteCatalog">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_createCatalog">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_createCatalog">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_createCatalog">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>201</strong></div>
<div class="col-10 col-lg-11 py-3">Catalog created</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>500</strong></div>
<div class="col-10 col-lg-11 py-3">Internal server error</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_deleteCatalogItem">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> itemId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="itemId">
<input class="parameter form-control required" minlength="1" name="itemId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_deleteCatalogItem">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_deleteCatalogItem">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Received request to deleted item. Use GET /api/catalogs/{catalogName}/items/{itemId} to verify completion.</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_getCatalogItem">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> itemId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="itemId">
<input class="parameter form-control required" minlength="1" name="itemId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_getCatalogItem">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_getCatalogItem">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">No catalog item at specified location</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_partialUpdateCatalogItem">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted"></small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> itemId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="itemId">
<input class="parameter form-control required" minlength="1" name="itemId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted"></small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">CatalogUpdateItemRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog item contents</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_partialUpdateCatalogItem">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_partialUpdateCatalogItem">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Catalog item update request received. Use GET /api/catalogs/{catalogName}/items/{itemId} to verify completion.</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_indexCatalogItem">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> itemId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="itemId">
<input class="parameter form-control required" minlength="1" name="itemId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">CatalogIndexItemRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog item value</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_indexCatalogItem">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_indexCatalogItem">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Catalog item update request received. Use GET /api/catalogs/{catalogName}/items/{itemId} to verify completion.</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>500</strong></div>
<div class="col-10 col-lg-11 py-3">Internal server error</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_bulkDeleteCatalogItems">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">CatalogBulkDeleteRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog bulk delete request</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_bulkDeleteCatalogItems">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_bulkDeleteCatalogItems">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Bulk delete catalog items request received.</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_listCatalogItems">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> page:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="page">
<input class="parameter form-control " minlength="0" name="page" placeholder="" type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Page number to list (starting at 1).</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> pageSize:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="pageSize">
<input class="parameter form-control " minlength="0" name="pageSize" placeholder="" type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Number of results to display per page (defaults to 10).</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> orderBy:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="orderBy">
<input class="parameter form-control " minlength="0" name="orderBy" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Field by which results should be ordered. To also use the sortAscending parameter, this field must have a defined type.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> sortAscending:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="sortAscending">
<select class="parameter form-control " name="sortAscending">
<option selected="" value=""></option>
<option value="true">true </option>
<option value="false">false </option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded java"><span class="hljs-keyword">boolean</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Sort results by ascending (Defaults to false).</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_listCatalogItems">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_listCatalogItems">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Catalog not found</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>500</strong></div>
<div class="col-10 col-lg-11 py-3">Internal server error</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-catalogs_bulkUpdateCatalogItems">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> catalogName:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="catalogName">
<input class="parameter form-control required" minlength="1" name="catalogName" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">CatalogBulkUploadRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Catalog bulk update request</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-catalogs_bulkUpdateCatalogItems">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-catalogs_bulkUpdateCatalogItems">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Request to bulk upload items received</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Catalog not found</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>500</strong></div>
<div class="col-10 col-lg-11 py-3">Internal server error</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div id="test-channels_channels">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-channels_channels">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-commerce_updateCart">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">UpdateCartRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">state of the cart</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-commerce_updateCart">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-commerce_updateCart">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-commerce_trackPurchase">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">TrackPurchaseRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">purchase data</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-commerce_trackPurchase">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-commerce_trackPurchase">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-email_target">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">TargetEmailRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Recipient and email id</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-email_target">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-email_target">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-email_cancel">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded nginx"><span class="hljs-attribute">CancelScheduledMessageRequest</span> - campaignId OR scheduledMessageId are required</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Email and Campaign ID</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-email_cancel">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-email_cancel">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-email_viewInBrowser">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control " minlength="0" name="email" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">user's email</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control " minlength="0" name="userId" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">user's userId</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> messageId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="messageId">
<input class="parameter form-control required" minlength="1" name="messageId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">id of sent message</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-email_viewInBrowser">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-email_viewInBrowser">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Data feed error encountered</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>422</strong></div>
<div class="col-10 col-lg-11 py-3">Empty catalog collection encountered</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-Embedded_Messaging_messages">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control " minlength="0" name="email" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">User identifier. Provide an email or a userId, but not both.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control " minlength="0" name="userId" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">User identifier. Provide a userId or an email, but not both.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> platform:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="platform">
<input class="parameter form-control " minlength="0" name="platform" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">[Coming soon. Do not use.] The platform of the app for which to retrieve embedded messages: iOS, Android, or Web (case-sensitive).</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> sdkVersion:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="sdkVersion">
<input class="parameter form-control " minlength="0" name="sdkVersion" placeholder="" type="text" value="None">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">[Coming soon. Do not use.] Iterable SDK version (e.g., 6.5.0).</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> packageName:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="packageName">
<input class="parameter form-control " minlength="0" name="packageName" placeholder="" type="text" value="None">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">[Coming soon. Do not use.] The package name of the app for which to retrieve embedded messages.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> placementIds:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="placementIds">
<input class="parameter form-control " minlength="0" name="placementIds" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">array</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Placements to include in the response, even if they don't have embedded messages for the user. When no placementIds are specified, the response includes all embedded messages for which the user is
eligible.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> currentMessageIds:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="currentMessageIds">
<input class="parameter form-control " minlength="0" name="currentMessageIds" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">array</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">[Coming soon. Do not use.] IDs of embedded messages already retrieved by the device making the request. If the user is no longer eligible for a specified message, that message will be omitted from the API
response. Otherwise, it will be present, but without an elements field.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-Embedded_Messaging_messages">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-Embedded_Messaging_messages">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_inAppConsume">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">InAppConsumeRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">In-app notification to consume</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_inAppConsume">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_inAppConsume">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_trackInAppClick">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">InAppClickRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">In-app click to track</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_trackInAppClick">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_trackInAppClick">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_trackInAppClose">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">InAppCloseRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">In-app close to track</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_trackInAppClose">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_trackInAppClose">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_trackInAppDelivery">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">InAppDeliveryRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">In-app delivery to track</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_trackInAppDelivery">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_trackInAppDelivery">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_trackInAppOpen">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">InAppOpenRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">In-app open to track</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_trackInAppOpen">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_trackInAppOpen">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_trackBulk">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">BulkTrackRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Events to track</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_trackBulk">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_trackBulk">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_track">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">TrackRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Event to track</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_track">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_track">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_trackWebPushClick">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">WebPushClickEventRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Web Push click to track</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_trackWebPushClick">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_trackWebPushClick">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_trackPushOpen">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">TrackPushOpenRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Push open to track</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_trackPushOpen">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_trackPushOpen">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_User_events">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control required" minlength="1" name="email" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Email of the user whose events you are retrieving.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> limit:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="limit">
<input class="parameter form-control " minlength="0" name="limit" placeholder="" type="number" value="30">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The number of events to retrieve. (Max is 200)</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_User_events">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_User_events">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_User_events_by_userId">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control required" minlength="1" name="userId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">UserId of the user whose events you are retrieving.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> limit:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="limit">
<input class="parameter form-control " minlength="0" name="limit" placeholder="" type="number" value="30">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The number of events to retrieve. (Max is 200)</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_User_events_by_userId">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_User_events_by_userId">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_embedded_track_impression">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">EmbeddedSessionRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Track an embedded message session and related impressions</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_embedded_track_impression">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_embedded_track_impression">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_embedded_track_click">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">EmbeddedClickRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Track an embedded message click</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_embedded_track_click">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_embedded_track_click">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-events_embedded_track_received">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">EmbeddedReceivedRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Track an embedded message received event</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-events_embedded_track_received">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-events_embedded_track_received">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-experiments_metrics">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> experimentId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="experimentId">
<input class="parameter form-control " minlength="0" name="experimentId" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">array</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Experiment to export. Specify multiple experimentId query parameters to export multiple experiments.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> campaignId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="campaignId">
<input class="parameter form-control " minlength="0" name="campaignId" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">array</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Campaign whose experiments you want to export. Specify multiple campaignId query parameters to export multiple campaigns.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> startDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="startDateTime">
<input class="parameter form-control " minlength="0" name="startDateTime" placeholder="" type="text" value="2018-06-25">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">export starting from (>=)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> endDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="endDateTime">
<input class="parameter form-control " minlength="0" name="endDateTime" placeholder="" type="text" value="2018-07-25">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">export ending at (<=)</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-experiments_metrics">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="text/csv">text/csv</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-experiments_metrics">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-export_exportDataCsv">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> dataTypeName:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="dataTypeName">
<select class="parameter form-control required" name="dataTypeName">
<option value="emailSend">emailSend </option>
<option value="emailOpen">emailOpen </option>
<option value="emailClick">emailClick </option>
<option value="hostedUnsubscribeClick">hostedUnsubscribeClick </option>
<option value="emailComplaint">emailComplaint </option>
<option value="emailBounce">emailBounce </option>
<option value="emailSendSkip">emailSendSkip </option>
<option value="pushSend">pushSend </option>
<option value="pushOpen">pushOpen </option>
<option value="pushUninstall">pushUninstall </option>
<option value="pushBounce">pushBounce </option>
<option value="pushSendSkip">pushSendSkip </option>
<option value="inAppSend">inAppSend </option>
<option value="inAppOpen">inAppOpen </option>
<option value="inAppClick">inAppClick </option>
<option value="inAppClose">inAppClose </option>
<option value="inAppDelete">inAppDelete </option>
<option value="inAppDelivery">inAppDelivery </option>
<option value="inAppSendSkip">inAppSendSkip </option>
<option value="inAppRecall">inAppRecall </option>
<option value="inboxSession">inboxSession </option>
<option value="inboxMessageImpression">inboxMessageImpression </option>
<option value="smsSend">smsSend </option>
<option value="smsBounce">smsBounce </option>
<option value="smsClick">smsClick </option>
<option value="smsReceived">smsReceived </option>
<option value="smsSendSkip">smsSendSkip </option>
<option value="webPushSend">webPushSend </option>
<option value="webPushClick">webPushClick </option>
<option value="webPushSendSkip">webPushSendSkip </option>
<option value="emailSubscribe">emailSubscribe </option>
<option value="emailUnSubscribe">emailUnSubscribe </option>
<option value="purchase">purchase </option>
<option value="customEvent">customEvent </option>
<option value="user">user </option>
<option value="smsUsageInfo">smsUsageInfo </option>
<option value="embeddedSend">embeddedSend </option>
<option value="embeddedSendSkip">embeddedSendSkip </option>
<option value="embeddedClick">embeddedClick </option>
<option value="embeddedReceived">embeddedReceived </option>
<option value="embeddedImpression">embeddedImpression </option>
<option value="embeddedSession">embeddedSession </option>
<option value="anonSession">anonSession </option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">data type name</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> range:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="range">
<select class="parameter form-control " name="range">
<option selected="" value="Today">Today (default)</option>
<option value="Yesterday">Yesterday </option>
<option value="BeforeToday">BeforeToday </option>
<option value="All">All </option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">date range, uses UTC time</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> delimiter:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="delimiter">
<input class="parameter form-control " minlength="0" name="delimiter" placeholder="" type="text" value=",">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">CSV file delimiter</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> startDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="startDateTime">
<input class="parameter form-control " minlength="0" name="startDateTime" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Export starting from (>=) (yyyy-MM-dd HH:mm:ss [ZZ])</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> endDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="endDateTime">
<input class="parameter form-control " minlength="0" name="endDateTime" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Export ending at (<) (yyyy-MM-dd HH:mm:ss [ZZ])</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> omitFields:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="omitFields">
<input class="parameter form-control " minlength="0" name="omitFields" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Fields to omit (comma separated)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> onlyFields:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="onlyFields">
<input class="parameter form-control " minlength="0" name="onlyFields" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">array</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only export these fields (comma separated)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> campaignId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="campaignId">
<input class="parameter form-control " minlength="0" name="campaignId" placeholder="" type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only export data from this campaign</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-export_exportDataCsv">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="text/csv">text/csv</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-export_exportDataCsv">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>429</strong></div>
<div class="col-10 col-lg-11 py-3">Rate limit exceeded</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-export_exportDataJson">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> dataTypeName:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="dataTypeName">
<select class="parameter form-control required" name="dataTypeName">
<option value="emailSend">emailSend </option>
<option value="emailOpen">emailOpen </option>
<option value="emailClick">emailClick </option>
<option value="hostedUnsubscribeClick">hostedUnsubscribeClick </option>
<option value="emailComplaint">emailComplaint </option>
<option value="emailBounce">emailBounce </option>
<option value="emailSendSkip">emailSendSkip </option>
<option value="pushSend">pushSend </option>
<option value="pushOpen">pushOpen </option>
<option value="pushUninstall">pushUninstall </option>
<option value="pushBounce">pushBounce </option>
<option value="pushSendSkip">pushSendSkip </option>
<option value="inAppSend">inAppSend </option>
<option value="inAppOpen">inAppOpen </option>
<option value="inAppClick">inAppClick </option>
<option value="inAppClose">inAppClose </option>
<option value="inAppDelete">inAppDelete </option>
<option value="inAppDelivery">inAppDelivery </option>
<option value="inAppSendSkip">inAppSendSkip </option>
<option value="inAppRecall">inAppRecall </option>
<option value="inboxSession">inboxSession </option>
<option value="inboxMessageImpression">inboxMessageImpression </option>
<option value="smsSend">smsSend </option>
<option value="smsBounce">smsBounce </option>
<option value="smsClick">smsClick </option>
<option value="smsReceived">smsReceived </option>
<option value="smsSendSkip">smsSendSkip </option>
<option value="webPushSend">webPushSend </option>
<option value="webPushClick">webPushClick </option>
<option value="webPushSendSkip">webPushSendSkip </option>
<option value="emailSubscribe">emailSubscribe </option>
<option value="emailUnSubscribe">emailUnSubscribe </option>
<option value="purchase">purchase </option>
<option value="customEvent">customEvent </option>
<option value="user">user </option>
<option value="smsUsageInfo">smsUsageInfo </option>
<option value="embeddedSend">embeddedSend </option>
<option value="embeddedSendSkip">embeddedSendSkip </option>
<option value="embeddedClick">embeddedClick </option>
<option value="embeddedReceived">embeddedReceived </option>
<option value="embeddedImpression">embeddedImpression </option>
<option value="embeddedSession">embeddedSession </option>
<option value="anonSession">anonSession </option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">data type name</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> range:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="range">
<select class="parameter form-control " name="range">
<option selected="" value="Today">Today (default)</option>
<option value="Yesterday">Yesterday </option>
<option value="BeforeToday">BeforeToday </option>
<option value="All">All </option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">date range, uses UTC time</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> startDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="startDateTime">
<input class="parameter form-control " minlength="0" name="startDateTime" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Export starting from (>=) (yyyy-MM-dd HH:mm:ss [ZZ])</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> endDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="endDateTime">
<input class="parameter form-control " minlength="0" name="endDateTime" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Export ending at (<) (yyyy-MM-dd HH:mm:ss [ZZ])</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> omitFields:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="omitFields">
<input class="parameter form-control " minlength="0" name="omitFields" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Fields to omit (comma separated)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> onlyFields:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="onlyFields">
<input class="parameter form-control " minlength="0" name="onlyFields" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">array</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only export these fields (comma separated)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> campaignId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="campaignId">
<input class="parameter form-control " minlength="0" name="campaignId" placeholder="" type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only export data from this campaign</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-export_exportDataJson">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/x-json-stream">application/x-json-stream</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-export_exportDataJson">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>429</strong></div>
<div class="col-10 col-lg-11 py-3">Rate limit exceeded</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-export_exportUserEvents">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control " minlength="0" name="email" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Export by user's email</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control " minlength="0" name="userId" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Export by user's ID</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> includeCustomEvents:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="includeCustomEvents">
<select class="parameter form-control " name="includeCustomEvents">
<option selected="" value=""></option>
<option value="true">true </option>
<option selected="" value="false">false (default)</option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded java"><span class="hljs-keyword">boolean</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Include Custom Events</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-export_exportUserEvents">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/x-json-stream">application/x-json-stream</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-export_exportUserEvents">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>429</strong></div>
<div class="col-10 col-lg-11 py-3">Rate limit exceeded</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-export_startExport">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">StartExportRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Start export request</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-export_startExport">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-export_getExportFiles">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> jobId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="jobId">
<input class="parameter form-control required" minlength="1" name="jobId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The ID of the export job. Use the jobId returned from the "Start export" endpoint.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> startAfter:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="startAfter">
<input class="parameter form-control " minlength="0" name="startAfter" placeholder="" type="text" value="None">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Skip file names up to and including this value. Use for paginating over the files in the export.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-export_getExportFiles">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-export_cancelExport">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> jobId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="jobId">
<input class="parameter form-control required" minlength="1" name="jobId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The ID of the export job. Use the jobId returned from the "Start export" endpoint.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-export_cancelExport">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-export_cancelExport">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>default</strong></div>
<div class="col-10 col-lg-11 py-3">successful operation</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-export_getExportJobs">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> jobState:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="jobState">
<input class="parameter form-control " minlength="0" name="jobState" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Filter results to only include jobs in the specified state</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-export_getExportJobs">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-In-app_target">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">TargetInAppRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Recipient and email id</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-In-app_target">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-In-app_target">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-In-app_cancel">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded nginx"><span class="hljs-attribute">CancelScheduledMessageRequest</span> - campaignId OR scheduledMessageId are required</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Email and Campaign ID</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-In-app_cancel">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-In-app_cancel">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-In-app_getPriorityMessage">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control " minlength="0" name="email" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The email address of the user for which to fetch in-app messages. Specify either an email or a userId.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control " minlength="0" name="userId" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The userId of the user for which to fetch in-app messages. Specify either an email or a userId.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> platform:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="platform">
<select class="parameter form-control " name="platform">
<option value="iOS">iOS </option>
<option value="Android">Android </option>
<option value="Web">Web </option>
<option value="OTT">OTT </option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The platform of the app for which to retrieve selective in-app messages: iOS, Android, Web, or OTT (case-sensitive).</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> SDKVersion:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="SDKVersion">
<input class="parameter form-control " minlength="0" name="SDKVersion" placeholder="" type="text" value="None">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Iterable SDK version (e.g., 6.2.17)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> packageName:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="packageName">
<input class="parameter form-control " minlength="0" name="packageName" placeholder="" type="text" value="None">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The package name of the app for which to retrieve selective in-app messages.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-In-app_getPriorityMessage">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-In-app_getPriorityMessage">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-In-app_getMessages">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control " minlength="0" name="email" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The email address of the user for which to fetch in-app messages. Specify either an email or a userId.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control " minlength="0" name="userId" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The userId of the user for which to fetch in-app messages. Specify either an email or a userId.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> count:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="count">
<input class="parameter form-control required" minlength="1" name="count" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The number of in-app messages to fetch.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> platform:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="platform">
<select class="parameter form-control " name="platform">
<option value="iOS">iOS </option>
<option value="Android">Android </option>
<option value="Web">Web </option>
<option value="OTT">OTT </option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The platform of the app for which to retrieve selective in-app messages: iOS, Android, Web, or OTT (case-sensitive).</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> SDKVersion:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="SDKVersion">
<input class="parameter form-control " minlength="0" name="SDKVersion" placeholder="" type="text" value="None">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Iterable SDK version (e.g., 6.2.17)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> packageName:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="packageName">
<input class="parameter form-control " minlength="0" name="packageName" placeholder="" type="text" value="None">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The package name of the app for which to retrieve selective in-app messages.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-In-app_getMessages">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-In-app_getMessages">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-In-app-web_getMessages">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control " minlength="0" name="email" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The email address of the user for which to fetch in-app messages. Specify either an email or a userId.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control " minlength="0" name="userId" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The userId of the user for which to fetch in-app messages. Specify either an email or a userId.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> count:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="count">
<input class="parameter form-control required" minlength="1" name="count" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The number of web in-app messages to fetch.</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> SDKVersion:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="SDKVersion">
<input class="parameter form-control " minlength="0" name="SDKVersion" placeholder="" type="text" value="None">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Iterable SDK version (e.g., 6.2.17)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> packageName:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="packageName">
<input class="parameter form-control " minlength="0" name="packageName" placeholder="" type="text" value="None">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">The package name of the app for which to retrieve selective web in-app messages.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-In-app-web_getMessages">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-In-app-web_getMessages">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-lists_delete">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> listId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="listId">
<input class="parameter form-control required" minlength="1" name="listId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">list id</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-lists_delete">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-lists_delete">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div id="test-lists_getLists">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-lists_getLists">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-lists_create">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">CreateListRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">name and optional description</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-lists_create">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-lists_create">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-lists_getLists_0">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> listId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="listId">
<input class="parameter form-control required" minlength="1" name="listId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">list id</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> preferUserId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="preferUserId">
<select class="parameter form-control " name="preferUserId">
<option selected="" value=""></option>
<option value="true">true </option>
<option selected="" value="false">false (default)</option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded java"><span class="hljs-keyword">boolean</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">If true, will return the <code>userId</code> instead of <code>email</code> if both exists in a user profile for a <a
href="https://support.iterable.com/hc/articles/204780579#identifying-users">hybrid project</a>.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-lists_getLists_0">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="text/plain">text/plain</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-lists_getLists_0">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>503</strong></div>
<div class="col-10 col-lg-11 py-3">Request timeout. Try again later.</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-lists_getListCount">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> listId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="listId">
<input class="parameter form-control required" minlength="1" name="listId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">list id</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-lists_getListCount">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-lists_getListCount">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>503</strong></div>
<div class="col-10 col-lg-11 py-3">Request timeout. Try again later.</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-lists_subscribe">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">SubscribeRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">email list id and list of emails</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-lists_subscribe">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-lists_subscribe">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-lists_unsubscribe">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">UnsubscribeRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">email list id and list of emails</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-lists_unsubscribe">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-lists_unsubscribe">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div id="test-messageTypes_messageTypes">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-messageTypes_messageTypes">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-metadata_delete">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> table:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="table">
<input class="parameter form-control required" minlength="1" name="table" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Table name [Alphanumeric, case insensitive]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> key:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="key">
<input class="parameter form-control required" minlength="1" name="key" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Metadata key [Alphanumeric, case sensitive]</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-metadata_delete">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-metadata_delete">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-metadata_get">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> table:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="table">
<input class="parameter form-control required" minlength="1" name="table" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Table name [Alphanumeric, case insensitive]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> key:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="key">
<input class="parameter form-control required" minlength="1" name="key" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Metadata key [Alphanumeric, case sensitive]</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-metadata_get">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-metadata_get">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">No metadata at specified location</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-metadata_put">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> table:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="table">
<input class="parameter form-control required" minlength="1" name="table" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Table name [Alphanumeric, case insensitive]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> key:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="key">
<input class="parameter form-control required" minlength="1" name="key" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Metadata key [Alphanumeric, case sensitive]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">PutMetadataRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Metadata properties</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-metadata_put">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-metadata_put">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-metadata_delete_0">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> table:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="table">
<input class="parameter form-control required" minlength="1" name="table" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Table name [Alphanumeric, case insensitive]</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-metadata_delete_0">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-metadata_delete_0">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-metadata_list">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> table:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="table">
<input class="parameter form-control required" minlength="1" name="table" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Table name [Alphanumeric, case insensitive]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> nextMarker:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="nextMarker">
<input class="parameter form-control " minlength="0" name="nextMarker" placeholder="" type="text" value="None">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">next result set id; returned by previous search if more hits exist</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-metadata_list">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-metadata_list">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div id="test-metadata_list_tables">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-metadata_list_tables">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-push_target">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">TargetPushRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Recipient and email id</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-push_target">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-push_target">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-push_cancel">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded nginx"><span class="hljs-attribute">CancelScheduledMessageRequest</span> - campaignId OR scheduledMessageId are required</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Email and Campaign ID</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-push_cancel">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-push_cancel">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-SMS_target">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">TargetSMSRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Recipient and email ID</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-SMS_target">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-SMS_target">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-SMS_cancel">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded nginx"><span class="hljs-attribute">CancelScheduledMessageRequest</span> - campaignId OR scheduledMessageId are required</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Email and Campaign ID</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-SMS_cancel">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-SMS_cancel">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-subscriptions_unsubscribeSingleUser">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> subscriptionGroup:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="subscriptionGroup">
<input class="parameter form-control required" minlength="1" name="subscriptionGroup" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> subscriptionGroupId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="subscriptionGroupId">
<input class="parameter form-control required" minlength="1" name="subscriptionGroupId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscription Group Id [Numeric]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userEmail:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userEmail">
<input class="parameter form-control required" minlength="1" name="userEmail" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">User's Email [Alphanumeric]</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-subscriptions_unsubscribeSingleUser">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-subscriptions_unsubscribeSingleUser">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Accepted a request to unsubscribe</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Endpoint not found</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-subscriptions_subscribeSingleUser">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> subscriptionGroup:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="subscriptionGroup">
<input class="parameter form-control required" minlength="1" name="subscriptionGroup" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> subscriptionGroupId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="subscriptionGroupId">
<input class="parameter form-control required" minlength="1" name="subscriptionGroupId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscription Group Id [Numeric]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userEmail:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userEmail">
<input class="parameter form-control required" minlength="1" name="userEmail" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">User's Email [Alphanumeric]</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-subscriptions_subscribeSingleUser">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-subscriptions_subscribeSingleUser">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Accepted a request to subscribe</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Endpoint not found</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-subscriptions_unsubscribeSingleUserByUserId">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> subscriptionGroup:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="subscriptionGroup">
<input class="parameter form-control required" minlength="1" name="subscriptionGroup" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> subscriptionGroupId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="subscriptionGroupId">
<input class="parameter form-control required" minlength="1" name="subscriptionGroupId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscription Group Id [Numeric]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control required" minlength="1" name="userId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">User's userId</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-subscriptions_unsubscribeSingleUserByUserId">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-subscriptions_unsubscribeSingleUserByUserId">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Accepted a request to unsubscribe</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Endpoint not found</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-subscriptions_subscribeSingleUserByUserId">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> subscriptionGroup:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="subscriptionGroup">
<input class="parameter form-control required" minlength="1" name="subscriptionGroup" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> subscriptionGroupId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="subscriptionGroupId">
<input class="parameter form-control required" minlength="1" name="subscriptionGroupId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscription Group Id [Numeric]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control required" minlength="1" name="userId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">User's userId</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-subscriptions_subscribeSingleUserByUserId">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-subscriptions_subscribeSingleUserByUserId">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Accepted a request to subscribe</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Endpoint not found</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-subscriptions_Bulk_subscription_action">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> subscriptionGroup:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="subscriptionGroup">
<input class="parameter form-control required" minlength="1" name="subscriptionGroup" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> subscriptionGroupId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="subscriptionGroupId">
<input class="parameter form-control required" minlength="1" name="subscriptionGroupId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscription Group Id [Numeric]</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> action:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="action">
<input class="parameter form-control required" minlength="1" name="action" placeholder="(required) " type="text" value="subscribe">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">subscribe or unsubscribe</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">BulkSubscriptionActionRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">user email</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-subscriptions_Bulk_subscription_action">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-subscriptions_Bulk_subscription_action">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Accepted a request for bulk subscription actions</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Endpoint not found</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-subscriptions_subscribeSingleUserToDoubleOptIn">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">DoubleOptInSubscriptionsRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Create a double opt-in subscription request</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-subscriptions_subscribeSingleUserToDoubleOptIn">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-subscriptions_subscribeSingleUserToDoubleOptIn">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>202</strong></div>
<div class="col-10 col-lg-11 py-3">Accepted a request to subscribe</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Endpoint not found</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>500</strong></div>
<div class="col-10 col-lg-11 py-3">Internal server error</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_getTemplates">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> templateType:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="templateType">
<select class="parameter form-control " name="templateType">
<option value="Base">Base </option>
<option value="Blast">Blast </option>
<option value="Triggered">Triggered </option>
<option value="Workflow">Workflow </option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only retrieve templates associated with this template type</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> messageMedium:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="messageMedium">
<select class="parameter form-control " name="messageMedium">
<option value="Email">Email </option>
<option value="Push">Push </option>
<option value="InApp">InApp </option>
<option value="SMS">SMS </option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only retrieve templates associated with this message medium</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> startDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="startDateTime">
<input class="parameter form-control " minlength="0" name="startDateTime" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Get templates created at or after this date time (yyyy-MM-dd HH:mm:ss [ZZ])</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> endDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="endDateTime">
<input class="parameter form-control " minlength="0" name="endDateTime" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Get templates created before this date time (yyyy-MM-dd HH:mm:ss [ZZ])</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_getTemplates">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_getTemplates">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_getByClientTemplateId">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> clientTemplateId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="clientTemplateId">
<input class="parameter form-control required" minlength="1" name="clientTemplateId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Client Template Id</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_getByClientTemplateId">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_getByClientTemplateId">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_getEmailTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> templateId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="templateId">
<input class="parameter form-control required" minlength="1" name="templateId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Template ID</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> locale:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="locale">
<input class="parameter form-control " minlength="0" name="locale" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Locale of content to get</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_getEmailTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_getEmailTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Content does not exist for specified locale</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_upsertEmailTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">UpsertEmailTemplateModel</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only the fields specified will be updated</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_upsertEmailTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_upsertEmailTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_updateEmailTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">ApiEmailTemplateModel</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only the fields specified will be updated</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_updateEmailTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_updateEmailTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_getPushTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> templateId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="templateId">
<input class="parameter form-control required" minlength="1" name="templateId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Template ID</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> locale:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="locale">
<input class="parameter form-control " minlength="0" name="locale" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Locale of content to get</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_getPushTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_getPushTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Content does not exit for specified locale</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_upsertPushTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">UpsertPushTemplateModel</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only the fields specified will be updated</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_upsertPushTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_upsertPushTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_updatePushTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">ApiPushTemplateModel</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only the fields specified will be updated</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_updatePushTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_updatePushTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_getSMSTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> templateId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="templateId">
<input class="parameter form-control required" minlength="1" name="templateId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Template ID</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> locale:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="locale">
<input class="parameter form-control " minlength="0" name="locale" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Locale of content to get</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_getSMSTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_getSMSTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Content does not exit for specified locale</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_upsertSMSTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">UpsertSMSTemplateModel</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only the fields specified will be updated</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_upsertSMSTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_upsertSMSTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_updateSMSTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">ApiSMSTemplateModel</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only the fields specified will be updated</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_updateSMSTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_updateSMSTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_getInAppTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> templateId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="templateId">
<input class="parameter form-control required" minlength="1" name="templateId" placeholder="(required) " type="number" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Template ID</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> locale:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="locale">
<input class="parameter form-control " minlength="0" name="locale" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">Locale of content to get</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_getInAppTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_getInAppTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>404</strong></div>
<div class="col-10 col-lg-11 py-3">Content does not exit for specified locale</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_upsertInAppTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">UpsertInAppTemplateModel</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only the fields specified will be updated</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_upsertInAppTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_upsertInAppTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-templates_updateInAppTemplate">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">ApiInAppTemplateModel</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only the fields specified will be updated</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-templates_updateInAppTemplate">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-templates_updateInAppTemplate">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_getUser">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control " minlength="0" name="email" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted"></small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_getUser">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_getUser">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_delete">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control required" minlength="1" name="email" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">email</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_delete">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_delete">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_getUser_0">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control required" minlength="1" name="email" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">email</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_getUser_0">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_getUser_0">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_getUserById">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control " minlength="0" name="userId" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted"></small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_getUserById">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_getUserById">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_registerBrowserToken">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">RegisterBrowserTokenRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Request to register browser</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_registerBrowserToken">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_registerBrowserToken">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_delete_0">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control required" minlength="1" name="userId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted"></small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_delete_0">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_delete_0">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_getUserById_0">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(path)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control required" minlength="1" name="userId" placeholder="(required) " type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">userId</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_getUserById_0">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_getUserById_0">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_updateSubscriptions">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">UpdateSubscriptionsRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Subscriptions to update</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_updateSubscriptions">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_updateSubscriptions">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_bulkUpdateSubscriptions">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">BulkUpdateSubscriptionsRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Bulk subscriptions to update</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_bulkUpdateSubscriptions">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_bulkUpdateSubscriptions">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_updateEmail">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">UpdateEmailRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Update a user's email. All profile data and events will be migrated.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_updateEmail">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_updateEmail">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Contact is GDPR forgotten<br>Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div id="test-users_getUserFields">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_getUserFields">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_getSentMessages">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> email:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="email">
<input class="parameter form-control " minlength="0" name="email" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">user's email, either email or userId must be specified</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> userId:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="userId">
<input class="parameter form-control " minlength="0" name="userId" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">user's userId, either email or userId must be specified</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> limit:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="limit">
<input class="parameter form-control " minlength="0" name="limit" placeholder="" type="number" value="10">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded bash"><span class="hljs-built_in">integer</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">max number of messages to return (default: 10, max limit: 1000)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> campaignIds:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="campaignIds">
<input class="parameter form-control " minlength="0" name="campaignIds" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">array</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">only include messages from these campaigns</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> startDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="startDateTime">
<input class="parameter form-control " minlength="0" name="startDateTime" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">start date time (yyyy-MM-dd HH:mm:ss ZZ)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> endDateTime:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="endDateTime">
<input class="parameter form-control " minlength="0" name="endDateTime" placeholder="" type="text" value="">
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">end date time (yyyy-MM-dd HH:mm:ss ZZ)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> excludeBlastCampaigns:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="excludeBlastCampaigns">
<select class="parameter form-control " name="excludeBlastCampaigns">
<option selected="" value=""></option>
<option value="true">true </option>
<option selected="" value="false">false (default)</option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded java"><span class="hljs-keyword">boolean</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">exclude results coming from blast campaigns (ignored if campaignId is set)</small>
</div>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> messageMedium:<br>
<small class="text-muted"><em>(query)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="messageMedium">
<select class="parameter form-control " name="messageMedium">
<option selected="" value=""></option>
<option value="Email">Email </option>
<option value="Push">Push </option>
<option value="InApp">InApp </option>
<option value="SMS">SMS </option>
</select>
<div class="parameter-content-type"></div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded cpp"><span class="hljs-built_in">string</span></code></pre>
</small>
<div class="media-body">
<small class="text-muted">only include messages of this type</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_getSentMessages">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_getSentMessages">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_updateUser">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">ApiUserUpdateRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">user object</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_updateUser">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_updateUser">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Contact is GDPR forgotten<br>Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_bulkUpdateUser">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">BulkUpdateUsersRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Users to update</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_bulkUpdateUser">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_bulkUpdateUser">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_registerDeviceToken">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">RegisterDeviceTokenRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Request to register device</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_registerDeviceToken">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_registerDeviceToken">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>409</strong></div>
<div class="col-10 col-lg-11 py-3">Email/userId conflict</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_disableDevice">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control " placeholder="" name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">DisableDeviceRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Request to disable device</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_disableDevice">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_disableDevice">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_Invalidate_JWT">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">InvalidateJwtRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Invalid JWT request</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_Invalidate_JWT">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_Invalidate_JWT">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div id="test-users_exportProjectForgottenUsers">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_exportProjectForgottenUsers">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div id="test-users_exportProjectForgottenUserIds">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_exportProjectForgottenUserIds">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_forget">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">UserRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">user's email to be added to blacklist.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_forget">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_forget">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-users_unforget">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">UserRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">user's email to be removed from blacklist.</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-users_unforget">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-users_unforget">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-Verify_beginSmsVerification">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">BeginSmsVerificationRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">The number to authenticate</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-Verify_beginSmsVerification">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-Verify_beginSmsVerification">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-Verify_checkSmsVerification">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">CheckSmsVerificationRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">The number to authenticate</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-Verify_checkSmsVerification">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-Verify_checkSmsVerification">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div id="test-webhooks_getWebhooks">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-webhooks_getWebhooks">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-webhooks_updateWebhook">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">ApiWebhookModel</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Only the specified fields will be updated</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-webhooks_updateWebhook">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-webhooks_updateWebhook">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-webPush_target">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">TargetWebPushRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Recipient and email id</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-webPush_target">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-webPush_target">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-webPush_cancel">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded nginx"><span class="hljs-attribute">CancelScheduledMessageRequest</span> - campaignId OR scheduledMessageId are required</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Email and Campaign ID</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-webPush_cancel">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-webPush_cancel">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h6>Parameters</h6>
<div data-content="" class="operation-params card card-body pb-1 bg-light mb-3" id="parm-workflows_triggerWorkflow">
<div class="parameter-item">
<div class="form-group row">
<label class="param-property text-nowrap col-lg-3 col-xl-2 text-lg-right col-form-label"> body:<br>
<small class="text-muted"><em>(body)</em></small>
</label>
<div class="param-property col-lg-9 col-xl-10" data-label="body">
<textarea class="body-textarea form-control required" placeholder="(required) " name="body" rows="3"></textarea>
<div class="parameter-content-type">
<div>
<div class="media mt-2">
<label class="align-self-center mb-0 mr-3" for="parameterContentType">Content type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
<div class="small-description media mt-2">
<small>
<pre class="mb-0 mr-2"><code class="code-signature hljs rounded">TriggerWorkflowRequest</code></pre>
</small>
<div class="media-body">
<small class="text-muted">Trigger workflow request</small>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="test-workflows_triggerWorkflow">
<div class="sandbox_header mb-5" data-content="">
<input class="submit btn btn-secondary" name="commit" type="submit" value="Submit API request" data-toggle="modal" data-target="#get_clients-modal-request">
</div>
<div class="response-content-type card card-body pb-3 bg-light mb-3">
<div>
<div class="media">
<label class="align-self-center mb-0 mr-3" for="responseContentType">Response Type:</label>
<div class="media-body">
<select class="parameter form-control form-control-sm" name="responseContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
<h6 class="pt-3" data-control=""> Responses </h6>
<div data-content="" class="responses-wrapper" id="response-workflows_triggerWorkflow">
<div class="operation-status">
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>400</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid parameters</div>
</div>
</div>
<div class="border border-bottom-0 border-left-0 border-right-0">
<div class="row">
<div class="col-2 col-lg-1 py-3"><strong>401</strong></div>
<div class="col-10 col-lg-11 py-3">Invalid API key</div>
</div>
</div>
</div>
</div>
</form>Text Content
Iterable API documentation
Authentication Header:
Apply
Swagger Resource
API Reference
campaigns
Trigger a campaign Create a campaign Abort a campaign Cancel a scheduled or
recurring campaign Get child campaigns of a recurring campaign List campaign
metadata Get metrics for campaigns
catalogs
Get catalog names Get field mappings for a catalog Set a catalog's field
mappings (data types) Delete a catalog Create a catalog Delete a catalog item
Get a specific catalog item Create or update a catalog item Create or replace a
catalog item Bulk delete catalog items Get the catalog items for a catalog Bulk
create catalog items
channels
Get channels
commerce
Update a user's shopping cart items Track a purchase
email
Send an email to an email address Cancel an email to a user View a previously
sent email
Embedded Messaging
Get a user's embedded messages
events
Consume or delete an in-app message Track an in-app message click Track the
closing of an in-app message Track the delivery of an in-app message Track an
in-app message open Bulk track events Track an event Track a web push click
Track a mobile push open Get user events Get user events by userId Track an
embedded message session and related impressions Track an embedded message click
Track an embedded message received event
experiments
Get metrics for experiments
export
Export data to CSV Export data to JSON Export user events Start export Get
export files Cancel export Get export jobs
In-app
Send an in-app notification to a user Cancel a scheduled in-app message Get a
user's most relevant in-app message Get a user's in-app messages
In-app-web
Get a user's web in-app messages
lists
Delete a list Get lists Create a static list Get users in a list Get count of
users in list Add subscribers to list Remove users from a list
messageTypes
List message types
metadata
Delete a single metadata key/value Get the metadata value of a single key Create
or replace metadata Delete a table List keys in a table List available tables
push
Send push notification to user Cancel a push notification to a user
SMS
Send SMS notification to user Cancel an SMS to a user
subscriptions
Unsubscribe a single user Subscribe a single user Unsubscribe a single user by
userId Subscribe a single user by their userId Bulk subscription action on a
list of users Trigger a double opt-in subscription flow
templates
Get project templates Get an email template by clientTemplateId Get an email
template by templateId Create email template Update email template Get a push
template Create a push template Update push template Get an SMS template Create
an SMS template Update SMS template Get an in-app template Create an in-app
template Update in-app template
users
Get a user by email (query parameter) Delete a user by email Get a user by email
(path parameter) Get a user by userId (query parameter) Register a browser token
for web push Delete user by userId Get a user by userId (path parameter) Update
user subscriptions Bulk update user subscriptions Update user email Get all user
fields Get messages sent to a user Update user data Bulk update user data
Register a device token for push Disable pushes to a mobile device Invalidate
all JWTs issued for a user Get hashed forgotten users in compliance with GDPR
Get hashed forgotten userIds in compliance with GDPR Forget a user in compliance
with GDPR Unforget a user in compliance with GDPR
Verify
Begin SMS Verification Check SMS Verification Code
webhooks
Get webhooks Update webhook
webPush
Send web push notification to user Cancel a web push notification to a user
workflows
Trigger a journey (workflow)
ITERABLE API
Base URL: / | api version: 1.8
TRIGGER A CAMPAIGN
POST /API/CAMPAIGNS/TRIGGER
Show Samples
Trigger a campaign given lists
PARAMETERS
body:
(body)
Content type:
application/json
TriggerCampaignRequest
Trigger campaign
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"campaignId": 0,
"listIds": [
0
],
"suppressionListIds": [
0
],
"dataFields": {},
"allowRepeatMarketingSends": true
}
Body Schema
{} TriggerCampaignRequest
campaignIdinteger
listIdsarray[integer]A non-empty array of list IDs to send to
suppressionListIdsarray[integer](optional)Lists to suppress
dataFieldsobject(optional)Fields to merge into handlebars context
allowRepeatMarketingSendsboolean(optional)Allow repeat marketing sends? Defaults
to true.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRIGGER A CAMPAIGN POST
Request URL
Response Body
Response Code
Response Headers
CREATE A CAMPAIGN
POST /API/CAMPAIGNS/CREATE
Show Samples
Creates a new blast or triggered campaign from an existing template. This
endpoint can create email, push notification, web push notification, SMS, and
in-app message campaigns, but not embedded message campaigns. To learn more, see
our API Overview.
PARAMETERS
body:
(body)
Content type:
application/json
CreateCampaignRequest
Create campaign
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"name": "string",
"listIds": [
0
],
"templateId": 0,
"suppressionListIds": [
0
],
"sendAt": "string",
"sendMode": "ProjectTimeZone",
"startTimeZone": "string",
"defaultTimeZone": "string",
"dataFields": {}
}
Body Schema
{} CreateCampaignRequest
namestringThe name to use in Iterable for the new campaign.
listIdsarray[integer]To create a blast campaign, set listIds to an array of list
IDs to which the campaign should be sent. To create a triggered campaign, omit
listIds from the request body.
templateIdnumberThe ID of a template to associate with the new campaign. The new
campaign receives a copy of this template.
suppressionListIdsarray[integer](optional)An array of suppression list IDs to
associate with a new blast campaign.
sendAtstring(optional)A scheduled send time for a new blast campaign, up to 21
days in the future. Format: YYYY-MM-DD HH:MM:SS (UTC). For more details, see our
API Overview.
sendModestring(optional)When creating a blast campaign, set sendMode to
RecipientTimeZone to have Iterable send the campaign to each recipient at a
given local time in their own time zone — the same local time associated with
sendAt (UTC) in startTimeZone. Or set sendMode to ProjectTimeZone (default
value) to have Iterable send the campaign to all recipients at the UTC time
specified by sendAt, regardless of local time zone. For more details, see our
API Overview.
Can be ProjectTimeZone or RecipientTimeZone
startTimeZonestring(optional)For a scheduled blast campaign, when sendMode is
RecipientTimeZone, Iterable sends the campaign at the same local time in all
recipient time zones — starting with startTimeZone. Recipients in time zones to
the east of startTimeZone receive the campaign simultaneously with recipients in
startTimeZone, and recipients in time zones to the west of startTimeZone receive
the campaign when the same local time arrives in their own time zone. IANA
format (for example, America/New_York). For more details, see our API Overview.
defaultTimeZonestring(optional)For a scheduled blast campaign, when sendMode is
RecipientTimeZone, defaultTimeZone specifies the time zone to use when sending
to recipients without a known time zone. IANA format (for example,
America/Los_Angeles). For more details, see our API Overview.
dataFieldsobject(optional)A JSON object containing data for the campaign's
template to access as data feed data. It can access this data using double
square brackets (for example, [[field]]). For more details, see our API
Overview.
Response Sample
{
"campaignId": 0
}
Response Schema
{} CreateCampaignResponse
campaignIdnumber
CREATE A CAMPAIGN POST
Request URL
Response Body
Response Code
Response Headers
ABORT A CAMPAIGN
POST /API/CAMPAIGNS/ABORT
Show Samples
Abort a campaign given a campaign ID
PARAMETERS
body:
(body)
Content type:
application/json
CampaignIdRequest
Abort campaign
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"campaignId": 0
}
Body Schema
{} CampaignIdRequest
campaignIdnumber
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
ABORT A CAMPAIGN POST
Request URL
Response Body
Response Code
Response Headers
CANCEL A SCHEDULED OR RECURRING CAMPAIGN
POST /API/CAMPAIGNS/CANCEL
Show Samples
Cancel a campaign given a campaign ID
PARAMETERS
body:
(body)
Content type:
application/json
CampaignIdRequest
Cancel campaign
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"campaignId": 0
}
Body Schema
{} CampaignIdRequest
campaignIdnumber
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CANCEL A SCHEDULED OR RECURRING CAMPAIGN POST
Request URL
Response Body
Response Code
Response Headers
GET CHILD CAMPAIGNS OF A RECURRING CAMPAIGN
GET /API/CAMPAIGNS/RECURRING/{ID}/CHILDCAMPAIGNS
Show Samples
Get child campaigns generated by a recurring campaign. Rate limit: 100
requests/second, per project.
PARAMETERS
id:
(path)
integer
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"campaigns": [
{
"id": 0,
"createdAt": 0,
"updatedAt": 0,
"startAt": 0,
"endedAt": 0,
"name": "string",
"templateId": 0,
"messageMedium": "string",
"createdByUserId": "string",
"updatedByUserId": "string",
"campaignState": "Draft",
"listIds": [
0
],
"suppressionListIds": [
0
],
"sendSize": 0,
"recurringCampaignId": 0,
"workflowId": 0,
"labels": [
"string"
],
"type": "Blast"
}
]
}
Response Schema
{} CampaignsResponse
campaignsarray[CampaignDetails]
{} CampaignDetails
idnumber
createdAtintegerCreation timestamp as epoch time in milliseconds
updatedAtintegerLast update timestamp as epoch time in milliseconds
startAtinteger(optional)Start timestamp as epoch time in milliseconds
endedAtinteger(optional)Ended timestamp as epoch time in milliseconds
namestring
templateIdnumber(optional)
messageMediumstring
createdByUserIdstring
updatedByUserIdstring(optional)
campaignStatestring
Can be Draft, Ready, Scheduled, Running, Finished, Starting, Aborted or
Recurring
listIdsarray[integer](optional)
suppressionListIdsarray[integer](optional)
sendSizenumber(optional)
recurringCampaignIdnumber(optional)
workflowIdnumber(optional)
labelsarray[string](optional)
typestring
Can be Blast or Triggered
GET CHILD CAMPAIGNS OF A RECURRING CAMPAIGN GET
Request URL
Response Body
Response Code
Response Headers
LIST CAMPAIGN METADATA
GET /API/CAMPAIGNS
Show Samples
Get metadata about campaigns in a project. Rate limit: 100 requests/second, per
project.
Response Type:
application/json
RESPONSES
401
Invalid API key
Response Sample
{
"campaigns": [
{
"id": 0,
"createdAt": 0,
"updatedAt": 0,
"startAt": 0,
"endedAt": 0,
"name": "string",
"templateId": 0,
"messageMedium": "string",
"createdByUserId": "string",
"updatedByUserId": "string",
"campaignState": "Draft",
"listIds": [
0
],
"suppressionListIds": [
0
],
"sendSize": 0,
"recurringCampaignId": 0,
"workflowId": 0,
"labels": [
"string"
],
"type": "Blast"
}
]
}
Response Schema
{} CampaignsResponse
campaignsarray[CampaignDetails]
{} CampaignDetails
idnumber
createdAtintegerCreation timestamp as epoch time in milliseconds
updatedAtintegerLast update timestamp as epoch time in milliseconds
startAtinteger(optional)Start timestamp as epoch time in milliseconds
endedAtinteger(optional)Ended timestamp as epoch time in milliseconds
namestring
templateIdnumber(optional)
messageMediumstring
createdByUserIdstring
updatedByUserIdstring(optional)
campaignStatestring
Can be Draft, Ready, Scheduled, Running, Finished, Starting, Aborted or
Recurring
listIdsarray[integer](optional)
suppressionListIdsarray[integer](optional)
sendSizenumber(optional)
recurringCampaignIdnumber(optional)
workflowIdnumber(optional)
labelsarray[string](optional)
typestring
Can be Blast or Triggered
LIST CAMPAIGN METADATA GET
Request URL
Response Body
Response Code
Response Headers
GET METRICS FOR CAMPAIGNS
GET /API/CAMPAIGNS/METRICS
Show Samples
Get metrics for a single campaign or multiple campaigns. Rate limit: 10
requests/minute, per project.
PARAMETERS
campaignId:
(query)
array
Campaign(s) to export
startDateTime:
(query)
string
Export starting from (>=). Accepted formats include YYYY-MM-DD and other ISO
8601 formats.
endDateTime:
(query)
string
Export ending at (<). Accepted formats include YYYY-MM-DD and other ISO 8601
formats.
Response Type:
text/plain
RESPONSES
400
Invalid parameters
401
Invalid API key
GET METRICS FOR CAMPAIGNS GET
Request URL
Response Body
Response Code
Response Headers
GET CATALOG NAMES
GET /API/CATALOGS
Show Samples
Get catalog names.
Rate limit: 100 requests/second, per API key.
PARAMETERS
page:
(query)
integer
Page number to list (starting at 1).
pageSize:
(query)
integer
Number of results to display per page (defaults to 10).
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"catalogNames": [
{
"name": "string"
}
],
"totalCatalogsCount": 0,
"previousPageUrl": "string",
"nextPageUrl": "string"
}
Response Schema
{} GetCatalogsResponse
catalogNamesarray[CatalogName]
totalCatalogsCountinteger
previousPageUrlstring(optional)
nextPageUrlstring(optional)
{} CatalogName
namestring
GET CATALOG NAMES GET
Request URL
Response Body
Response Code
Response Headers
GET FIELD MAPPINGS FOR A CATALOG
GET /API/CATALOGS/{CATALOGNAME}/FIELDMAPPINGS
Show Samples
Field mappings (field to data types) and undefined fields of a catalog
PARAMETERS
catalogName:
(path)
string
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"definedMappings": {},
"undefinedFields": [
"string"
]
}
Response Schema
{} CatalogFieldMappingsResponse
definedMappingsobject
undefinedFieldsarray[string]
GET FIELD MAPPINGS FOR A CATALOG GET
Request URL
Response Body
Response Code
Response Headers
SET A CATALOG'S FIELD MAPPINGS (DATA TYPES)
PUT /API/CATALOGS/{CATALOGNAME}/FIELDMAPPINGS
Show Samples
Set a catalog's field mappings (data types). After being set, a given field's
data type may not be changed. Valid types: boolean, date, geo_location, long,
double, object, and string.
PARAMETERS
catalogName:
(path)
string
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]
body:
(body)
Content type:
application/json
CatalogMappingsUpdateRequest
Catalog Field Types
RESPONSES
200
Catalog field mappings updated
400
Invalid parameters
401
Invalid API key
Body Sample
{
"mappingsUpdates": [
{
"fieldName": "string",
"fieldType": "string",
"children": [
{}
]
}
]
}
Body Schema
{} CatalogMappingsUpdateRequest
mappingsUpdatesarray[CatalogFieldDefinitionSerializedModel]mappingsUpdates
{} CatalogFieldDefinitionSerializedModel
fieldNamestring
fieldTypestring
childrenarray[CatalogFieldDefinitionSerializedModel](optional)
SET A CATALOG'S FIELD MAPPINGS (DATA TYPES) PUT
Request URL
Response Body
Response Code
Response Headers
DELETE A CATALOG
DELETE /API/CATALOGS/{CATALOGNAME}
Show Samples
Delete the catalog with the specified name.
PARAMETERS
catalogName:
(path)
string
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
DELETE A CATALOG DELETE
Request URL
Response Body
Response Code
Response Headers
CREATE A CATALOG
POST /API/CATALOGS/{CATALOGNAME}
Show Samples
Create a catalog. Each catalog in a project must have a unique name. Catalog
names can be no longer than 255 characters and must contain only alphanumeric
characters and dashes.
PARAMETERS
catalogName:
(path)
string
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]
Response Type:
application/json
RESPONSES
201
Catalog created
400
Invalid parameters
401
Invalid API key
500
Internal server error
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CREATE A CATALOG POST
Request URL
Response Body
Response Code
Response Headers
DELETE A CATALOG ITEM
DELETE /API/CATALOGS/{CATALOGNAME}/ITEMS/{ITEMID}
Show Samples
Asynchronous. Deletes the specified item from the catalog. Data may not be
deleted immediately.
PARAMETERS
catalogName:
(path)
string
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]
itemId:
(path)
string
Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]
Response Type:
application/json
RESPONSES
202
Received request to deleted item. Use GET
/api/catalogs/{catalogName}/items/{itemId} to verify completion.
400
Invalid parameters
401
Invalid API key
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
DELETE A CATALOG ITEM DELETE
Request URL
Response Body
Response Code
Response Headers
GET A SPECIFIC CATALOG ITEM
GET /API/CATALOGS/{CATALOGNAME}/ITEMS/{ITEMID}
Show Samples
Get a specific catalog item from the given catalog.
PARAMETERS
catalogName:
(path)
string
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]
itemId:
(path)
string
Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
404
No catalog item at specified location
Response Sample
{
"catalogName": "string",
"itemId": "string",
"size": 0,
"lastModified": "2024-05-30T17:43:09.430Z",
"value": {
"underlying": {}
}
}
Response Schema
{} CatalogItemWithProperties
catalogNamestring
itemIdstring
sizeinteger
lastModifiedstring
valueJsObject
{} JsObject
underlyingobject
GET A SPECIFIC CATALOG ITEM GET
Request URL
Response Body
Response Code
Response Headers
CREATE OR UPDATE A CATALOG ITEM
PATCH /API/CATALOGS/{CATALOGNAME}/ITEMS/{ITEMID}
Show Samples
Asynchronous. Create or update the specified catalog item in the given catalog.
A catalog item's ID must be unique, contain only alphanumeric characters and
dashes, and have a maximum length of 255 characters. If the catalog item already
exists, its fields will be updated with the values provided in the request body.
Previously existing fields not included in the request body will remain as is.
Do not use periods in field names.
PARAMETERS
catalogName:
(path)
string
itemId:
(path)
string
body:
(body)
Content type:
application/json
CatalogUpdateItemRequest
Catalog item contents
Response Type:
application/json
RESPONSES
202
Catalog item update request received. Use GET
/api/catalogs/{catalogName}/items/{itemId} to verify completion.
400
Invalid parameters
401
Invalid API key
Body Sample
{
"update": {}
}
Body Schema
{} CatalogUpdateItemRequest
updateobjectJSON representation of the catalog item fields to update. Max size
is is 30kb.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CREATE OR UPDATE A CATALOG ITEM PATCH
Request URL
Response Body
Response Code
Response Headers
CREATE OR REPLACE A CATALOG ITEM
PUT /API/CATALOGS/{CATALOGNAME}/ITEMS/{ITEMID}
Show Samples
Asynchronous. Create or replace the specified catalog item in the given catalog.
A catalog item's ID must be unique, contain only alphanumeric characters and
dashes, and have a maximum length of 255 characters. If the catalog item already
exists, it will be replaced by the value provided in the request body. Do not
use periods in field names.
Rate limit: 1000 requests/second, per API key.
PARAMETERS
catalogName:
(path)
string
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]
itemId:
(path)
string
Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]
body:
(body)
Content type:
application/json
CatalogIndexItemRequest
Catalog item value
Response Type:
application/json
RESPONSES
202
Catalog item update request received. Use GET
/api/catalogs/{catalogName}/items/{itemId} to verify completion.
400
Invalid parameters
401
Invalid API key
500
Internal server error
Body Sample
{
"value": {}
}
Body Schema
{} CatalogIndexItemRequest
valueobjectJSON representation of the catalog item. Max size is is 30kb.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CREATE OR REPLACE A CATALOG ITEM PUT
Request URL
Response Body
Response Code
Response Headers
BULK DELETE CATALOG ITEMS
DELETE /API/CATALOGS/{CATALOGNAME}/ITEMS
Show Samples
Asynchronous. Delete the specified catalog items from the catalog.
PARAMETERS
catalogName:
(path)
string
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]
body:
(body)
Content type:
application/json
CatalogBulkDeleteRequest
Catalog bulk delete request
Response Type:
application/json
RESPONSES
202
Bulk delete catalog items request received.
400
Invalid parameters
401
Invalid API key
Body Sample
{
"itemIds": [
"string"
]
}
Body Schema
{} CatalogBulkDeleteRequest
itemIdsarray[string]
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
BULK DELETE CATALOG ITEMS DELETE
Request URL
Response Body
Response Code
Response Headers
GET THE CATALOG ITEMS FOR A CATALOG
GET /API/CATALOGS/{CATALOGNAME}/ITEMS
Show Samples
Get the catalog items for a catalog.
Rate limit: 100 requests/second, per API key.
PARAMETERS
catalogName:
(path)
string
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]
page:
(query)
integer
Page number to list (starting at 1).
pageSize:
(query)
integer
Number of results to display per page (defaults to 10).
orderBy:
(query)
string
Field by which results should be ordered. To also use the sortAscending
parameter, this field must have a defined type.
sortAscending:
(query)
true false
boolean
Sort results by ascending (Defaults to false).
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
404
Catalog not found
500
Internal server error
Response Sample
{
"catalogItemsWithProperties": [
{
"catalogName": "string",
"itemId": "string",
"size": 0,
"lastModified": "2024-05-30T17:43:09.435Z",
"value": {
"underlying": {}
}
}
],
"totalItemsCount": 0,
"nextPageUrl": "string",
"previousPageUrl": "string"
}
Response Schema
{} GetCatalogItemsResponse
catalogItemsWithPropertiesarray[CatalogItemWithProperties]
totalItemsCountinteger
nextPageUrlstring(optional)
previousPageUrlstring(optional)
{} CatalogItemWithProperties
catalogNamestring
itemIdstring
sizeinteger
lastModifiedstring
valueJsObject
{} JsObject
underlyingobject
GET THE CATALOG ITEMS FOR A CATALOG GET
Request URL
Response Body
Response Code
Response Headers
BULK CREATE CATALOG ITEMS
POST /API/CATALOGS/{CATALOGNAME}/ITEMS
Show Samples
Asynchronous. Create up to 1000 catalog items with a single request. Each of a
catalog's items must have a unique ID that contains only alphanumeric characters
and dashes and has a maximum length of 255 characters. If the catalog already
contains an item with the same ID as one provided in the request body, the item
in the catalog will be completely overwritten, unless replaceUploadedFieldsOnly
is set to true. Do not use periods in field names.
Rate limit: 100 requests/second, per API key.
PARAMETERS
catalogName:
(path)
string
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]
body:
(body)
Content type:
application/json
CatalogBulkUploadRequest
Catalog bulk update request
Response Type:
application/json
RESPONSES
202
Request to bulk upload items received
400
Invalid parameters
401
Invalid API key
404
Catalog not found
500
Internal server error
Body Sample
{
"documents": {},
"replaceUploadedFieldsOnly": true
}
Body Schema
{} CatalogBulkUploadRequest
documentsobjectJson map of id to values. Max number of pairs in list is 1000.
Max size of each json value is is 30kb.
replaceUploadedFieldsOnlybooleanWhether to replace only the upload fields within
each document, not each entire document
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
BULK CREATE CATALOG ITEMS POST
Request URL
Response Body
Response Code
Response Headers
GET CHANNELS
GET /API/CHANNELS
Show Samples
Get all message channels within the project. Rate limit: 100 requests/second,
per project.
Response Type:
application/json
RESPONSES
401
Invalid API key
Response Sample
{
"channels": [
{
"id": 0,
"name": "string",
"channelType": "Marketing",
"messageMedium": "Email"
}
]
}
Response Schema
{} ChannelsResponse
channelsarray[ChannelDetails]
{} ChannelDetails
idinteger
namestring
channelTypestringChannel type
Can be Marketing or Transactional
messageMediumstringMedium of this channel
Can be Email, Push or SMS
GET CHANNELS GET
Request URL
Response Body
Response Code
Response Headers
UPDATE A USER'S SHOPPING CART ITEMS
POST /API/COMMERCE/UPDATECART
Show Samples
Update the shoppingCartItems field on the user profile with shopping cart items.
User profile is updated if it already exists (created otherwise) via the user
field. Types of data fields must match the types sent in previous requests,
across all data fields in the project.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
UpdateCartRequest
state of the cart
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
409
Email/userId conflict
Body Sample
{
"user": {
"email": "string",
"userId": "string",
"dataFields": {},
"preferUserId": true,
"mergeNestedObjects": true,
"createNewFields": true
},
"items": [
{
"id": "string",
"sku": "string",
"name": "string",
"description": "string",
"categories": [
"string"
],
"price": 0,
"quantity": 0,
"imageUrl": "string",
"url": "string",
"dataFields": {}
}
]
}
Body Schema
{} UpdateCartRequest
userApiUserUpdateRequest
itemsarray[CommerceItem]
{} ApiUserUpdateRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
dataFieldsobject(optional)Data to store on the user profile identified by userId
or email.
preferUserIdboolean(optional)Whether or not a new user should be created if the
request includes a userId that doesn't yet exist in the Iterable project.
Defaults to false. Only respected in API calls for email-based projects.
mergeNestedObjectsboolean(optional)Merge top-level objects instead of
overwriting them. Defaults to false. For example, if a user profile has data
{"mySettings":{"mobile":true}} and the request has data
{"mySettings":{"email":true}}, merging results in
{"mySettings":{"mobile":true,"email":true}}.
createNewFieldsboolean(optional)Whether new fields should be ingested and added
to the schema. Defaults to project's setting to allow or drop unrecognized
fields.
{} CommerceItem
idstringUnique product identifier
skustring(optional)
namestring
descriptionstring(optional)
categoriesarray[string](optional)Categories this product belongs to. It can
belong to multiple categories. Each category is a breadcrumb in list form.
pricenumber
quantityinteger
imageUrlstring(optional)URL to an image of the item.
urlstring(optional)URL to the item.
dataFieldsobject(optional)Additional item properties
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UPDATE A USER'S SHOPPING CART ITEMS POST
Request URL
Response Body
Response Code
Response Headers
TRACK A PURCHASE
POST /API/COMMERCE/TRACKPURCHASE
Show Samples
Track purchase events. shoppingCartItems field on the user profile is cleared.
User profile is also updated if it already exists (created otherwise) using the
user request field. Also, note that there is a soft limit on the number of
unique fields a user can have (default is 1,000). Types of data fields must
match the types sent in previous requests, across all data fields in the
project.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
TrackPurchaseRequest
purchase data
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
409
Email/userId conflict
Body Sample
{
"id": "string",
"user": {
"email": "string",
"userId": "string",
"dataFields": {},
"preferUserId": true,
"mergeNestedObjects": true,
"createNewFields": true
},
"items": [
{
"id": "string",
"sku": "string",
"name": "string",
"description": "string",
"categories": [
"string"
],
"price": 0,
"quantity": 0,
"imageUrl": "string",
"url": "string",
"dataFields": {}
}
],
"campaignId": 0,
"templateId": 0,
"total": 0,
"createdAt": 0,
"dataFields": {}
}
Body Schema
{} TrackPurchaseRequest
idstring(optional)Optional purchase id. If a purchase exists with that id, the
purchase will be updated. If none is specified, a new id will automatically be
generated and returned. Note that this ID cannot be longer than 512 bytes.
userApiUserUpdateRequest
itemsarray[CommerceItem]
campaignIdinteger(optional)
templateIdinteger(optional)Used in AB testing attribution
totalnumberTotal order dollar amount
createdAtinteger(optional)Time event happened. Set to the time event was
received if unspecified. Expects a Unix timestamp.
dataFieldsobject(optional)Additional fields to be tracked.
{} ApiUserUpdateRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
dataFieldsobject(optional)Data to store on the user profile identified by userId
or email.
preferUserIdboolean(optional)Whether or not a new user should be created if the
request includes a userId that doesn't yet exist in the Iterable project.
Defaults to false. Only respected in API calls for email-based projects.
mergeNestedObjectsboolean(optional)Merge top-level objects instead of
overwriting them. Defaults to false. For example, if a user profile has data
{"mySettings":{"mobile":true}} and the request has data
{"mySettings":{"email":true}}, merging results in
{"mySettings":{"mobile":true,"email":true}}.
createNewFieldsboolean(optional)Whether new fields should be ingested and added
to the schema. Defaults to project's setting to allow or drop unrecognized
fields.
{} CommerceItem
idstringUnique product identifier
skustring(optional)
namestring
descriptionstring(optional)
categoriesarray[string](optional)Categories this product belongs to. It can
belong to multiple categories. Each category is a breadcrumb in list form.
pricenumber
quantityinteger
imageUrlstring(optional)URL to an image of the item.
urlstring(optional)URL to the item.
dataFieldsobject(optional)Additional item properties
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRACK A PURCHASE POST
Request URL
Response Body
Response Code
Response Headers
SEND AN EMAIL TO AN EMAIL ADDRESS
POST /API/EMAIL/TARGET
Show Samples
Send an email to a specific email address. Request data fields will override
user profile data fields. A reference to the user profile is provided via the
profile field, to help resolve field collisions.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
TargetEmailRequest
Recipient and email id
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"campaignId": 0,
"recipientEmail": "string",
"recipientUserId": "string",
"dataFields": {},
"sendAt": "string",
"allowRepeatMarketingSends": true,
"metadata": {}
}
Body Schema
{} TargetEmailRequest
campaignIdintegerCampaign ID
recipientEmailstring(optional)An email address that identifies a user profile in
Iterable. Provide a recipientEmail or a recipientUserId (but not both),
depending on how your project identifies users.
recipientUserIdstring(optional)A user ID that identifies a user profile in
Iterable. Provide a recipientEmail or a recipientUserId (but not both),
depending on how your project identifies users.
dataFieldsobject(optional)Fields to merge into email template
sendAtstring(optional)Schedule the message for up to 365 days in the future. If
set in the past, email is sent immediately. Format is YYYY-MM-DD HH:MM:SS in UTC
allowRepeatMarketingSendsboolean(optional)Allow repeat marketing sends? Defaults
to true.
metadataobject(optional)Metadata to pass back via webhooks. Not used for
rendering
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
SEND AN EMAIL TO AN EMAIL ADDRESS POST
Request URL
Response Body
Response Code
Response Headers
CANCEL AN EMAIL TO A USER
POST /API/EMAIL/CANCEL
Show Samples
Cancels an email to a specific user. Request must include a campaignId and an
email or userId, or just a scheduledMessageId.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
CancelScheduledMessageRequest - campaignId OR scheduledMessageId are required
Email and Campaign ID
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"campaignId": 0,
"scheduledMessageId": 0,
"userId": "string"
}
Body Schema
{} CancelScheduledMessageRequest - campaignId OR scheduledMessageId are required
emailstring(optional)An email address that identifies a user profile in
Iterable. If you provide a campaignId, you must also provide an email or a
userId, depending on how your project identifies users.
campaignIdnumber(optional)The ID of the campaign associated with the scheduled
message you'd like to cancel. If you provide a campaignId, you must also provide
an email or userId, depending on how your project identifies users.
scheduledMessageIdnumber(optional)
userIdstring(optional)A user ID that identifies a user profile in Iterable. If
you provide a campaignId, you must also provide an email or a userId, depending
on how your project identifies users.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CANCEL AN EMAIL TO A USER POST
Request URL
Response Body
Response Code
Response Headers
VIEW A PREVIOUSLY SENT EMAIL
GET /API/EMAIL/VIEWINBROWSER
Show Samples
View a rendered version of a previously sent email.
Learn about identifying users by userId and email.
Rate limit: 100 requests/second, per project.
PARAMETERS
email:
(query)
string
user's email
userId:
(query)
string
user's userId
messageId:
(query)
string
id of sent message
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
404
Data feed error encountered
422
Empty catalog collection encountered
VIEW A PREVIOUSLY SENT EMAIL GET
Request URL
Response Body
Response Code
Response Headers
GET A USER'S EMBEDDED MESSAGES
GET /API/EMBEDDED-MESSAGING/MESSAGES
Show Samples
This endpoint returns embedded messages for which the specified user is
eligible, grouped by placementId.
By default, it returns data for all placements that have messages for the user.
To constrain the response to specific placements, provide one or more
placementIds query parameters.
Learn about identifying users by userId and email.
PARAMETERS
email:
(query)
string
User identifier. Provide an email or a userId, but not both.
userId:
(query)
string
User identifier. Provide a userId or an email, but not both.
platform:
(query)
string
[Coming soon. Do not use.] The platform of the app for which to retrieve
embedded messages: iOS, Android, or Web (case-sensitive).
sdkVersion:
(query)
string
[Coming soon. Do not use.] Iterable SDK version (e.g., 6.5.0).
packageName:
(query)
string
[Coming soon. Do not use.] The package name of the app for which to retrieve
embedded messages.
placementIds:
(query)
array
Placements to include in the response, even if they don't have embedded messages
for the user. When no placementIds are specified, the response includes all
embedded messages for which the user is eligible.
currentMessageIds:
(query)
array
[Coming soon. Do not use.] IDs of embedded messages already retrieved by the
device making the request. If the user is no longer eligible for a specified
message, that message will be omitted from the API response. Otherwise, it will
be present, but without an elements field.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"placements": [
{
"placementId": 0,
"embeddedMessages": [
{
"metadata": {
"messageId": "string",
"placementId": 0,
"campaignId": {},
"isProof": true,
"priorityOrder": 0
},
"elements": {
"title": "string",
"body": "string",
"mediaUrl": "string",
"mediaUrlCaption": "string",
"buttons": [
{
"id": "string",
"title": "string",
"action": {
"type": "string",
"data": "string"
}
}
],
"text": [
{
"id": "string",
"label": "string",
"text": "string"
}
],
"defaultAction": {
"type": "string",
"data": "string"
}
},
"payload": {}
}
]
}
]
}
Response Schema
{} EmbeddedMessagesResponse
placementsarray[ApiEmbeddedPlacement](optional)Array of objects, each with a
placementId and an associated list of embedded messages for which the specified
user is eligible.
{} ApiEmbeddedPlacement
placementIdinteger(optional)ID of a placement.
embeddedMessagesarray[ApiEmbeddedMessage](optional)Array of embedded messages
associated with placementId. The user specified in the request is eligible for
all messages in this array.
{} ApiEmbeddedMessage
metadataApiEmbeddedMessagingMetadata(optional)Identifying information about the
embedded message.
elementsApiEmbeddedMessagingElements(optional)Content to display in the message,
and actions to invoke on click or tap.
payloadobject(optional)Custom JSON data. Use to customize the message display or
trigger custom behavior.
{} ApiEmbeddedMessagingMetadata
messageIdstring(optional)ID associated with the specific send of a specific
campaign to a specific user.
placementIdinteger(optional)ID of the placement to which the embedded message
belongs.
campaignIdobject(optional)ID of the Iterable campaign associated with the
embedded message.
isProofboolean(optional)Whether or not the campaign is a test message (proof).
priorityOrderinteger(optional)Numeric priority, as compared to other embedded
campaigns in the same placement. Lower numbers mean higher priority. Highest
priority is 1.
{} ApiEmbeddedMessagingElements
titlestring(optional)Title text of the embedded message.
bodystring(optional)Body text of the embedded message.
mediaUrlstring(optional)Image URL associated with the embedded message.
mediaUrlCaptionstring(optional)Alt text for the image specified by mediaUrl.
buttonsarray[Button](optional)Buttons to display with the embedded message.
textarray[Text](optional)Text fields (other than title and body) to display with
the embedded message.
defaultActionAction(optional)Action to invoke when a user taps or clicks on the
embedded message (but not on a button or link).
{} Button
idstring(optional)ID of the button.
titlestring(optional)Text to display on the button.
actionAction(optional)Action to invoke when a user taps the button.
{} Text
idstring(optional)Deprecated field. Do not use. Use label as a key.
labelstring(optional)Identifier for the text field, specified by the user who
created its associated placement. This field is a key, not content. Do not
display it.
textstring(optional)Text to display.
{} Action
typestring(optional)For URL actions, this field is openUrl. For custom actions,
it's the full URL of the custom action.
datastring(optional)For URL actions, this field is a full URL. For custom
actions, it's an empty string.
GET A USER'S EMBEDDED MESSAGES GET
Request URL
Response Body
Response Code
Response Headers
CONSUME OR DELETE AN IN-APP MESSAGE
POST /API/EVENTS/INAPPCONSUME
Show Samples
Consumes or deletes an in-app message from the server. Use this API if your app
does not use one of Iterable’s mobile SDKs, since they call it automatically. If
an incoming in-app message is not configured to use the mobile inbox, use this
API to "consume" it from the server queue after the user sees it. Otherwise,
call this API when the user explicitly deletes an inbox-enabled message (by
clicking a delete button in its content, swiping it in the inbox, etc.). If you
pass a deleteAction value to this endpoint, Iterable generates an inAppDelete
event; otherwise, it does not.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
InAppConsumeRequest
In-app notification to consume
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"messageId": "string",
"messageContext": {
"saveToInbox": true,
"silentInbox": true,
"location": "string"
},
"deleteAction": "string",
"deviceInfo": {
"deviceId": "string",
"platform": "iOS",
"appPackageName": "string"
},
"createdAt": 0
}
Body Schema
{} InAppConsumeRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
messageIdstringThe ID of the message associated with the event
messageContextInboxMessageContext(optional)An object containing various fields
that describe the message associated with the event.
deleteActionstring(optional)How the message was deleted (for example,
inbox-swipe, delete-action, or a custom value).
deviceInfoDeviceInfo(optional)An object containing various fields that describe
the device and app associated with the event.
createdAtinteger(optional)Time event happened. Set to the time event was
received if unspecified. Expects a Unix timestamp.
{} InboxMessageContext
saveToInboxboolean(optional)Whether or not the message associated with the event
was configured to be stored in the inbox
silentInboxboolean(optional)Whether or not the message associated with the event
was configured to send directly to the inbox
locationstring(optional)Where the event occurred: in-app, inbox, or a custom
value (string).
{} DeviceInfo
deviceIdstring(optional)Device unique identifier.
platformstring(optional)Device platform (case-sensitive).
Can be iOS, Android or Web
appPackageNamestring(optional)Package name of the app.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CONSUME OR DELETE AN IN-APP MESSAGE POST
Request URL
Response Body
Response Code
Response Headers
TRACK AN IN-APP MESSAGE CLICK
POST /API/EVENTS/TRACKINAPPCLICK
Show Samples
Creates an inAppClick event for the specified user, message, and URL. When not
using one of Iterable’s mobile SDKs, call this endpoint when a user taps on a
button or link in an in-app message.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
InAppClickRequest
In-app click to track
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"messageId": "string",
"clickedUrl": "string",
"messageContext": {
"saveToInbox": true,
"silentInbox": true,
"location": "string"
},
"deviceInfo": {
"deviceId": "string",
"platform": "iOS",
"appPackageName": "string"
},
"createdAt": 0
}
Body Schema
{} InAppClickRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
messageIdstringThe ID of the message associated with the event
clickedUrlstring(optional)The URL of the clicked link/button
messageContextInboxMessageContext(optional)An object containing various fields
that describe the message associated with the event
deviceInfoDeviceInfo(optional)An object containing various fields that describe
the device and app associated with the event
createdAtinteger(optional)Time event happened. Set to the time event was
received if unspecified. Expects a Unix timestamp.
{} InboxMessageContext
saveToInboxboolean(optional)Whether or not the message associated with the event
was configured to be stored in the inbox
silentInboxboolean(optional)Whether or not the message associated with the event
was configured to send directly to the inbox
locationstring(optional)Where the event occurred: in-app, inbox, or a custom
value (string).
{} DeviceInfo
deviceIdstring(optional)Device unique identifier.
platformstring(optional)Device platform (case-sensitive).
Can be iOS, Android or Web
appPackageNamestring(optional)Package name of the app.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRACK AN IN-APP MESSAGE CLICK POST
Request URL
Response Body
Response Code
Response Headers
TRACK THE CLOSING OF AN IN-APP MESSAGE
POST /API/EVENTS/TRACKINAPPCLOSE
Show Samples
Creates an inAppClose event for a specific user and in-app message. When not
using Iterable's mobile SDKs, call this endpoint to indicate that the user
tapped a close button, link or back button to close a particular in app-message.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
InAppCloseRequest
In-app close to track
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"messageId": "string",
"clickedUrl": "string",
"messageContext": {
"saveToInbox": true,
"silentInbox": true,
"location": "string"
},
"closeAction": "string",
"deviceInfo": {
"deviceId": "string",
"platform": "iOS",
"appPackageName": "string"
},
"inboxSessionId": "string",
"createdAt": 0
}
Body Schema
{} InAppCloseRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
messageIdstringThe ID of the message associated with the event
clickedUrlstring(optional)url used to close the in-app
messageContextInboxMessageContext(optional)An object containing various fields
that describe the message associated with the event.
closeActionstring(optional)The type of action that initiated the close (for
example, link, back, or a custom value).
deviceInfoDeviceInfo(optional)An object containing various fields that describe
the device and app associated with the event.
inboxSessionIdstring(optional)Inbox SessionId
createdAtinteger(optional)Time event happened. Set to the time event was
received if unspecified. Expects a Unix timestamp.
{} InboxMessageContext
saveToInboxboolean(optional)Whether or not the message associated with the event
was configured to be stored in the inbox
silentInboxboolean(optional)Whether or not the message associated with the event
was configured to send directly to the inbox
locationstring(optional)Where the event occurred: in-app, inbox, or a custom
value (string).
{} DeviceInfo
deviceIdstring(optional)Device unique identifier.
platformstring(optional)Device platform (case-sensitive).
Can be iOS, Android or Web
appPackageNamestring(optional)Package name of the app.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRACK THE CLOSING OF AN IN-APP MESSAGE POST
Request URL
Response Body
Response Code
Response Headers
TRACK THE DELIVERY OF AN IN-APP MESSAGE
POST /API/EVENTS/TRACKINAPPDELIVERY
Show Samples
Creates an inAppDelivery event for a specific user, device, and message. When
not using Iterable's mobile SDKs, call this endpoint to indicate that a
particular message has been delivered to a particular device for a particular
user. Take care not to call this endpoint multiple times for the same
message/device/user combination.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
InAppDeliveryRequest
In-app delivery to track
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"messageId": "string",
"messageContext": {
"saveToInbox": true,
"silentInbox": true
},
"deviceInfo": {
"deviceId": "string",
"platform": "iOS",
"appPackageName": "string"
},
"createdAt": 0
}
Body Schema
{} InAppDeliveryRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
messageIdstringThe ID of the message associated with the event
messageContextMessageContext(optional)An object containing various fields that
describe the message associated with the event
deviceInfoDeviceInfo(optional)An object containing various fields that describe
the device and app associated with the event
createdAtinteger(optional)Time event happened. Set to the time event was
received if unspecified. Expects a Unix timestamp.
{} MessageContext
saveToInboxboolean(optional)Whether or not the message associated with the event
was configured to use the inbox
silentInboxboolean(optional)Whether or not the message associated with the event
was configured to send directly to the inbox
{} DeviceInfo
deviceIdstring(optional)Device unique identifier.
platformstring(optional)Device platform (case-sensitive).
Can be iOS, Android or Web
appPackageNamestring(optional)Package name of the app.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRACK THE DELIVERY OF AN IN-APP MESSAGE POST
Request URL
Response Body
Response Code
Response Headers
TRACK AN IN-APP MESSAGE OPEN
POST /API/EVENTS/TRACKINAPPOPEN
Show Samples
Creates an inAppOpen event for the specified user and message, and marks the
message as having been read. When not using one of Iterable’s mobile SDKs, call
this endpoint when a mobile app displays an in-app message to a user.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
InAppOpenRequest
In-app open to track
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"messageId": "string",
"messageContext": {
"saveToInbox": true,
"silentInbox": true,
"location": "string"
},
"deviceInfo": {
"deviceId": "string",
"platform": "iOS",
"appPackageName": "string"
},
"createdAt": 0
}
Body Schema
{} InAppOpenRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
messageIdstringThe ID of the message associated with the event
messageContextInboxMessageContext(optional)An object containing various fields
that describe the message associated with the event
deviceInfoDeviceInfo(optional)An object containing various fields that describe
the device and app associated with the event
createdAtinteger(optional)Time event happened. Set to the time event was
received if unspecified. Expects a Unix timestamp.
{} InboxMessageContext
saveToInboxboolean(optional)Whether or not the message associated with the event
was configured to be stored in the inbox
silentInboxboolean(optional)Whether or not the message associated with the event
was configured to send directly to the inbox
locationstring(optional)Where the event occurred: in-app, inbox, or a custom
value (string).
{} DeviceInfo
deviceIdstring(optional)Device unique identifier.
platformstring(optional)Device platform (case-sensitive).
Can be iOS, Android or Web
appPackageNamestring(optional)Package name of the app.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRACK AN IN-APP MESSAGE OPEN POST
Request URL
Response Body
Response Code
Response Headers
BULK TRACK EVENTS
POST /API/EVENTS/TRACKBULK
Show Samples
Events are created asynchronously and processed separately from single event
(non-bulk) endpoint. To make sure events are tracked in order, send them all to
the same endpoint (either bulk or non-bulk).
There is a soft limit (default is 8,000) on the number of unique fields a custom
event can have. For events of the same name, identically named data fields must
be of the same type.
Learn about identifying users by userId and email.
Rate limit: 10 requests/second, per project.
PARAMETERS
body:
(body)
Content type:
application/json
BulkTrackRequest
Events to track
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"events": [
{
"email": "string",
"userId": "string",
"eventName": "string",
"id": "string",
"createdAt": 0,
"dataFields": {},
"campaignId": 0,
"templateId": 0,
"createNewFields": true
}
]
}
Body Schema
{} BulkTrackRequest
eventsarray[TrackRequest]
{} TrackRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
eventNamestringName of event
idstring(optional)Optional event id. If an event exists with that id, the event
will be updated. If none is specified, a new id will automatically be generated
and returned. Note that this ID cannot be longer than 512 bytes.
createdAtinteger(optional)Time event happened. Set to the time event was
received if unspecified. Expects a unix timestamp.
dataFieldsobject(optional)Additional data associated with event (i.e. item
amount, item quantity). For events of the same name, identically named data
fields must be of the same type.
campaignIdinteger(optional)Campaign tied to conversion
templateIdinteger(optional)Template id
createNewFieldsboolean(optional)Whether new fields should be ingested and added
to the schema. Defaults to project's setting to allow or drop unrecognized
fields.
Response Sample
{
"successCount": 0,
"failCount": 0,
"invalidEmails": [
"string"
],
"invalidUserIds": [
"string"
],
"disallowedEventNames": [
"string"
],
"filteredOutFields": [
"string"
],
"createdFields": [
"string"
]
}
Response Schema
{} BulkTrackResponse
successCountinteger
failCountinteger
invalidEmailsarray[string](optional)
invalidUserIdsarray[string](optional)
disallowedEventNamesarray[string](optional)
filteredOutFieldsarray[string](optional)
createdFieldsarray[string](optional)
BULK TRACK EVENTS POST
Request URL
Response Body
Response Code
Response Headers
TRACK AN EVENT
POST /API/EVENTS/TRACK
Show Samples
Events are created asynchronously and processed separately from single event
(non-bulk) endpoint. To make sure events are tracked in order, send them all to
the same endpoint (either bulk or non-bulk).
There is a soft limit (default is 8,000) on the number of unique fields a custom
event can have. For events of the same name, identically named data fields must
be of the same type.
Learn about identifying users by userId and email.
Rate limit: 2000 requests/second, per project.
PARAMETERS
body:
(body)
Content type:
application/json
TrackRequest
Event to track
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"eventName": "string",
"id": "string",
"createdAt": 0,
"dataFields": {},
"campaignId": 0,
"templateId": 0,
"createNewFields": true
}
Body Schema
{} TrackRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
eventNamestringName of event
idstring(optional)Optional event id. If an event exists with that id, the event
will be updated. If none is specified, a new id will automatically be generated
and returned. Note that this ID cannot be longer than 512 bytes.
createdAtinteger(optional)Time event happened. Set to the time event was
received if unspecified. Expects a unix timestamp.
dataFieldsobject(optional)Additional data associated with event (i.e. item
amount, item quantity). For events of the same name, identically named data
fields must be of the same type.
campaignIdinteger(optional)Campaign tied to conversion
templateIdinteger(optional)Template id
createNewFieldsboolean(optional)Whether new fields should be ingested and added
to the schema. Defaults to project's setting to allow or drop unrecognized
fields.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRACK AN EVENT POST
Request URL
Response Body
Response Code
Response Headers
TRACK A WEB PUSH CLICK
POST /API/EVENTS/TRACKWEBPUSHCLICK
Show Samples
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
WebPushClickEventRequest
Web Push click to track
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"messageId": "string",
"campaignId": 0,
"templateId": 0,
"createdAt": 0
}
Body Schema
{} WebPushClickEventRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
messageIdstring
campaignIdinteger(optional)
templateIdinteger(optional)
createdAtinteger(optional)Time event happened. Set to the time event was
received if unspecified. Expects a Unix timestamp.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRACK A WEB PUSH CLICK POST
Request URL
Response Body
Response Code
Response Headers
TRACK A MOBILE PUSH OPEN
POST /API/EVENTS/TRACKPUSHOPEN
Show Samples
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
TrackPushOpenRequest
Push open to track
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"campaignId": 0,
"templateId": 0,
"messageId": "string",
"createdAt": 0,
"dataFields": {}
}
Body Schema
{} TrackPushOpenRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
campaignIdintegerCampaign tied to open
templateIdinteger(optional)Used in AB testing attribution
messageIdstringIterable-generated Message ID
createdAtinteger(optional)Timestamp of the open event. If unspecified, set to
the time event was received Expects a unix timestamp.
dataFieldsobject(optional)Additional data associated with event
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRACK A MOBILE PUSH OPEN POST
Request URL
Response Body
Response Code
Response Headers
GET USER EVENTS
GET /API/EVENTS/{EMAIL}
Show Samples
Get events for a specific user, by email.
On Iterable's API Documentation page, this endpoint does not work for email
values that contain a / character. In such cases, you can still call this
endpoint with a tool like curl or Postman, or from your code. To learn how, read
Using API keys.
Learn about identifying users by userId and email.
Rate limit: 100 requests/second, per project.
PARAMETERS
email:
(path)
string
Email of the user whose events you are retrieving.
limit:
(query)
integer
The number of events to retrieve. (Max is 200)
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"events": [
{}
]
}
Response Schema
{} GetEventsResponse
eventsarray[Inline Model 1]
{} Inline Model 1
GET USER EVENTS GET
Request URL
Response Body
Response Code
Response Headers
GET USER EVENTS BY USERID
GET /API/EVENTS/BYUSERID/{USERID}
Show Samples
Get events for a specific user, by userId.
On Iterable's API Documentation page, this endpoint does not work for userId
values that contain a / character. In such cases, you can still call this
endpoint with a tool like curl or Postman, or from your code. To learn how, read
Using API keys.
Learn about identifying users by userId and email.
Rate limit: 100 requests/second, per project.
PARAMETERS
userId:
(path)
string
UserId of the user whose events you are retrieving.
limit:
(query)
integer
The number of events to retrieve. (Max is 200)
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"events": [
{}
]
}
Response Schema
{} GetEventsResponse
eventsarray[Inline Model 1]
{} Inline Model 1
GET USER EVENTS BY USERID GET
Request URL
Response Body
Response Code
Response Headers
TRACK AN EMBEDDED MESSAGE SESSION AND RELATED IMPRESSIONS
POST /API/EMBEDDED-MESSAGING/EVENTS/SESSION
Show Samples
This endpoint tracks a single embeddedSession event, and one embeddedImpression
event for each of the session's impressions.
An embeddedSession event represents a period of time when a user is viewing a
page or a screen where embedded messages can be displayed (in one or many
placements).
An embeddedImpression event represents the number of times a given embedded
message was visible during the session, and the total amount of time the message
was visible (in seconds) across all those appearances.
This endpoint does not create events for test messages (proofs).
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
EmbeddedSessionRequest
Track an embedded message session and related impressions
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"session": {
"id": "string",
"start": 0,
"end": 0
},
"impressions": [
{
"messageId": "string",
"placementId": {},
"displayCount": 0,
"displayDuration": 0
}
],
"deviceInfo": {
"deviceId": "string",
"platform": "iOS",
"appPackageName": "string"
},
"createdAt": 0
}
Body Schema
{} EmbeddedSessionRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
sessionSession(optional)Information about the session (period of time when a
user was viewing a screen or page that displays embedded messages, in one or
many placements).
impressionsarray[Impression](optional)Impressions associated with the session.
deviceInfoDeviceInfo(optional)An object containing various fields that describe
the device and app associated with the session.
createdAtinteger(optional)The time of the event's occurrence (Unix timestamp).
If unspecified, gets set to the time Iterable received the event.
{} Session
idstring(optional)Unique identifier (such as a UUID) to associate with the
session.
startinteger(optional)Session start time (Unix timestamp).
endinteger(optional)Session end time (Unix timestamp).
{} Impression
messageIdstring(optional)ID of a message that appeared during the session.
placementIdobject(optional)ID of the placement where the impression took place.
displayCountinteger(optional)Total number of times the message identified by
messageId was visible during the session.
displayDurationnumber(optional)Total amount of time (in seconds) the message
identified by messageId was visible during the session, across all its
appearances.
{} DeviceInfo
deviceIdstring(optional)Device unique identifier.
platformstring(optional)Device platform (case-sensitive).
Can be iOS, Android or Web
appPackageNamestring(optional)Package name of the app.
TRACK AN EMBEDDED MESSAGE SESSION AND RELATED IMPRESSIONS POST
Request URL
Response Body
Response Code
Response Headers
TRACK AN EMBEDDED MESSAGE CLICK
POST /API/EMBEDDED-MESSAGING/EVENTS/CLICK
Show Samples
This endpoint tracks a click on an embedded message. It creates an embeddedClick
event.
For test messages (proofs), no events are created.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
EmbeddedClickRequest
Track an embedded message click
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"messageId": "string",
"buttonIdentifier": "string",
"targetUrl": "string",
"deviceInfo": {
"deviceId": "string",
"platform": "iOS",
"appPackageName": "string"
},
"createdAt": 0
}
Body Schema
{} EmbeddedClickRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
messageIdstringID of the message on which the click occurred.
buttonIdentifierstring(optional)ID of the button that was clicked (button IDs
are defined in Iterable, as part of the template / campaign).
targetUrlstring(optional)URL associated with the click.
deviceInfoDeviceInfo(optional)An object containing various fields that describe
the device and app associated with the click.
createdAtinteger(optional)The time of the click's occurrence (Unix timestamp).
If unspecified, gets set to the time Iterable received the event.
{} DeviceInfo
deviceIdstring(optional)Device unique identifier.
platformstring(optional)Device platform (case-sensitive).
Can be iOS, Android or Web
appPackageNamestring(optional)Package name of the app.
TRACK AN EMBEDDED MESSAGE CLICK POST
Request URL
Response Body
Response Code
Response Headers
TRACK AN EMBEDDED MESSAGE RECEIVED EVENT
POST /API/EMBEDDED-MESSAGING/EVENTS/RECEIVED
Show Samples
This endpoint tracks that a given embedded message was received on a device. It
creates an embeddedReceived event in Iterable.
An embeddedReceived event indicates that a device has retrieved a message. It
does not mean that the message has been displayed.
Iterable's SDKs automatically call this endpoint for each embedded message they
retrieve. If you're not using an SDK, call this endpoint once per embedded
message you retrieve from Iterable's API.
For test messages (proofs), no events are created.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
EmbeddedReceivedRequest
Track an embedded message received event
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"messageId": "string",
"deviceInfo": {
"deviceId": "string",
"platform": "iOS",
"appPackageName": "string"
},
"createdAt": 0
}
Body Schema
{} EmbeddedReceivedRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
messageIdstringID of the message that was retrieved by a device.
deviceInfoDeviceInfo(optional)An object containing various fields that describe
the device and app associated with the message receipt.
createdAtinteger(optional)The time of the event's occurrence (Unix timestamp).
If unspecified, gets set to the time Iterable received the event.
{} DeviceInfo
deviceIdstring(optional)Device unique identifier.
platformstring(optional)Device platform (case-sensitive).
Can be iOS, Android or Web
appPackageNamestring(optional)Package name of the app.
TRACK AN EMBEDDED MESSAGE RECEIVED EVENT POST
Request URL
Response Body
Response Code
Response Headers
GET METRICS FOR EXPERIMENTS
GET /API/EXPERIMENTS/METRICS
Show Samples
Get metrics for a single experiment or for multiple experiments. Note that we
currently only support exporting email experiment metrics.
PARAMETERS
experimentId:
(query)
array
Experiment to export. Specify multiple experimentId query parameters to export
multiple experiments.
campaignId:
(query)
array
Campaign whose experiments you want to export. Specify multiple campaignId query
parameters to export multiple campaigns.
startDateTime:
(query)
string
export starting from (>=)
endDateTime:
(query)
string
export ending at (<=)
Response Type:
text/csv
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"headers": "string",
"rows": [
"string"
]
}
Response Schema
{} ExperimentMetricsResponse
headersstring(optional)
rowsarray[string](optional)Rows of the report.
GET METRICS FOR EXPERIMENTS GET
Request URL
Response Body
Response Code
Response Headers
EXPORT DATA TO CSV
GET /API/EXPORT/DATA.CSV
Show Samples
Export campaign analytics data in CSV format. Use of either 'range' or
'startDateTime' and 'endDateTime' is required.
Rate limit: 4 requests/minute, per project.
PARAMETERS
dataTypeName:
(query)
emailSend emailOpen emailClick hostedUnsubscribeClick emailComplaint emailBounce
emailSendSkip pushSend pushOpen pushUninstall pushBounce pushSendSkip inAppSend
inAppOpen inAppClick inAppClose inAppDelete inAppDelivery inAppSendSkip
inAppRecall inboxSession inboxMessageImpression smsSend smsBounce smsClick
smsReceived smsSendSkip webPushSend webPushClick webPushSendSkip emailSubscribe
emailUnSubscribe purchase customEvent user smsUsageInfo embeddedSend
embeddedSendSkip embeddedClick embeddedReceived embeddedImpression
embeddedSession anonSession
string
data type name
range:
(query)
Today (default) Yesterday BeforeToday All
string
date range, uses UTC time
delimiter:
(query)
string
CSV file delimiter
startDateTime:
(query)
string
Export starting from (>=) (yyyy-MM-dd HH:mm:ss [ZZ])
endDateTime:
(query)
string
Export ending at (<) (yyyy-MM-dd HH:mm:ss [ZZ])
omitFields:
(query)
string
Fields to omit (comma separated)
onlyFields:
(query)
array
Only export these fields (comma separated)
campaignId:
(query)
integer
Only export data from this campaign
Response Type:
text/csv
RESPONSES
400
Invalid parameters
401
Invalid API key
429
Rate limit exceeded
EXPORT DATA TO CSV GET
Request URL
Response Body
Response Code
Response Headers
EXPORT DATA TO JSON
GET /API/EXPORT/DATA.JSON
Show Samples
Export campaign analytics data in JSON format, one entry per line. Use of either
'range' or 'startDateTime' and 'endDateTime' is required.
Rate limit: 4 requests/minute, per project.
PARAMETERS
dataTypeName:
(query)
emailSend emailOpen emailClick hostedUnsubscribeClick emailComplaint emailBounce
emailSendSkip pushSend pushOpen pushUninstall pushBounce pushSendSkip inAppSend
inAppOpen inAppClick inAppClose inAppDelete inAppDelivery inAppSendSkip
inAppRecall inboxSession inboxMessageImpression smsSend smsBounce smsClick
smsReceived smsSendSkip webPushSend webPushClick webPushSendSkip emailSubscribe
emailUnSubscribe purchase customEvent user smsUsageInfo embeddedSend
embeddedSendSkip embeddedClick embeddedReceived embeddedImpression
embeddedSession anonSession
string
data type name
range:
(query)
Today (default) Yesterday BeforeToday All
string
date range, uses UTC time
startDateTime:
(query)
string
Export starting from (>=) (yyyy-MM-dd HH:mm:ss [ZZ])
endDateTime:
(query)
string
Export ending at (<) (yyyy-MM-dd HH:mm:ss [ZZ])
omitFields:
(query)
string
Fields to omit (comma separated)
onlyFields:
(query)
array
Only export these fields (comma separated)
campaignId:
(query)
integer
Only export data from this campaign
Response Type:
application/x-json-stream
RESPONSES
400
Invalid parameters
401
Invalid API key
429
Rate limit exceeded
EXPORT DATA TO JSON GET
Request URL
Response Body
Response Code
Response Headers
EXPORT USER EVENTS
GET /API/EXPORT/USEREVENTS
Show Samples
Export all events (in JSON) for the user specified by email or userId. One event
per line.
Learn about identifying users by userId and email.
PARAMETERS
email:
(query)
string
Export by user's email
userId:
(query)
string
Export by user's ID
includeCustomEvents:
(query)
true false (default)
boolean
Include Custom Events
Response Type:
application/x-json-stream
RESPONSES
400
Invalid parameters
401
Invalid API key
429
Rate limit exceeded
EXPORT USER EVENTS GET
Request URL
Response Body
Response Code
Response Headers
START EXPORT
POST /API/EXPORT/START
Show Samples
Start a data export. The export processes as a background job. Use the "Get
export files" endpoint to check export status by jobId and obtain file download
links.
Rate limit: 1 request/second, per organization.
Concurrent request limit: Up to 4 exports process at a time, per organization.
Additional requests are queued.
PARAMETERS
body:
(body)
Content type:
application/json
StartExportRequest
Start export request
Response Type:
application/json
Body Sample
{
"outputFormat": "text/csv",
"dataTypeName": "emailSend",
"startDateTime": "string",
"endDateTime": "string",
"omitFields": "string",
"onlyFields": "string",
"campaignId": 0,
"delimiter": ","
}
Body Schema
{} StartExportRequest
outputFormatstringOutput format
Can be text/csv or application/x-json-stream
dataTypeNamestringData type name
Can be emailSend, emailOpen, emailClick, hostedUnsubscribeClick, emailComplaint,
emailBounce, emailSendSkip, pushSend, pushOpen, pushUninstall, pushBounce,
pushSendSkip, inAppSend, inAppOpen, inAppClick, inAppClose, inAppDelete,
inAppDelivery, inAppSendSkip, inAppRecall, inboxSession, inboxMessageImpression,
smsSend, smsBounce, smsClick, smsReceived, smsSendSkip, webPushSend,
webPushClick, webPushSendSkip, emailSubscribe, emailUnSubscribe, purchase,
customEvent, user, smsUsageInfo, embeddedSend, embeddedSendSkip, embeddedClick,
embeddedReceived, embeddedImpression, embeddedSession or anonSession
startDateTimestring(optional)Export events occurring or users updated after date
and time inclusive (yyyy-MM-dd HH:mm:ss [ZZ])
endDateTimestring(optional)Export events occurring or users updated before date
and time exclusive (yyyy-MM-dd HH:mm:ss [ZZ])
omitFieldsstring(optional)Fields to omit from the export (comma separated)
onlyFieldsstring(optional)Only include these fields in the export (comma
separated)
campaignIdinteger(optional)Only export data from this campaign
delimiterstring(optional)CSV file delimiter
Response Sample
{
"jobId": 3562
}
Response Schema
{} StartExportResponse
jobIdintegerThe ID of the export job
START EXPORT POST
Request URL
Response Body
Response Code
Response Headers
GET EXPORT FILES
GET /API/EXPORT/{JOBID}/FILES
Show Samples
Get the job status and files for an export started with the "Start export"
endpoint.
Occasionally, a job status may change from running to enqueued because it had to
restart. When this happens, the job maintains progress and begins where it
previously stopped. Iterable uses exponential backoff for retries.
Files are added to the list as the export job is running. Paginate through the
files by using the last file name in the response as the startAfter value for
the next request. Each file is up to 10MB. Exports are limited to 100GB in total
size.
Rate limit: 1 request/second, per organization.
Concurrent request limit: Up to 4 exports process at a time, per organization.
Additional requests are queued.
PARAMETERS
jobId:
(path)
integer
The ID of the export job. Use the jobId returned from the "Start export"
endpoint.
startAfter:
(query)
string
Skip file names up to and including this value. Use for paginating over the
files in the export.
Response Type:
application/json
Response Sample
{
"jobId": 3562,
"jobState": "Running",
"exportTruncated": true,
"files": [
{
"file": "file-1679086247925.csv",
"url": "string"
}
]
}
Response Schema
{} ExportJobStatusAndFiles
jobIdintegerThe ID of the export job
jobStatestringThe state of the export job
Can be Enqueued, Running, Completed or Failed
exportTruncatedbooleanWhether the export was truncated because it exceeded the
max allowed export size
filesarray[ExportFileAndUrl]The current page of files
{} ExportFileAndUrl
filestringThe name of the file.
urlstringA URL that can be used to download the file. Expires after 12 hours.
GET EXPORT FILES GET
Request URL
Response Body
Response Code
Response Headers
CANCEL EXPORT
DELETE /API/EXPORT/{JOBID}
Show Samples
Cancel a queued or running export created with the "Start export" endpoint.
Rate limit: 1 request/second, per project.
PARAMETERS
jobId:
(path)
integer
The ID of the export job. Use the jobId returned from the "Start export"
endpoint.
RESPONSES
default
successful operation
CANCEL EXPORT DELETE
Request URL
Response Body
Response Code
Response Headers
GET EXPORT JOBS
GET /API/EXPORT/JOBS
Show Samples
Return a list of recent export jobs. Only includes jobs for the current project
and not other projects.
PARAMETERS
jobState:
(query)
string
Filter results to only include jobs in the specified state
Response Type:
application/json
Response Sample
{
"jobs": [
{
"id": 3562,
"jobState": "Running",
"scheduledStartTime": "2023-12-19T10:12:27.732-06:00",
"endTime": "2023-12-19T10:12:28.214-06:00",
"dataTypeName": "user",
"bytesExported": 2453629
}
]
}
Response Schema
{} JobsResponse
jobsarray[JobModel](optional)The list of jobs
{} JobModel
idinteger(optional)The ID of the job
jobStateJobStateThe state of the job
scheduledStartTimestring(optional)The earliest time the job can start
endTimestring(optional)The time at which the job completed or failed
dataTypeNameClientDataType(optional)Data type name
bytesExportedinteger(optional)Number of bytes exported
{} JobState
finalboolean
{} ClientDataType
updatableboolean
sendboolean
GET EXPORT JOBS GET
Request URL
Response Body
Response Code
Response Headers
SEND AN IN-APP NOTIFICATION TO A USER
POST /API/INAPP/TARGET
Show Samples
Send an in-app notification to a specific user. Request data fields will
override user profile data fields. A reference to the user profile is provided
via the profile field, to help resolve field collisions.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
TargetInAppRequest
Recipient and email id
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"campaignId": 0,
"recipientEmail": "string",
"recipientUserId": "string",
"dataFields": {},
"sendAt": "string",
"allowRepeatMarketingSends": true
}
Body Schema
{} TargetInAppRequest
campaignIdintegerCampaign ID
recipientEmailstring(optional)An email address that identifies a user profile in
Iterable. Provide a recipientEmail or a recipientUserId (but not both),
depending on how your project identifies users.
recipientUserIdstring(optional)A user ID that identifies a user profile in
Iterable. Provide a recipientEmail or a recipientUserId (but not both),
depending on how your project identifies users.
dataFieldsobject(optional)Fields to merge into email template
sendAtstring(optional)Schedule the message for up to 365 days in the future. If
set in the past, message is sent immediately. Format is YYYY-MM-DD HH:MM:SS in
UTC
allowRepeatMarketingSendsboolean(optional)Allow repeat marketing sends? Defaults
to true.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
SEND AN IN-APP NOTIFICATION TO A USER POST
Request URL
Response Body
Response Code
Response Headers
CANCEL A SCHEDULED IN-APP MESSAGE
POST /API/INAPP/CANCEL
Show Samples
Cancels the sending of a scheduled in-app message to a specific user.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
CancelScheduledMessageRequest - campaignId OR scheduledMessageId are required
Email and Campaign ID
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"campaignId": 0,
"scheduledMessageId": 0,
"userId": "string"
}
Body Schema
{} CancelScheduledMessageRequest - campaignId OR scheduledMessageId are required
emailstring(optional)An email address that identifies a user profile in
Iterable. If you provide a campaignId, you must also provide an email or a
userId, depending on how your project identifies users.
campaignIdnumber(optional)The ID of the campaign associated with the scheduled
message you'd like to cancel. If you provide a campaignId, you must also provide
an email or userId, depending on how your project identifies users.
scheduledMessageIdnumber(optional)
userIdstring(optional)A user ID that identifies a user profile in Iterable. If
you provide a campaignId, you must also provide an email or a userId, depending
on how your project identifies users.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CANCEL A SCHEDULED IN-APP MESSAGE POST
Request URL
Response Body
Response Code
Response Headers
GET A USER'S MOST RELEVANT IN-APP MESSAGE
GET /API/INAPP/GETPRIORITYMESSAGE
Show Samples
Get a user's most relevant in-app message.
Learn about identifying users by userId and email.
PARAMETERS
email:
(query)
string
The email address of the user for which to fetch in-app messages. Specify either
an email or a userId.
userId:
(query)
string
The userId of the user for which to fetch in-app messages. Specify either an
email or a userId.
platform:
(query)
iOS Android Web OTT
string
The platform of the app for which to retrieve selective in-app messages: iOS,
Android, Web, or OTT (case-sensitive).
SDKVersion:
(query)
string
Iterable SDK version (e.g., 6.2.17)
packageName:
(query)
string
The package name of the app for which to retrieve selective in-app messages.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"inAppMessages": [
{
"messageId": "string",
"campaignId": 0,
"createdAt": "2024-05-30T17:43:09.464Z",
"expiresAt": "2024-05-30T17:43:09.464Z",
"content": {
"html": "string",
"ottPayload": {
"backgroundColor": "string",
"dialogText": "string",
"dialogHeader": "string",
"fhd_image": "string",
"dialogBodyFont": "string",
"dialogButtonFont": "string",
"dialogHeaderFont": "string",
"buttons": [
{
"buttonTextColorFocused": "string",
"buttonColorFocused": "string",
"buttonTextColorUnFocused": "string",
"buttonDeeplink": "string",
"buttonColorUnFocused": "string",
"buttonText": "string",
"buttonBorderColor": "string"
}
],
"textColor": "string"
},
"inAppDisplaySettings": {
"top": {},
"right": {},
"bottom": {},
"left": {},
"bgColor": {
"alpha": 0,
"hex": "string"
},
"shouldAnimate": true
},
"webInAppDisplaySettings": {
"position": {}
}
},
"customPayload": {},
"ottPayload": {
"backgroundColor": "string",
"dialogText": "string",
"dialogHeader": "string",
"fhd_image": "string",
"dialogBodyFont": "string",
"dialogButtonFont": "string",
"dialogHeaderFont": "string",
"buttons": [
{
"buttonTextColorFocused": "string",
"buttonColorFocused": "string",
"buttonTextColorUnFocused": "string",
"buttonDeeplink": "string",
"buttonColorUnFocused": "string",
"buttonText": "string",
"buttonBorderColor": "string"
}
],
"textColor": "string"
},
"trigger": {
"type": {}
},
"saveToInbox": true,
"inboxMetadata": {
"title": "string",
"subtitle": "string",
"icon": "string"
},
"priorityLevel": 0,
"read": true,
"jsonOnly": true,
"typeOfContent": {},
"messageType": {}
}
]
}
Response Schema
{} ApiInAppMessagesResponse
inAppMessagesarray[ApiInAppMessage]
{} ApiInAppMessage
messageIdstring(optional)Iterable-generated Message ID
campaignIdnumber(optional)Campaign ID
createdAtstring(optional)Time the In-app message was created
expiresAtstring(optional)Time the in-app message will expire
contentInAppContentApi(optional)The content for the in-app message
customPayloadobject(optional)The custom payload for the in-app message
ottPayloadRokuContent(optional)The custom Roku payload for the in-app message
triggerInAppTrigger(optional)The trigger type for the in-app message
saveToInboxboolean(optional)Whether or not the message associated with the event
was configured to use the inbox
inboxMetadataInboxMetadata(optional)An object containing inbox metadata
associated with this in-app message
priorityLevelnumber(optional)The priority value of the in-app message
readboolean(optional)Whether or not the message was read by user
jsonOnlyboolean
typeOfContentInAppTypeOfContent
messageTypeInAppType
{} InAppContentApi
htmlstring(optional)The html to be displayed
ottPayloadRokuContent(optional)
inAppDisplaySettingsInAppDisplaySettings(optional)The in-app message display
settings
webInAppDisplaySettingsWebInAppDisplaySettings
{} RokuContent
backgroundColorstring(optional)
dialogTextstring(optional)
dialogHeaderstring(optional)
fhd_imagestring(optional)
dialogBodyFontstring(optional)
dialogButtonFontstring(optional)
dialogHeaderFontstring(optional)
buttonsarray[RokuButtonContent](optional)
textColorstring(optional)
{} InAppTrigger
typeValue(optional)How the in-app message was triggered
{} InboxMetadata
titlestring(optional)The title to display in the inbox
subtitlestring(optional)The subtitle to display in the inbox
iconstring(optional)The icon to display in the inbox
{} InAppTypeOfContent
{} InAppType
{} InAppDisplaySettings
topInAppDisplaySetting(optional)Padding percentage for the top of the
notification, or -1 to autoexpand
rightInAppDisplaySetting(optional)Padding percentage for the right of the
notification, or -1 to autoexpand
bottomInAppDisplaySetting(optional)Padding percentage for the bottom of the
notification, or -1 to autoexpand
leftInAppDisplaySetting(optional)Padding percentage for the left of the
notification, or -1 to autoexpand
bgColorBgColor(optional)The background color values
shouldAnimateboolean(optional)Enables In App Animations
{} WebInAppDisplaySettings
positionPositionOption(optional)The position of the message on the screen
{} RokuButtonContent
buttonTextColorFocusedstring
buttonColorFocusedstring
buttonTextColorUnFocusedstring
buttonDeeplinkstring
buttonColorUnFocusedstring
buttonTextstring
buttonBorderColorstring
{} Value
{} InAppDisplaySetting
{} BgColor
alphanumber(optional)The opacity range of the background between 0-1
hexstring(optional)The hex color of the background. Format: #FFFFFF
{} PositionOption
GET A USER'S MOST RELEVANT IN-APP MESSAGE GET
Request URL
Response Body
Response Code
Response Headers
GET A USER'S IN-APP MESSAGES
GET /API/INAPP/GETMESSAGES
Show Samples
Get a user's in-app messages. This endpoint always returns the user's
non-selective (not app-specific) in-app messages; to also fetch app-specific
in-app messages, include a packageName and platform in the request. This
endpoint returns new messages and messages that have already been saved to a
mobile inbox, and each message has a read field to indicate whether or not it
has already been seen.
Learn about identifying users by userId and email.
PARAMETERS
email:
(query)
string
The email address of the user for which to fetch in-app messages. Specify either
an email or a userId.
userId:
(query)
string
The userId of the user for which to fetch in-app messages. Specify either an
email or a userId.
count:
(query)
integer
The number of in-app messages to fetch.
platform:
(query)
iOS Android Web OTT
string
The platform of the app for which to retrieve selective in-app messages: iOS,
Android, Web, or OTT (case-sensitive).
SDKVersion:
(query)
string
Iterable SDK version (e.g., 6.2.17)
packageName:
(query)
string
The package name of the app for which to retrieve selective in-app messages.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"inAppMessages": [
{
"messageId": "string",
"campaignId": 0,
"createdAt": "2024-05-30T17:43:09.466Z",
"expiresAt": "2024-05-30T17:43:09.466Z",
"content": {
"html": "string",
"ottPayload": {
"backgroundColor": "string",
"dialogText": "string",
"dialogHeader": "string",
"fhd_image": "string",
"dialogBodyFont": "string",
"dialogButtonFont": "string",
"dialogHeaderFont": "string",
"buttons": [
{
"buttonTextColorFocused": "string",
"buttonColorFocused": "string",
"buttonTextColorUnFocused": "string",
"buttonDeeplink": "string",
"buttonColorUnFocused": "string",
"buttonText": "string",
"buttonBorderColor": "string"
}
],
"textColor": "string"
},
"inAppDisplaySettings": {
"top": {},
"right": {},
"bottom": {},
"left": {},
"bgColor": {
"alpha": 0,
"hex": "string"
},
"shouldAnimate": true
},
"webInAppDisplaySettings": {
"position": {}
}
},
"customPayload": {},
"ottPayload": {
"backgroundColor": "string",
"dialogText": "string",
"dialogHeader": "string",
"fhd_image": "string",
"dialogBodyFont": "string",
"dialogButtonFont": "string",
"dialogHeaderFont": "string",
"buttons": [
{
"buttonTextColorFocused": "string",
"buttonColorFocused": "string",
"buttonTextColorUnFocused": "string",
"buttonDeeplink": "string",
"buttonColorUnFocused": "string",
"buttonText": "string",
"buttonBorderColor": "string"
}
],
"textColor": "string"
},
"trigger": {
"type": {}
},
"saveToInbox": true,
"inboxMetadata": {
"title": "string",
"subtitle": "string",
"icon": "string"
},
"priorityLevel": 0,
"read": true,
"jsonOnly": true,
"typeOfContent": {},
"messageType": {}
}
]
}
Response Schema
{} ApiInAppMessagesResponse
inAppMessagesarray[ApiInAppMessage]
{} ApiInAppMessage
messageIdstring(optional)Iterable-generated Message ID
campaignIdnumber(optional)Campaign ID
createdAtstring(optional)Time the In-app message was created
expiresAtstring(optional)Time the in-app message will expire
contentInAppContentApi(optional)The content for the in-app message
customPayloadobject(optional)The custom payload for the in-app message
ottPayloadRokuContent(optional)The custom Roku payload for the in-app message
triggerInAppTrigger(optional)The trigger type for the in-app message
saveToInboxboolean(optional)Whether or not the message associated with the event
was configured to use the inbox
inboxMetadataInboxMetadata(optional)An object containing inbox metadata
associated with this in-app message
priorityLevelnumber(optional)The priority value of the in-app message
readboolean(optional)Whether or not the message was read by user
jsonOnlyboolean
typeOfContentInAppTypeOfContent
messageTypeInAppType
{} InAppContentApi
htmlstring(optional)The html to be displayed
ottPayloadRokuContent(optional)
inAppDisplaySettingsInAppDisplaySettings(optional)The in-app message display
settings
webInAppDisplaySettingsWebInAppDisplaySettings
{} RokuContent
backgroundColorstring(optional)
dialogTextstring(optional)
dialogHeaderstring(optional)
fhd_imagestring(optional)
dialogBodyFontstring(optional)
dialogButtonFontstring(optional)
dialogHeaderFontstring(optional)
buttonsarray[RokuButtonContent](optional)
textColorstring(optional)
{} InAppTrigger
typeValue(optional)How the in-app message was triggered
{} InboxMetadata
titlestring(optional)The title to display in the inbox
subtitlestring(optional)The subtitle to display in the inbox
iconstring(optional)The icon to display in the inbox
{} InAppTypeOfContent
{} InAppType
{} InAppDisplaySettings
topInAppDisplaySetting(optional)Padding percentage for the top of the
notification, or -1 to autoexpand
rightInAppDisplaySetting(optional)Padding percentage for the right of the
notification, or -1 to autoexpand
bottomInAppDisplaySetting(optional)Padding percentage for the bottom of the
notification, or -1 to autoexpand
leftInAppDisplaySetting(optional)Padding percentage for the left of the
notification, or -1 to autoexpand
bgColorBgColor(optional)The background color values
shouldAnimateboolean(optional)Enables In App Animations
{} WebInAppDisplaySettings
positionPositionOption(optional)The position of the message on the screen
{} RokuButtonContent
buttonTextColorFocusedstring
buttonColorFocusedstring
buttonTextColorUnFocusedstring
buttonDeeplinkstring
buttonColorUnFocusedstring
buttonTextstring
buttonBorderColorstring
{} Value
{} InAppDisplaySetting
{} BgColor
alphanumber(optional)The opacity range of the background between 0-1
hexstring(optional)The hex color of the background. Format: #FFFFFF
{} PositionOption
GET A USER'S IN-APP MESSAGES GET
Request URL
Response Body
Response Code
Response Headers
GET A USER'S WEB IN-APP MESSAGES
GET /API/INAPP/WEB/GETMESSAGES
Show Samples
Get a user's web in-app messages. This endpoint always returns the user's
non-selective (not app-specific) web in-app messages; to also fetch web
app-specific in-app messages, include a packageName in the request. This
endpoint returns new messages and messages that have already been saved to a
mobile inbox, and each message has a read field to indicate whether or not it
has already been seen.
Learn about identifying users by userId and email.
PARAMETERS
email:
(query)
string
The email address of the user for which to fetch in-app messages. Specify either
an email or a userId.
userId:
(query)
string
The userId of the user for which to fetch in-app messages. Specify either an
email or a userId.
count:
(query)
integer
The number of web in-app messages to fetch.
SDKVersion:
(query)
string
Iterable SDK version (e.g., 6.2.17)
packageName:
(query)
string
The package name of the app for which to retrieve selective web in-app messages.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"inAppMessages": [
{
"messageId": "string",
"campaignId": 0,
"createdAt": "2024-05-30T17:43:09.467Z",
"expiresAt": "2024-05-30T17:43:09.467Z",
"content": {
"html": "string",
"ottPayload": {
"backgroundColor": "string",
"dialogText": "string",
"dialogHeader": "string",
"fhd_image": "string",
"dialogBodyFont": "string",
"dialogButtonFont": "string",
"dialogHeaderFont": "string",
"buttons": [
{
"buttonTextColorFocused": "string",
"buttonColorFocused": "string",
"buttonTextColorUnFocused": "string",
"buttonDeeplink": "string",
"buttonColorUnFocused": "string",
"buttonText": "string",
"buttonBorderColor": "string"
}
],
"textColor": "string"
},
"inAppDisplaySettings": {
"top": {},
"right": {},
"bottom": {},
"left": {},
"bgColor": {
"alpha": 0,
"hex": "string"
},
"shouldAnimate": true
},
"webInAppDisplaySettings": {
"position": {}
}
},
"customPayload": {},
"ottPayload": {
"backgroundColor": "string",
"dialogText": "string",
"dialogHeader": "string",
"fhd_image": "string",
"dialogBodyFont": "string",
"dialogButtonFont": "string",
"dialogHeaderFont": "string",
"buttons": [
{
"buttonTextColorFocused": "string",
"buttonColorFocused": "string",
"buttonTextColorUnFocused": "string",
"buttonDeeplink": "string",
"buttonColorUnFocused": "string",
"buttonText": "string",
"buttonBorderColor": "string"
}
],
"textColor": "string"
},
"trigger": {
"type": {}
},
"saveToInbox": true,
"inboxMetadata": {
"title": "string",
"subtitle": "string",
"icon": "string"
},
"priorityLevel": 0,
"read": true,
"jsonOnly": true,
"typeOfContent": {},
"messageType": {}
}
]
}
Response Schema
{} ApiInAppMessagesResponse
inAppMessagesarray[ApiInAppMessage]
{} ApiInAppMessage
messageIdstring(optional)Iterable-generated Message ID
campaignIdnumber(optional)Campaign ID
createdAtstring(optional)Time the In-app message was created
expiresAtstring(optional)Time the in-app message will expire
contentInAppContentApi(optional)The content for the in-app message
customPayloadobject(optional)The custom payload for the in-app message
ottPayloadRokuContent(optional)The custom Roku payload for the in-app message
triggerInAppTrigger(optional)The trigger type for the in-app message
saveToInboxboolean(optional)Whether or not the message associated with the event
was configured to use the inbox
inboxMetadataInboxMetadata(optional)An object containing inbox metadata
associated with this in-app message
priorityLevelnumber(optional)The priority value of the in-app message
readboolean(optional)Whether or not the message was read by user
jsonOnlyboolean
typeOfContentInAppTypeOfContent
messageTypeInAppType
{} InAppContentApi
htmlstring(optional)The html to be displayed
ottPayloadRokuContent(optional)
inAppDisplaySettingsInAppDisplaySettings(optional)The in-app message display
settings
webInAppDisplaySettingsWebInAppDisplaySettings
{} RokuContent
backgroundColorstring(optional)
dialogTextstring(optional)
dialogHeaderstring(optional)
fhd_imagestring(optional)
dialogBodyFontstring(optional)
dialogButtonFontstring(optional)
dialogHeaderFontstring(optional)
buttonsarray[RokuButtonContent](optional)
textColorstring(optional)
{} InAppTrigger
typeValue(optional)How the in-app message was triggered
{} InboxMetadata
titlestring(optional)The title to display in the inbox
subtitlestring(optional)The subtitle to display in the inbox
iconstring(optional)The icon to display in the inbox
{} InAppTypeOfContent
{} InAppType
{} InAppDisplaySettings
topInAppDisplaySetting(optional)Padding percentage for the top of the
notification, or -1 to autoexpand
rightInAppDisplaySetting(optional)Padding percentage for the right of the
notification, or -1 to autoexpand
bottomInAppDisplaySetting(optional)Padding percentage for the bottom of the
notification, or -1 to autoexpand
leftInAppDisplaySetting(optional)Padding percentage for the left of the
notification, or -1 to autoexpand
bgColorBgColor(optional)The background color values
shouldAnimateboolean(optional)Enables In App Animations
{} WebInAppDisplaySettings
positionPositionOption(optional)The position of the message on the screen
{} RokuButtonContent
buttonTextColorFocusedstring
buttonColorFocusedstring
buttonTextColorUnFocusedstring
buttonDeeplinkstring
buttonColorUnFocusedstring
buttonTextstring
buttonBorderColorstring
{} Value
{} InAppDisplaySetting
{} BgColor
alphanumber(optional)The opacity range of the background between 0-1
hexstring(optional)The hex color of the background. Format: #FFFFFF
{} PositionOption
GET A USER'S WEB IN-APP MESSAGES GET
Request URL
Response Body
Response Code
Response Headers
DELETE A LIST
DELETE /API/LISTS/{LISTID}
Show Samples
Delete a list by listId.
PARAMETERS
listId:
(path)
integer
list id
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
DELETE A LIST DELETE
Request URL
Response Body
Response Code
Response Headers
GET LISTS
GET /API/LISTS
Show Samples
Get all lists within a project. Rate limit: 100 requests/second, per project.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"lists": [
{
"id": 0,
"name": "string",
"description": "string",
"createdAt": 0,
"listType": "Standard"
}
]
}
Response Schema
{} GetListsResponse
listsarray[ListDetails]
{} ListDetails
idinteger
namestring
descriptionstring(optional)
createdAtintegerCreation timestamp as epoch time in milliseconds
listTypestring
Can be Standard, Dynamic, Suppression or Internal
GET LISTS GET
Request URL
Response Body
Response Code
Response Headers
CREATE A STATIC LIST
POST /API/LISTS
Show Samples
Create a new static list.
PARAMETERS
body:
(body)
Content type:
application/json
CreateListRequest
name and optional description
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"name": "string",
"description": "string"
}
Body Schema
{} CreateListRequest
namestring
descriptionstring(optional)
Response Sample
{
"listId": 0
}
Response Schema
{} CreateListResponse
listIdinteger
CREATE A STATIC LIST POST
Request URL
Response Body
Response Code
Response Headers
GET USERS IN A LIST
GET /API/LISTS/GETUSERS
Show Samples
Get all users within a list. Rate limit: 5 requests/minute, per project.
PARAMETERS
listId:
(query)
integer
list id
preferUserId:
(query)
true false (default)
boolean
If true, will return the <code>userId</code> instead of <code>email</code> if
both exists in a user profile for a <a
href="https://support.iterable.com/hc/articles/204780579#identifying-users">hybrid
project</a>.
Response Type:
text/plain
RESPONSES
400
Invalid parameters
401
Invalid API key
503
Request timeout. Try again later.
GET USERS IN A LIST GET
Request URL
Response Body
Response Code
Response Headers
GET COUNT OF USERS IN LIST
GET /API/LISTS/{LISTID}/SIZE
Show Samples
Get the number of users within a list. Rate limit: 5 requests/minute, per
project.
PARAMETERS
listId:
(path)
integer
list id
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
503
Request timeout. Try again later.
GET COUNT OF USERS IN LIST GET
Request URL
Response Body
Response Code
Response Headers
ADD SUBSCRIBERS TO LIST
POST /API/LISTS/SUBSCRIBE
Show Samples
Add specific subscribers to a list.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
SubscribeRequest
email list id and list of emails
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"listId": 0,
"subscribers": [
{
"email": "string",
"dataFields": {},
"userId": "string",
"preferUserId": true,
"mergeNestedObjects": true
}
],
"updateExistingUsersOnly": true
}
Body Schema
{} SubscribeRequest
listIdinteger
subscribersarray[OptionalApiUser]
updateExistingUsersOnlyboolean(optional)Whether to skip operation when the
request includes a userId or email that doesn't yet exist in the Iterable
project. When true, Iterable ignores requests with unknown userIds and email
addresses. When false, Iterable creates new users. Defaults to false. Only
respected in API calls for userID-based and hybrid projects.
{} OptionalApiUser
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
dataFieldsobject(optional)
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
preferUserIdboolean(optional)Whether or not a new user should be created if the
request includes a userId that doesn't yet exist in the Iterable project.
Defaults to false. Only respected in API calls for email-based projects.
mergeNestedObjectsboolean(optional)Merge top-level objects instead of
overwriting them. Defaults to false. For example, if a user profile has data
{"mySettings":{"mobile":true}} and the request has data
{"mySettings":{"email":true}}, merging results in
{"mySettings":{"mobile":true,"email":true}}.
Response Sample
{
"successCount": 0,
"failCount": 0,
"invalidEmails": [
"string"
],
"invalidUserIds": [
"string"
],
"filteredOutFields": [
"string"
],
"createdFields": [
"string"
]
}
Response Schema
{} UserBulkUpdateListResponse
successCountinteger
failCountinteger
invalidEmailsarray[string](optional)
invalidUserIdsarray[string](optional)
filteredOutFieldsarray[string](optional)
createdFieldsarray[string](optional)
ADD SUBSCRIBERS TO LIST POST
Request URL
Response Body
Response Code
Response Headers
REMOVE USERS FROM A LIST
POST /API/LISTS/UNSUBSCRIBE
Show Samples
Remove specific users from a list.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
UnsubscribeRequest
email list id and list of emails
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"listId": 0,
"subscribers": [
{
"email": "string",
"userId": "string"
}
],
"campaignId": 0,
"channelUnsubscribe": true
}
Body Schema
{} UnsubscribeRequest
listIdinteger
subscribersarray[Unsubscriber]
campaignIdinteger(optional)attribute unsubscribe to a campaign
channelUnsubscribeboolean(optional)Unsubscribe email from list's associated
channel - essentially a global unsubscribe. (default: false)
{} Unsubscriber
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
Response Sample
{
"successCount": 0,
"failCount": 0,
"invalidEmails": [
"string"
],
"invalidUserIds": [
"string"
],
"filteredOutFields": [
"string"
],
"createdFields": [
"string"
]
}
Response Schema
{} UserBulkUpdateListResponse
successCountinteger
failCountinteger
invalidEmailsarray[string](optional)
invalidUserIdsarray[string](optional)
filteredOutFieldsarray[string](optional)
createdFieldsarray[string](optional)
REMOVE USERS FROM A LIST POST
Request URL
Response Body
Response Code
Response Headers
LIST MESSAGE TYPES
GET /API/MESSAGETYPES
Show Samples
List all message types within a project. Rate limit: 100 requests/second, per
project.
Response Type:
application/json
RESPONSES
401
Invalid API key
Response Sample
{
"messageTypes": [
{
"id": 0,
"createdAt": 0,
"updatedAt": 0,
"name": "string",
"channelId": 0,
"subscriptionPolicy": "OptIn",
"rateLimitPerMinute": 0,
"frequencyCap": {
"days": 0,
"messages": 0
}
}
]
}
Response Schema
{} MessageTypesResponse
messageTypesarray[MessageTypeDetails]
{} MessageTypeDetails
idinteger
createdAtintegerCreation timestamp as epoch time in milliseconds
updatedAtintegerLast update timestamp as epoch time in milliseconds
namestring
channelIdintegerChannel that this message type belongs to
subscriptionPolicystringSubscription policy for this message type
Can be OptIn or OptOut
rateLimitPerMinuteinteger(optional)Maximum number of message sends allowed on
this message type, per minute
frequencyCapFrequencyCap(optional)The frequency cap configured for this message
type, expressed as a period and max number of messages allowed in that period
{} FrequencyCap
daysinteger
messagesinteger
LIST MESSAGE TYPES GET
Request URL
Response Body
Response Code
Response Headers
DELETE A SINGLE METADATA KEY/VALUE
DELETE /API/METADATA/{TABLE}/{KEY}
Show Samples
Asynchronous. Deletes the specified item from the table. 200 response indicates
a valid request that will be processed; data may not be deleted immediately. Use
GET /api/metadata/{table}/{key} to verify completion.
PARAMETERS
table:
(path)
string
Table name [Alphanumeric, case insensitive]
key:
(path)
string
Metadata key [Alphanumeric, case sensitive]
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
DELETE A SINGLE METADATA KEY/VALUE DELETE
Request URL
Response Body
Response Code
Response Headers
GET THE METADATA VALUE OF A SINGLE KEY
GET /API/METADATA/{TABLE}/{KEY}
Show Samples
PARAMETERS
table:
(path)
string
Table name [Alphanumeric, case insensitive]
key:
(path)
string
Metadata key [Alphanumeric, case sensitive]
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
404
No metadata at specified location
Response Sample
{
"table": "string",
"key": "string",
"size": 0,
"lastModified": 0,
"value": {}
}
Response Schema
{} MetadataWithProperties
tablestring
keystring
sizeinteger
lastModifiedinteger
valueobject
GET THE METADATA VALUE OF A SINGLE KEY GET
Request URL
Response Body
Response Code
Response Headers
CREATE OR REPLACE METADATA
PUT /API/METADATA/{TABLE}/{KEY}
Show Samples
Asynchronous. Creates or replaces the item associated with the specified key.
200 response indicates a valid request that will be processed; updates may not
be made immediately. Use GET /api/metadata/{table}/{key} to verify completion.
PARAMETERS
table:
(path)
string
Table name [Alphanumeric, case insensitive]
key:
(path)
string
Metadata key [Alphanumeric, case sensitive]
body:
(body)
Content type:
application/json
PutMetadataRequest
Metadata properties
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"value": {}
}
Body Schema
{} PutMetadataRequest
valueobjectThe JSON metadata value. Max size is is 30kb.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CREATE OR REPLACE METADATA PUT
Request URL
Response Body
Response Code
Response Headers
DELETE A TABLE
DELETE /API/METADATA/{TABLE}
Show Samples
Asynchronous. Deletes the table. 200 response indicates a valid request that
will be processed; table may not be deleted immediately. Use GET
/api/metadata/{table} to verify completion.
PARAMETERS
table:
(path)
string
Table name [Alphanumeric, case insensitive]
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
DELETE A TABLE DELETE
Request URL
Response Body
Response Code
Response Headers
LIST KEYS IN A TABLE
GET /API/METADATA/{TABLE}
Show Samples
PARAMETERS
table:
(path)
string
Table name [Alphanumeric, case insensitive]
nextMarker:
(query)
string
next result set id; returned by previous search if more hits exist
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"results": [
{
"table": "string",
"key": "string",
"size": 0,
"lastModified": 0
}
],
"nextMarker": "string"
}
Response Schema
{} Listing
resultsarray[MetadataProperties]
nextMarkerstring(optional)
{} MetadataProperties
tablestring
keystring
sizeinteger
lastModifiedinteger
LIST KEYS IN A TABLE GET
Request URL
Response Body
Response Code
Response Headers
LIST AVAILABLE TABLES
GET /API/METADATA
Show Samples
Response Type:
application/json
RESPONSES
401
Invalid API key
Response Sample
{
"results": [
{
"name": "string"
}
]
}
Response Schema
{} ListMetadataTablesResponse
resultsarray[Table]
{} Table
namestring
LIST AVAILABLE TABLES GET
Request URL
Response Body
Response Code
Response Headers
SEND PUSH NOTIFICATION TO USER
POST /API/PUSH/TARGET
Show Samples
Send a push notification to a specific user. Request data fields will override
user profile data fields. A reference to the user profile is provided via the
profile field, to help resolve field collisions.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
TargetPushRequest
Recipient and email id
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"campaignId": 0,
"recipientEmail": "string",
"recipientUserId": "string",
"dataFields": {},
"sendAt": "string",
"allowRepeatMarketingSends": true,
"metadata": {}
}
Body Schema
{} TargetPushRequest
campaignIdintegerCampaign ID
recipientEmailstring(optional)An email address that identifies a user profile in
Iterable. Provide a recipientEmail or a recipientUserId (but not both),
depending on how your project identifies users.
recipientUserIdstring(optional)A user ID that identifies a user profile in
Iterable. Provide a recipientEmail or a recipientUserId (but not both),
depending on how your project identifies users.
dataFieldsobject(optional)JSON object containing fields to merge into template
sendAtstring(optional)Schedule the message for up to 365 days in the future. If
set in the past, message is sent immediately. Format is YYYY-MM-DD HH:MM:SS in
UTC
allowRepeatMarketingSendsboolean(optional)Allow repeat marketing sends? Defaults
to true.
metadataobject(optional)Metadata to pass back via system webhooks. Not used for
rendering
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
SEND PUSH NOTIFICATION TO USER POST
Request URL
Response Body
Response Code
Response Headers
CANCEL A PUSH NOTIFICATION TO A USER
POST /API/PUSH/CANCEL
Show Samples
Cancels a push notification to a specific user. Request must include a
campaignId and an email or userId, or just a scheduledMessageId.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
CancelScheduledMessageRequest - campaignId OR scheduledMessageId are required
Email and Campaign ID
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"campaignId": 0,
"scheduledMessageId": 0,
"userId": "string"
}
Body Schema
{} CancelScheduledMessageRequest - campaignId OR scheduledMessageId are required
emailstring(optional)An email address that identifies a user profile in
Iterable. If you provide a campaignId, you must also provide an email or a
userId, depending on how your project identifies users.
campaignIdnumber(optional)The ID of the campaign associated with the scheduled
message you'd like to cancel. If you provide a campaignId, you must also provide
an email or userId, depending on how your project identifies users.
scheduledMessageIdnumber(optional)
userIdstring(optional)A user ID that identifies a user profile in Iterable. If
you provide a campaignId, you must also provide an email or a userId, depending
on how your project identifies users.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CANCEL A PUSH NOTIFICATION TO A USER POST
Request URL
Response Body
Response Code
Response Headers
SEND SMS NOTIFICATION TO USER
POST /API/SMS/TARGET
Show Samples
Send an SMS notification to a specific user. Note that this API is typically
used for transactional messaging. Request data fields will override user profile
data fields. A reference to the user profile is provided via the profile field,
to help resolve field collisions.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
TargetSMSRequest
Recipient and email ID
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"campaignId": 0,
"recipientEmail": "string",
"recipientUserId": "string",
"dataFields": {},
"sendAt": "string",
"allowRepeatMarketingSends": true
}
Body Schema
{} TargetSMSRequest
campaignIdintegerCampaign ID
recipientEmailstring(optional)An email address that identifies a user profile in
Iterable. Provide a recipientEmail or a recipientUserId (but not both),
depending on how your project identifies users.
recipientUserIdstring(optional)A user ID that identifies a user profile in
Iterable. Provide a recipientEmail or a recipientUserId (but not both),
depending on how your project identifies users.
dataFieldsobject(optional)Fields to merge into template
sendAtstring(optional)Schedule the message for up to 365 days in the future. If
set in the past, message is sent immediately. Format is YYYY-MM-DD HH:MM:SS in
UTC
allowRepeatMarketingSendsboolean(optional)Allow repeat marketing sends? Defaults
to true.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
SEND SMS NOTIFICATION TO USER POST
Request URL
Response Body
Response Code
Response Headers
CANCEL AN SMS TO A USER
POST /API/SMS/CANCEL
Show Samples
Cancels an SMS to a specific user. Request must include a campaignId and an
email or userId, or just a scheduledMessageId.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
CancelScheduledMessageRequest - campaignId OR scheduledMessageId are required
Email and Campaign ID
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"campaignId": 0,
"scheduledMessageId": 0,
"userId": "string"
}
Body Schema
{} CancelScheduledMessageRequest - campaignId OR scheduledMessageId are required
emailstring(optional)An email address that identifies a user profile in
Iterable. If you provide a campaignId, you must also provide an email or a
userId, depending on how your project identifies users.
campaignIdnumber(optional)The ID of the campaign associated with the scheduled
message you'd like to cancel. If you provide a campaignId, you must also provide
an email or userId, depending on how your project identifies users.
scheduledMessageIdnumber(optional)
userIdstring(optional)A user ID that identifies a user profile in Iterable. If
you provide a campaignId, you must also provide an email or a userId, depending
on how your project identifies users.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CANCEL AN SMS TO A USER POST
Request URL
Response Body
Response Code
Response Headers
UNSUBSCRIBE A SINGLE USER
DELETE
/API/SUBSCRIPTIONS/{SUBSCRIPTIONGROUP}/{SUBSCRIPTIONGROUPID}/USER/{USEREMAIL}
Show Samples
Unsubscribes a user from the specified subscription group. To enable this API,
contact your customer success manager.
Learn about identifying users by userId and email.
PARAMETERS
subscriptionGroup:
(path)
string
Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric,
case insensitive]
subscriptionGroupId:
(path)
integer
Subscription Group Id [Numeric]
userEmail:
(path)
string
User's Email [Alphanumeric]
Response Type:
application/json
RESPONSES
202
Accepted a request to unsubscribe
400
Invalid parameters
401
Invalid API key
404
Endpoint not found
409
Email/userId conflict
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UNSUBSCRIBE A SINGLE USER DELETE
Request URL
Response Body
Response Code
Response Headers
SUBSCRIBE A SINGLE USER
PATCH
/API/SUBSCRIPTIONS/{SUBSCRIPTIONGROUP}/{SUBSCRIPTIONGROUPID}/USER/{USEREMAIL}
Show Samples
Subscribes a user to the specified subscription group. To enable this API,
contact your customer success manager.
Learn about identifying users by userId and email.
PARAMETERS
subscriptionGroup:
(path)
string
Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric,
case insensitive]
subscriptionGroupId:
(path)
integer
Subscription Group Id [Numeric]
userEmail:
(path)
string
User's Email [Alphanumeric]
Response Type:
application/json
RESPONSES
202
Accepted a request to subscribe
400
Invalid parameters
401
Invalid API key
404
Endpoint not found
409
Email/userId conflict
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
SUBSCRIBE A SINGLE USER PATCH
Request URL
Response Body
Response Code
Response Headers
UNSUBSCRIBE A SINGLE USER BY USERID
DELETE
/API/SUBSCRIPTIONS/{SUBSCRIPTIONGROUP}/{SUBSCRIPTIONGROUPID}/BYUSERID/{USERID}
Show Samples
Unsubscribes a user from the specified subscription group. To enable this API,
contact your customer success manager.
Learn about identifying users by userId and email.
PARAMETERS
subscriptionGroup:
(path)
string
Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric,
case insensitive]
subscriptionGroupId:
(path)
integer
Subscription Group Id [Numeric]
userId:
(path)
string
User's userId
Response Type:
application/json
RESPONSES
202
Accepted a request to unsubscribe
400
Invalid parameters
401
Invalid API key
404
Endpoint not found
409
Email/userId conflict
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UNSUBSCRIBE A SINGLE USER BY USERID DELETE
Request URL
Response Body
Response Code
Response Headers
SUBSCRIBE A SINGLE USER BY THEIR USERID
PATCH
/API/SUBSCRIPTIONS/{SUBSCRIPTIONGROUP}/{SUBSCRIPTIONGROUPID}/BYUSERID/{USERID}
Show Samples
Subscribes a user to the specified subscription group. To enable this API,
contact your customer success manager.
Learn about identifying users by userId and email.
PARAMETERS
subscriptionGroup:
(path)
string
Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric,
case insensitive]
subscriptionGroupId:
(path)
integer
Subscription Group Id [Numeric]
userId:
(path)
string
User's userId
Response Type:
application/json
RESPONSES
202
Accepted a request to subscribe
400
Invalid parameters
401
Invalid API key
404
Endpoint not found
409
Email/userId conflict
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
SUBSCRIBE A SINGLE USER BY THEIR USERID PATCH
Request URL
Response Body
Response Code
Response Headers
BULK SUBSCRIPTION ACTION ON A LIST OF USERS
PUT /API/SUBSCRIPTIONS/{SUBSCRIPTIONGROUP}/{SUBSCRIPTIONGROUPID}
Show Samples
Subscribes or unsubscribes multiple users to the specified subscription group.
In users, list email addresses. In usersByUserId, list userId values. A single
request can include both users and usersByUserId. To enable this API, contact
your customer success manager.
Learn about identifying users by userId and email.
PARAMETERS
subscriptionGroup:
(path)
string
Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric,
case insensitive]
subscriptionGroupId:
(path)
integer
Subscription Group Id [Numeric]
action:
(query)
string
subscribe or unsubscribe
body:
(body)
Content type:
application/json
BulkSubscriptionActionRequest
user email
Response Type:
application/json
RESPONSES
202
Accepted a request for bulk subscription actions
400
Invalid parameters
401
Invalid API key
404
Endpoint not found
409
Email/userId conflict
Body Sample
{
"users": [
"string"
],
"usersByUserId": [
"string"
]
}
Body Schema
{} BulkSubscriptionActionRequest
usersarray[string](optional)Users to subscribe/unsubscribe, identified by email.
usersByUserIdarray[string](optional)Users to subscribe/unsubscribe, identified
by userId.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
BULK SUBSCRIPTION ACTION ON A LIST OF USERS PUT
Request URL
Response Body
Response Code
Response Headers
TRIGGER A DOUBLE OPT-IN SUBSCRIPTION FLOW
POST /API/SUBSCRIPTIONS/SUBSCRIBETODOUBLEOPTIN
Show Samples
This endpoint triggers a double opt-in subscription for a user.
Once the user responds to the subscription confirmation message, they will be
subscribed to the message types specified in the request body.
This endpoint can only be used with SMS, double opt-in message types. To enable
it, contact your customer success manager.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
DoubleOptInSubscriptionsRequest
Create a double opt-in subscription request
Response Type:
application/json
RESPONSES
202
Accepted a request to subscribe
400
Invalid parameters
401
Invalid API key
404
Endpoint not found
500
Internal server error
Body Sample
{
"messageTypeIds": [
{}
],
"userId": "string",
"email": "string",
"phoneNumber": "string",
"brandName": "string"
}
Body Schema
{} DoubleOptInSubscriptionsRequest
messageTypeIdsarray[Inline Model 1]List of SMS, double opt-in message type IDs
to which the user should be subscribed.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
phoneNumberstring(optional)The phoneNumber to set on the specified user's
profile.
brandNamestring(optional)To provide context, every double opt-in confirmation
message includes a brand name. The value to use for this brand name is
determined by (in priority order): the brandName included in the request body
(if specified), the default brand name associated with the specified message
types (if those message types all have the same default brand name), or a
comma-separated, de-duplicated list of default brand names associated with the
specified message types (if those message types have different default brand
names).
{} Inline Model 1
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRIGGER A DOUBLE OPT-IN SUBSCRIPTION FLOW POST
Request URL
Response Body
Response Code
Response Headers
GET PROJECT TEMPLATES
GET /API/TEMPLATES
Show Samples
Get templates for a project. Rate limit: 100 requests/second, per project.
PARAMETERS
templateType:
(query)
Base Blast Triggered Workflow
string
Only retrieve templates associated with this template type
messageMedium:
(query)
Email Push InApp SMS
string
Only retrieve templates associated with this message medium
startDateTime:
(query)
string
Get templates created at or after this date time (yyyy-MM-dd HH:mm:ss [ZZ])
endDateTime:
(query)
string
Get templates created before this date time (yyyy-MM-dd HH:mm:ss [ZZ])
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"templates": [
{
"templateId": 0,
"createdAt": "2024-05-30T17:43:09.490Z",
"updatedAt": "2024-05-30T17:43:09.490Z",
"name": "string",
"creatorUserId": "string",
"messageTypeId": 0,
"campaignId": 0,
"clientTemplateId": "string"
}
]
}
Response Schema
{} GetTemplatesResponse
templatesarray[ApiTemplateResponse]
{} ApiTemplateResponse
templateIdintegerTemplate ID
createdAtstringDate created
updatedAtstringDate last updated
namestringName of the template
creatorUserIdstringCreator email
messageTypeIdintegerMessage type ID
campaignIdinteger(optional)Campaign ID
clientTemplateIdstring(optional)Client template ID. Used as a secondary key to
reference the template
GET PROJECT TEMPLATES GET
Request URL
Response Body
Response Code
Response Headers
GET AN EMAIL TEMPLATE BY CLIENTTEMPLATEID
GET /API/TEMPLATES/GETBYCLIENTTEMPLATEID
Show Samples
Rate limit: 100 requests/second, per project.
PARAMETERS
clientTemplateId:
(query)
string
Client Template Id
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"templates": [
{
"templateId": 0,
"campaignId": 0,
"locales": [
{
"displayLanguage": "string",
"languageTag": "string"
}
]
}
]
}
Response Schema
{} ClientTemplateIdResponse
templatesarray[ApiTemplateEntry]Templates that match client template id
{} ApiTemplateEntry
templateIdintegerTemplate ID
campaignIdinteger(optional)ID of campaign using this template
localesarray[string](optional)Locales with content for this template
{} string
displayLanguagestring
languageTagstring
GET AN EMAIL TEMPLATE BY CLIENTTEMPLATEID GET
Request URL
Response Body
Response Code
Response Headers
GET AN EMAIL TEMPLATE BY TEMPLATEID
GET /API/TEMPLATES/EMAIL/GET
Show Samples
Rate limit: 100 requests/second, per project.
PARAMETERS
templateId:
(query)
integer
Template ID
locale:
(query)
string
Locale of content to get
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
404
Content does not exist for specified locale
Response Sample
{
"templateId": 0,
"metadata": {
"templateId": 0,
"createdAt": "2024-05-30T17:43:09.492Z",
"updatedAt": "2024-05-30T17:43:09.492Z",
"name": "string",
"creatorUserId": "string",
"messageTypeId": 0,
"campaignId": 0,
"clientTemplateId": "string"
},
"name": "string",
"fromName": "string",
"fromEmail": "string",
"replyToEmail": "string",
"subject": "string",
"preheaderText": "string",
"ccEmails": [
"string"
],
"bccEmails": [
"string"
],
"html": "string",
"plainText": "string",
"googleAnalyticsCampaignName": "string",
"linkParams": [
{
"key": "string",
"value": "string"
}
],
"dataFeedId": 0,
"dataFeedIds": [
0
],
"cacheDataFeed": {},
"mergeDataFeedContext": {},
"clientTemplateId": "string",
"locale": "string",
"messageTypeId": 0,
"creatorUserId": "string",
"isDefaultLocale": true
}
Response Schema
{} ApiEmailTemplateModel
templateIdintegerEmail Template ID
metadataApiTemplateResponse(optional)Metadata
namestring(optional)Name of the template
fromNamestring(optional)From name
fromEmailstring(optional)From email (must be an authorized sender)
replyToEmailstring(optional)Reply to email
subjectstring(optional)Subject
preheaderTextstring(optional)Preheader text
ccEmailsarray[string](optional)CC emails
bccEmailsarray[string](optional)BCC emails
htmlstring(optional)HTML contents
plainTextstring(optional)Plain text contents
googleAnalyticsCampaignNamestring(optional)Google analytics utm_campaign value
linkParamsarray[LinkParam](optional)Parameters to append to each URL in html
contents
dataFeedIdnumber(optional)[Deprecated - use dataFeedIds instead] Id for data
feed used in template rendering
dataFeedIdsarray[number](optional)Ids for data feeds used in template rendering
cacheDataFeedobject(optional)Cache data feed lookups for 1 hour
mergeDataFeedContextobject(optional)Merge data feed contents into user context,
so fields be referenced by {{field}} instead of [[field]]
clientTemplateIdstring(optional)Client template Id. Used as a secondary key to
reference the template
localestring(optional)The locale for the content in this request. Leave empty
for default locale. Iterable will automatically send the content with locale
that matches a 'locale' field in the user profile.
messageTypeIdnumber(optional)Message Type Id
creatorUserIdstring(optional)Creator User Id
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Identifies if the locale associated with the response is the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
{} ApiTemplateResponse
templateIdintegerTemplate ID
createdAtstringDate created
updatedAtstringDate last updated
namestringName of the template
creatorUserIdstringCreator email
messageTypeIdintegerMessage type ID
campaignIdinteger(optional)Campaign ID
clientTemplateIdstring(optional)Client template ID. Used as a secondary key to
reference the template
{} LinkParam
keystringLink parameter key
valuestringLink parameter value
GET AN EMAIL TEMPLATE BY TEMPLATEID GET
Request URL
Response Body
Response Code
Response Headers
CREATE EMAIL TEMPLATE
POST /API/TEMPLATES/EMAIL/UPSERT
Show Samples
Create email template if it doesn't exist already, otherwise update all email
templates which match the name provided.
PARAMETERS
body:
(body)
Content type:
application/json
UpsertEmailTemplateModel
Only the fields specified will be updated
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"clientTemplateId": "string",
"name": "string",
"fromName": "string",
"fromEmail": "string",
"replyToEmail": "string",
"subject": "string",
"preheaderText": "string",
"ccEmails": [
"string"
],
"bccEmails": [
"string"
],
"html": "string",
"plainText": "string",
"googleAnalyticsCampaignName": "string",
"linkParams": [
{
"key": "string",
"value": "string"
}
],
"dataFeedId": 0,
"dataFeedIds": [
0
],
"cacheDataFeed": {},
"mergeDataFeedContext": true,
"locale": "string",
"messageTypeId": 0,
"creatorUserId": "string",
"isDefaultLocale": true,
"messageMedium": {}
}
Body Schema
{} UpsertEmailTemplateModel
clientTemplateIdstringId used by the client to identify a template. If multiple
templates exist with the Id, all will be updated
namestring(optional)Name of the template
fromNamestring(optional)From name
fromEmailstring(optional)From email (must be an authorized sender)
replyToEmailstring(optional)Reply to email
subjectstring(optional)Subject
preheaderTextstring(optional)Preheader text
ccEmailsarray[string](optional)CC emails
bccEmailsarray[string](optional)BCC emails
htmlstring(optional)HTML contents
plainTextstring(optional)Plain text contents
googleAnalyticsCampaignNamestring(optional)Google analytics utm_campaign value
linkParamsarray[LinkParam](optional)Parameters to append to each URL in html
contents
dataFeedIdinteger(optional)[Deprecated - use dataFeedIds instead] Id for data
feed used in template rendering
dataFeedIdsarray[number](optional)Ids for data feeds used in template rendering
cacheDataFeedobject(optional)Cache data feed lookups for 1 hour
mergeDataFeedContextboolean(optional)Merge data feed contents into user context,
so fields be referenced by {{field}} instead of [[field]]
localestring(optional)The locale for the content in this request. Iterable will
automatically pick the content with locale that matches a 'locale' field in the
user profile.
messageTypeIdinteger(optional)Message Type Id
creatorUserIdstring(optional)Specify a specific creator user id (email). The
email must be an existing member of the project. Defaults to the organization
creator.
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Sets the locale associated with the request content as the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
messageMediumMessageMedium
{} LinkParam
keystringLink parameter key
valuestringLink parameter value
{} MessageMedium
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CREATE EMAIL TEMPLATE POST
Request URL
Response Body
Response Code
Response Headers
UPDATE EMAIL TEMPLATE
POST /API/TEMPLATES/EMAIL/UPDATE
Show Samples
PARAMETERS
body:
(body)
Content type:
application/json
ApiEmailTemplateModel
Only the fields specified will be updated
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"templateId": 0,
"metadata": {
"templateId": 0,
"createdAt": "2024-05-30T17:43:09.395Z",
"updatedAt": "2024-05-30T17:43:09.395Z",
"name": "string",
"creatorUserId": "string",
"messageTypeId": 0,
"campaignId": 0,
"clientTemplateId": "string"
},
"name": "string",
"fromName": "string",
"fromEmail": "string",
"replyToEmail": "string",
"subject": "string",
"preheaderText": "string",
"ccEmails": [
"string"
],
"bccEmails": [
"string"
],
"html": "string",
"plainText": "string",
"googleAnalyticsCampaignName": "string",
"linkParams": [
{
"key": "string",
"value": "string"
}
],
"dataFeedId": 0,
"dataFeedIds": [
0
],
"cacheDataFeed": {},
"mergeDataFeedContext": {},
"clientTemplateId": "string",
"locale": "string",
"messageTypeId": 0,
"creatorUserId": "string",
"isDefaultLocale": true
}
Body Schema
{} ApiEmailTemplateModel
templateIdintegerEmail Template ID
metadataApiTemplateResponse(optional)Metadata
namestring(optional)Name of the template
fromNamestring(optional)From name
fromEmailstring(optional)From email (must be an authorized sender)
replyToEmailstring(optional)Reply to email
subjectstring(optional)Subject
preheaderTextstring(optional)Preheader text
ccEmailsarray[string](optional)CC emails
bccEmailsarray[string](optional)BCC emails
htmlstring(optional)HTML contents
plainTextstring(optional)Plain text contents
googleAnalyticsCampaignNamestring(optional)Google analytics utm_campaign value
linkParamsarray[LinkParam](optional)Parameters to append to each URL in html
contents
dataFeedIdnumber(optional)[Deprecated - use dataFeedIds instead] Id for data
feed used in template rendering
dataFeedIdsarray[number](optional)Ids for data feeds used in template rendering
cacheDataFeedobject(optional)Cache data feed lookups for 1 hour
mergeDataFeedContextobject(optional)Merge data feed contents into user context,
so fields be referenced by {{field}} instead of [[field]]
clientTemplateIdstring(optional)Client template Id. Used as a secondary key to
reference the template
localestring(optional)The locale for the content in this request. Leave empty
for default locale. Iterable will automatically send the content with locale
that matches a 'locale' field in the user profile.
messageTypeIdnumber(optional)Message Type Id
creatorUserIdstring(optional)Creator User Id
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Identifies if the locale associated with the response is the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
{} ApiTemplateResponse
templateIdintegerTemplate ID
createdAtstringDate created
updatedAtstringDate last updated
namestringName of the template
creatorUserIdstringCreator email
messageTypeIdintegerMessage type ID
campaignIdinteger(optional)Campaign ID
clientTemplateIdstring(optional)Client template ID. Used as a secondary key to
reference the template
{} LinkParam
keystringLink parameter key
valuestringLink parameter value
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UPDATE EMAIL TEMPLATE POST
Request URL
Response Body
Response Code
Response Headers
GET A PUSH TEMPLATE
GET /API/TEMPLATES/PUSH/GET
Show Samples
Rate limit: 100 requests/second, per project.
PARAMETERS
templateId:
(query)
integer
Template ID
locale:
(query)
string
Locale of content to get
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
404
Content does not exit for specified locale
Response Sample
{
"templateId": 0,
"createdAt": "2024-05-30T17:43:09.494Z",
"updatedAt": "2024-05-30T17:43:09.494Z",
"name": "string",
"title": "string",
"message": "string",
"payload": {},
"badge": "string",
"wake": true,
"relevanceScore": 0,
"interruptionLevel": "passive",
"locale": "string",
"messageTypeId": 0,
"sound": "string",
"buttons": [
{
"identifier": "string",
"title": "string",
"buttonType": "default",
"action": {
"type": "string",
"data": "string"
},
"openApp": true,
"requiresUnlock": true,
"inputPlaceholder": "string",
"inputTitle": "string",
"actionIcon": {
"iconType": {},
"imageName": "string"
}
}
],
"deeplink": {
"ios": "string",
"android": "string"
},
"richMedia": {
"ios": "string",
"android": "string"
},
"dataFeedIds": [
0
],
"cacheDataFeed": true,
"mergeDataFeedContext": true,
"clientTemplateId": "string",
"campaignId": {},
"isSilentPush": true,
"isDefaultLocale": true
}
Response Schema
{} ApiPushTemplateModel
templateIdintegerPush template ID
createdAtstring(optional)Date created [Read only]
updatedAtstring(optional)Date last updated [Read only]
namestring(optional)Name of the template
titlestring(optional)Push message title
messagestring(optional)Push message
payloadobject(optional)Payload to send with push notification
badgestring(optional)Badge to set for push notification
wakeboolean(optional)Set the content-available flag on iOS notifications, which
will wake the app in the background
relevanceScorenumber(optional)Relevance score for iOS notifications on iOS 15+.
Number is clamped between 0 and 1.0
interruptionLevelstring(optional)An interruption level helps iOS determine when
to alert a user about the arrival of a push notification
Can be passive, active, time-sensitive or critical
localestring(optional)The locale for the content in this request. Leave empty
for default locale. Iterable will automatically send the content with locale
that matches a 'locale' field in the user profile.
messageTypeIdinteger(optional)Message Type Id
soundstring(optional)Sound
buttonsarray[PushActionButton](optional)Array of buttons that appear to respond
to the push. Max of 3.
deeplinkDeeplinkURI(optional)Deep Link. A mapping that accepts two optional
properties: 'ios' & 'android' and their respective deep link values.
richMediaRichMediaURL(optional)Rich Media URL. A mapping that accepts two
optional properties: 'ios' & 'android' and their respective rich media url
values.
dataFeedIdsarray[number](optional)Ids for data feeds used in template rendering
cacheDataFeedboolean(optional)Cache data feed lookups for 1 hour
mergeDataFeedContextboolean(optional)Merge data feed contents into user context,
so fields can be referenced by {{field}} instead of [[field]]
clientTemplateIdstring(optional)Client template Id. Used as a secondary key to
reference the template
campaignIdobject(optional)Campaign ID
isSilentPushboolean(optional)Whether or not this is a silent push notification
template
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Identifies if the locale associated with the response is the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
{} PushActionButton
identifierstringUsed to identify the button for event tracking
titlestringTitle that will appear on the button
buttonTypestring(optional)Type of button
Can be default, destructive or textInput
actionPushAction(optional)Action to execute on button push
openAppbooleanOpen the app if the button uses a customAction
requiresUnlockboolean(optional)Whether the button requires the phone to be
unlocked
inputPlaceholderstring(optional)The input placeholder in the text box if this is
a Text Input button
inputTitlestring(optional)The submit button text for the text box if this is a
Text Input button
actionIconActionIcon(optional)
{} DeeplinkURI
iosstring(optional)
androidstring(optional)
{} RichMediaURL
iosstring(optional)
androidstring(optional)
{} PushAction
typestring(optional)The type of action. Leave empty to open the app, use
'openUrl' to open the url specified in the 'data' field, or enter a custom
action handler defined in your app
datastring(optional)The URL to open if the type is 'openUrl'
{} ActionIcon
iconTypeActionIconType
imageNamestring
{} ActionIconType
GET A PUSH TEMPLATE GET
Request URL
Response Body
Response Code
Response Headers
CREATE A PUSH TEMPLATE
POST /API/TEMPLATES/PUSH/UPSERT
Show Samples
Create a push template if it doesn't exist, otherwise update all push templates
which match the name provided.
PARAMETERS
body:
(body)
Content type:
application/json
UpsertPushTemplateModel
Only the fields specified will be updated
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"clientTemplateId": "string",
"name": "string",
"title": "string",
"message": "string",
"payload": {
"underlying": {}
},
"badge": "string",
"wake": true,
"relevanceScore": 0,
"interruptionLevel": "passive",
"locale": "string",
"messageTypeId": 0,
"sound": "string",
"buttons": [
{
"identifier": "string",
"title": "string",
"buttonType": "default",
"action": {
"type": "string",
"data": "string"
},
"openApp": true,
"requiresUnlock": true,
"inputPlaceholder": "string",
"inputTitle": "string",
"actionIcon": {
"iconType": {},
"imageName": "string"
}
}
],
"deeplink": {
"ios": "string",
"android": "string"
},
"richMedia": {
"ios": "string",
"android": "string"
},
"dataFeedIds": [
0
],
"cacheDataFeed": true,
"mergeDataFeedContext": true,
"creatorUserId": "string",
"isSilentPush": true,
"isDefaultLocale": true,
"messageMedium": {}
}
Body Schema
{} UpsertPushTemplateModel
clientTemplateIdstringId used by the client to identify a template. If multiple
templates exist with the Id, all will be updated
namestring(optional)Name of the template
titlestring(optional)Push message title
messagestring(optional)Push message
payloadJsObject(optional)Payload to send with push notification
badgestring(optional)Badge to set for push notification
wakeboolean(optional)Set the content-available flag on iOS notifications, which
will wake the app in the background
relevanceScorenumber(optional)Relevance score for iOS notifications on iOS 15+.
Number is clamped between 0 and 1.0
interruptionLevelstring(optional)An interruption level helps iOS determine when
to alert a user about the arrival of a push notification
Can be passive, active, time-sensitive or critical
localestring(optional)The locale for the content in this request. Leave empty
for default locale.Iterable will automatically send the content with locale that
matches a 'locale' field in the user profile.
messageTypeIdinteger(optional)Message Type Id
soundstring(optional)Sound
buttonsarray[PushActionButton](optional)Array of buttons that appear to respond
to the push. Max of 3.
deeplinkDeeplinkURI(optional)Deep Link. A mapping that accepts two optional
properties: 'ios' & 'android' and their respective deep link values.
richMediaRichMediaURL(optional)Rich Media URL. A mapping that accepts two
optional properties: 'ios' & 'android' and their respective rich media url
values.
dataFeedIdsarray[number](optional)Ids for data feeds used in template rendering
cacheDataFeedboolean(optional)Cache data feed lookups for 1 hour
mergeDataFeedContextboolean(optional)Merge data feed contents into user context,
so fields can be referenced by {{field}} instead of [[field]]
creatorUserIdstring(optional)Specify a specific creator user id (email). The
email must be an existing member of the project. Defaults to the organization
creator.
isSilentPushboolean(optional)Whether or not this is a silent push notification
template
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Sets the locale associated with the request content as the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
messageMediumMessageMedium
{} JsObject
underlyingobject
{} PushActionButton
identifierstringUsed to identify the button for event tracking
titlestringTitle that will appear on the button
buttonTypestring(optional)Type of button
Can be default, destructive or textInput
actionPushAction(optional)Action to execute on button push
openAppbooleanOpen the app if the button uses a customAction
requiresUnlockboolean(optional)Whether the button requires the phone to be
unlocked
inputPlaceholderstring(optional)The input placeholder in the text box if this is
a Text Input button
inputTitlestring(optional)The submit button text for the text box if this is a
Text Input button
actionIconActionIcon(optional)
{} DeeplinkURI
iosstring(optional)
androidstring(optional)
{} RichMediaURL
iosstring(optional)
androidstring(optional)
{} MessageMedium
{} PushAction
typestring(optional)The type of action. Leave empty to open the app, use
'openUrl' to open the url specified in the 'data' field, or enter a custom
action handler defined in your app
datastring(optional)The URL to open if the type is 'openUrl'
{} ActionIcon
iconTypeActionIconType
imageNamestring
{} ActionIconType
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CREATE A PUSH TEMPLATE POST
Request URL
Response Body
Response Code
Response Headers
UPDATE PUSH TEMPLATE
POST /API/TEMPLATES/PUSH/UPDATE
Show Samples
PARAMETERS
body:
(body)
Content type:
application/json
ApiPushTemplateModel
Only the fields specified will be updated
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"templateId": 0,
"createdAt": "2024-05-30T17:43:09.398Z",
"updatedAt": "2024-05-30T17:43:09.398Z",
"name": "string",
"title": "string",
"message": "string",
"payload": {},
"badge": "string",
"wake": true,
"relevanceScore": 0,
"interruptionLevel": "passive",
"locale": "string",
"messageTypeId": 0,
"sound": "string",
"buttons": [
{
"identifier": "string",
"title": "string",
"buttonType": "default",
"action": {
"type": "string",
"data": "string"
},
"openApp": true,
"requiresUnlock": true,
"inputPlaceholder": "string",
"inputTitle": "string",
"actionIcon": {
"iconType": {},
"imageName": "string"
}
}
],
"deeplink": {
"ios": "string",
"android": "string"
},
"richMedia": {
"ios": "string",
"android": "string"
},
"dataFeedIds": [
0
],
"cacheDataFeed": true,
"mergeDataFeedContext": true,
"clientTemplateId": "string",
"campaignId": {},
"isSilentPush": true,
"isDefaultLocale": true
}
Body Schema
{} ApiPushTemplateModel
templateIdintegerPush template ID
createdAtstring(optional)Date created [Read only]
updatedAtstring(optional)Date last updated [Read only]
namestring(optional)Name of the template
titlestring(optional)Push message title
messagestring(optional)Push message
payloadobject(optional)Payload to send with push notification
badgestring(optional)Badge to set for push notification
wakeboolean(optional)Set the content-available flag on iOS notifications, which
will wake the app in the background
relevanceScorenumber(optional)Relevance score for iOS notifications on iOS 15+.
Number is clamped between 0 and 1.0
interruptionLevelstring(optional)An interruption level helps iOS determine when
to alert a user about the arrival of a push notification
Can be passive, active, time-sensitive or critical
localestring(optional)The locale for the content in this request. Leave empty
for default locale. Iterable will automatically send the content with locale
that matches a 'locale' field in the user profile.
messageTypeIdinteger(optional)Message Type Id
soundstring(optional)Sound
buttonsarray[PushActionButton](optional)Array of buttons that appear to respond
to the push. Max of 3.
deeplinkDeeplinkURI(optional)Deep Link. A mapping that accepts two optional
properties: 'ios' & 'android' and their respective deep link values.
richMediaRichMediaURL(optional)Rich Media URL. A mapping that accepts two
optional properties: 'ios' & 'android' and their respective rich media url
values.
dataFeedIdsarray[number](optional)Ids for data feeds used in template rendering
cacheDataFeedboolean(optional)Cache data feed lookups for 1 hour
mergeDataFeedContextboolean(optional)Merge data feed contents into user context,
so fields can be referenced by {{field}} instead of [[field]]
clientTemplateIdstring(optional)Client template Id. Used as a secondary key to
reference the template
campaignIdobject(optional)Campaign ID
isSilentPushboolean(optional)Whether or not this is a silent push notification
template
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Identifies if the locale associated with the response is the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
{} PushActionButton
identifierstringUsed to identify the button for event tracking
titlestringTitle that will appear on the button
buttonTypestring(optional)Type of button
Can be default, destructive or textInput
actionPushAction(optional)Action to execute on button push
openAppbooleanOpen the app if the button uses a customAction
requiresUnlockboolean(optional)Whether the button requires the phone to be
unlocked
inputPlaceholderstring(optional)The input placeholder in the text box if this is
a Text Input button
inputTitlestring(optional)The submit button text for the text box if this is a
Text Input button
actionIconActionIcon(optional)
{} DeeplinkURI
iosstring(optional)
androidstring(optional)
{} RichMediaURL
iosstring(optional)
androidstring(optional)
{} PushAction
typestring(optional)The type of action. Leave empty to open the app, use
'openUrl' to open the url specified in the 'data' field, or enter a custom
action handler defined in your app
datastring(optional)The URL to open if the type is 'openUrl'
{} ActionIcon
iconTypeActionIconType
imageNamestring
{} ActionIconType
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UPDATE PUSH TEMPLATE POST
Request URL
Response Body
Response Code
Response Headers
GET AN SMS TEMPLATE
GET /API/TEMPLATES/SMS/GET
Show Samples
Rate limit: 100 requests/second, per project.
PARAMETERS
templateId:
(query)
integer
Template ID
locale:
(query)
string
Locale of content to get
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
404
Content does not exit for specified locale
Response Sample
{
"templateId": 0,
"createdAt": "2024-05-30T17:43:09.497Z",
"updatedAt": "2024-05-30T17:43:09.497Z",
"name": "string",
"message": "string",
"locale": "string",
"messageTypeId": 0,
"imageUrl": "string",
"clientTemplateId": "string",
"campaignId": {},
"trackingDomain": "string",
"googleAnalyticsCampaignName": "string",
"linkParams": [
{
"key": "string",
"value": "string"
}
],
"isDefaultLocale": true
}
Response Schema
{} ApiSMSTemplateModel
templateIdintegerSMS template ID
createdAtstring(optional)Date created [Read only]
updatedAtstring(optional)Date last updated [Read only]
namestring(optional)Name of the template
messagestring(optional)SMS message
localestring(optional)The locale for the content in this request. Leave empty
for default locale. Iterable will automatically send the content with locale
that matches a 'locale' field in the user profile.
messageTypeIdinteger(optional)Message Type Id
imageUrlstring(optional)Image Url
clientTemplateIdstring(optional)Client template Id. Used as a secondary key to
reference the template
campaignIdobject(optional)Campaign ID
trackingDomainstring(optional)Tracking Domain
googleAnalyticsCampaignNamestring(optional)Google analytics utm_campaign value
linkParamsarray[LinkParam](optional)Parameters to append to each URL in contents
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Identifies if the locale associated with the response is the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
{} LinkParam
keystringLink parameter key
valuestringLink parameter value
GET AN SMS TEMPLATE GET
Request URL
Response Body
Response Code
Response Headers
CREATE AN SMS TEMPLATE
POST /API/TEMPLATES/SMS/UPSERT
Show Samples
Create an SMS template if it doesn't exist yet, otherwise update all SMS
templates which match the name provided.
PARAMETERS
body:
(body)
Content type:
application/json
UpsertSMSTemplateModel
Only the fields specified will be updated
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"clientTemplateId": "string",
"name": "string",
"message": "string",
"locale": "string",
"messageTypeId": 0,
"imageUrl": "string",
"creatorUserId": "string",
"googleAnalyticsCampaignName": "string",
"linkParams": [
{
"key": "string",
"value": "string"
}
],
"isDefaultLocale": true,
"messageMedium": {}
}
Body Schema
{} UpsertSMSTemplateModel
clientTemplateIdstringId used by the client to identify a template. If multiple
templates exist with the Id, all will be updated
namestring(optional)Name of the template
messagestring(optional)SMS message
localestring(optional)The locale for the content in this request. Leave empty
for default locale. Iterable will automatically send the content with locale
that matches a 'locale' field in the user profile.
messageTypeIdinteger(optional)Message Type Id
imageUrlstring(optional)Image Url
creatorUserIdstring(optional)Specify a specific creator user id (email). The
email must be an existing member of the project. Defaults to the organization
creator.
googleAnalyticsCampaignNamestring(optional)Google analytics utm_campaign value
linkParamsarray[LinkParam](optional)Parameters to append to each URL in html
contents
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Sets the locale associated with the request content as the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
messageMediumMessageMedium
{} LinkParam
keystringLink parameter key
valuestringLink parameter value
{} MessageMedium
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CREATE AN SMS TEMPLATE POST
Request URL
Response Body
Response Code
Response Headers
UPDATE SMS TEMPLATE
POST /API/TEMPLATES/SMS/UPDATE
Show Samples
PARAMETERS
body:
(body)
Content type:
application/json
ApiSMSTemplateModel
Only the fields specified will be updated
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"templateId": 0,
"createdAt": "2024-05-30T17:43:09.398Z",
"updatedAt": "2024-05-30T17:43:09.398Z",
"name": "string",
"message": "string",
"locale": "string",
"messageTypeId": 0,
"imageUrl": "string",
"clientTemplateId": "string",
"campaignId": {},
"trackingDomain": "string",
"googleAnalyticsCampaignName": "string",
"linkParams": [
{
"key": "string",
"value": "string"
}
],
"isDefaultLocale": true
}
Body Schema
{} ApiSMSTemplateModel
templateIdintegerSMS template ID
createdAtstring(optional)Date created [Read only]
updatedAtstring(optional)Date last updated [Read only]
namestring(optional)Name of the template
messagestring(optional)SMS message
localestring(optional)The locale for the content in this request. Leave empty
for default locale. Iterable will automatically send the content with locale
that matches a 'locale' field in the user profile.
messageTypeIdinteger(optional)Message Type Id
imageUrlstring(optional)Image Url
clientTemplateIdstring(optional)Client template Id. Used as a secondary key to
reference the template
campaignIdobject(optional)Campaign ID
trackingDomainstring(optional)Tracking Domain
googleAnalyticsCampaignNamestring(optional)Google analytics utm_campaign value
linkParamsarray[LinkParam](optional)Parameters to append to each URL in contents
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Identifies if the locale associated with the response is the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
{} LinkParam
keystringLink parameter key
valuestringLink parameter value
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UPDATE SMS TEMPLATE POST
Request URL
Response Body
Response Code
Response Headers
GET AN IN-APP TEMPLATE
GET /API/TEMPLATES/INAPP/GET
Show Samples
PARAMETERS
templateId:
(query)
integer
Template ID
locale:
(query)
string
Locale of content to get
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
404
Content does not exit for specified locale
Response Sample
{
"templateId": 0,
"name": "string",
"html": "string",
"inAppDisplaySettings": {
"top": {},
"right": {},
"bottom": {},
"left": {},
"bgColor": {
"alpha": 0,
"hex": "string"
},
"shouldAnimate": true
},
"webInAppDisplaySettings": {
"position": {}
},
"inboxMetadata": {
"title": "string",
"subtitle": "string",
"icon": "string"
},
"payload": {},
"expirationDateTime": "2024-05-30T17:43:09.499Z",
"expirationDuration": "string",
"locale": "string",
"clientTemplateId": "string",
"messageTypeId": 0,
"campaignId": 0,
"isDefaultLocale": true
}
Response Schema
{} ApiInAppTemplateModel
templateIdintegerIn-app template ID
namestring(optional)Name of the template
htmlstring(optional)Html of the in-app notification
inAppDisplaySettingsInAppDisplaySettings(optional)Display settings
webInAppDisplaySettingsWebInAppDisplaySettings(optional)Web In-app Display
settings
inboxMetadataInboxMetadata(optional)Title, subtitle, and thumbnail
payloadobject(optional)Payload
expirationDateTimestring(optional)The in-app message's absolute expiration time.
If set to a time before the campaign sends, contacts will never see the message.
Format is YYYY-MM-DD HH:MM:SS (UTC timestamp, time zones not allowed). Default
expiration is 90 days after send time. For more information, read Creating
In-App Templates.
expirationDurationstring(optional)The in-app message's expiration time, relative
to its send time. Should be an expression such as now+90d. Default expiration is
90 days after send time. For more information, read Creating In-App Templates.
localestring(optional)The locale for the content in this request. Leave empty
for default locale. Iterable automatically sends the content with a locale that
matches a user profile's locale field.
clientTemplateIdstring(optional)Client template Id. Used as a secondary key to
reference the template
messageTypeIdinteger(optional)Message Type Id
campaignIdinteger(optional)Campaign ID
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Identifies if the locale associated with the response is the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
{} InAppDisplaySettings
topInAppDisplaySetting(optional)Padding percentage for the top of the
notification, or -1 to autoexpand
rightInAppDisplaySetting(optional)Padding percentage for the right of the
notification, or -1 to autoexpand
bottomInAppDisplaySetting(optional)Padding percentage for the bottom of the
notification, or -1 to autoexpand
leftInAppDisplaySetting(optional)Padding percentage for the left of the
notification, or -1 to autoexpand
bgColorBgColor(optional)The background color values
shouldAnimateboolean(optional)Enables In App Animations
{} WebInAppDisplaySettings
positionPositionOption(optional)The position of the message on the screen
{} InboxMetadata
titlestring(optional)The title to display in the inbox
subtitlestring(optional)The subtitle to display in the inbox
iconstring(optional)The icon to display in the inbox
{} InAppDisplaySetting
{} BgColor
alphanumber(optional)The opacity range of the background between 0-1
hexstring(optional)The hex color of the background. Format: #FFFFFF
{} PositionOption
GET AN IN-APP TEMPLATE GET
Request URL
Response Body
Response Code
Response Headers
CREATE AN IN-APP TEMPLATE
POST /API/TEMPLATES/INAPP/UPSERT
Show Samples
Create an in-app template if it doesn't exist yet, otherwise update all in-app
templates which match the name provided.
PARAMETERS
body:
(body)
Content type:
application/json
UpsertInAppTemplateModel
Only the fields specified will be updated
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"clientTemplateId": "string",
"name": "string",
"html": "string",
"inAppDisplaySettings": {
"top": {},
"right": {},
"bottom": {},
"left": {},
"bgColor": {
"alpha": 0,
"hex": "string"
},
"shouldAnimate": true
},
"webInAppDisplaySettings": {
"position": {}
},
"inboxMetadata": {
"title": "string",
"subtitle": "string",
"icon": "string"
},
"payload": {
"underlying": {}
},
"expirationDateTime": "2024-05-30T17:43:09.399Z",
"expirationDuration": "string",
"locale": "string",
"messageTypeId": 0,
"creatorUserId": "string",
"isDefaultLocale": true,
"messageMedium": {}
}
Body Schema
{} UpsertInAppTemplateModel
clientTemplateIdstringId used by the client to identify a template. If multiple
templates exist with the Id, all will be updated
namestring(optional)Name of the template
htmlstring(optional)Html of the in-app notification
inAppDisplaySettingsInAppDisplaySettings(optional)Display settings
webInAppDisplaySettingsWebInAppDisplaySettings(optional)Web In-app display
settings
inboxMetadataInboxMetadata(optional)Title, subtitle, and thumbnail
payloadJsObject(optional)Payload
expirationDateTimestring(optional)Absolute expiration of message
expirationDurationstring(optional)Relative expiration of message
localestring(optional)The locale for the content in this request. Leave empty
for default locale. Iterable will automatically send the content with locale
that matches a 'locale' field in the user profile.
messageTypeIdinteger(optional)Message Type Id
creatorUserIdstring(optional)Specify a specific creator user id (email). The
email must be an existing member of the project. Defaults to the organization
creator.
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Sets the locale associated with the request content as the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
messageMediumMessageMedium
{} InAppDisplaySettings
topInAppDisplaySetting(optional)Padding percentage for the top of the
notification, or -1 to autoexpand
rightInAppDisplaySetting(optional)Padding percentage for the right of the
notification, or -1 to autoexpand
bottomInAppDisplaySetting(optional)Padding percentage for the bottom of the
notification, or -1 to autoexpand
leftInAppDisplaySetting(optional)Padding percentage for the left of the
notification, or -1 to autoexpand
bgColorBgColor(optional)The background color values
shouldAnimateboolean(optional)Enables In App Animations
{} WebInAppDisplaySettings
positionPositionOption(optional)The position of the message on the screen
{} InboxMetadata
titlestring(optional)The title to display in the inbox
subtitlestring(optional)The subtitle to display in the inbox
iconstring(optional)The icon to display in the inbox
{} JsObject
underlyingobject
{} MessageMedium
{} InAppDisplaySetting
{} BgColor
alphanumber(optional)The opacity range of the background between 0-1
hexstring(optional)The hex color of the background. Format: #FFFFFF
{} PositionOption
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CREATE AN IN-APP TEMPLATE POST
Request URL
Response Body
Response Code
Response Headers
UPDATE IN-APP TEMPLATE
POST /API/TEMPLATES/INAPP/UPDATE
Show Samples
PARAMETERS
body:
(body)
Content type:
application/json
ApiInAppTemplateModel
Only the fields specified will be updated
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"templateId": 0,
"name": "string",
"html": "string",
"inAppDisplaySettings": {
"top": {},
"right": {},
"bottom": {},
"left": {},
"bgColor": {
"alpha": 0,
"hex": "string"
},
"shouldAnimate": true
},
"webInAppDisplaySettings": {
"position": {}
},
"inboxMetadata": {
"title": "string",
"subtitle": "string",
"icon": "string"
},
"payload": {},
"expirationDateTime": "2024-05-30T17:43:09.400Z",
"expirationDuration": "string",
"locale": "string",
"clientTemplateId": "string",
"messageTypeId": 0,
"campaignId": 0,
"isDefaultLocale": true
}
Body Schema
{} ApiInAppTemplateModel
templateIdintegerIn-app template ID
namestring(optional)Name of the template
htmlstring(optional)Html of the in-app notification
inAppDisplaySettingsInAppDisplaySettings(optional)Display settings
webInAppDisplaySettingsWebInAppDisplaySettings(optional)Web In-app Display
settings
inboxMetadataInboxMetadata(optional)Title, subtitle, and thumbnail
payloadobject(optional)Payload
expirationDateTimestring(optional)The in-app message's absolute expiration time.
If set to a time before the campaign sends, contacts will never see the message.
Format is YYYY-MM-DD HH:MM:SS (UTC timestamp, time zones not allowed). Default
expiration is 90 days after send time. For more information, read Creating
In-App Templates.
expirationDurationstring(optional)The in-app message's expiration time, relative
to its send time. Should be an expression such as now+90d. Default expiration is
90 days after send time. For more information, read Creating In-App Templates.
localestring(optional)The locale for the content in this request. Leave empty
for default locale. Iterable automatically sends the content with a locale that
matches a user profile's locale field.
clientTemplateIdstring(optional)Client template Id. Used as a secondary key to
reference the template
messageTypeIdinteger(optional)Message Type Id
campaignIdinteger(optional)Campaign ID
isDefaultLocaleboolean(optional)Ask your Iterable CSM to enroll you in the beta
for this feature. Identifies if the locale associated with the response is the
template’s default. If empty or flexible default locales are not enabled for the
project, the project’s default locale is assigned.
{} InAppDisplaySettings
topInAppDisplaySetting(optional)Padding percentage for the top of the
notification, or -1 to autoexpand
rightInAppDisplaySetting(optional)Padding percentage for the right of the
notification, or -1 to autoexpand
bottomInAppDisplaySetting(optional)Padding percentage for the bottom of the
notification, or -1 to autoexpand
leftInAppDisplaySetting(optional)Padding percentage for the left of the
notification, or -1 to autoexpand
bgColorBgColor(optional)The background color values
shouldAnimateboolean(optional)Enables In App Animations
{} WebInAppDisplaySettings
positionPositionOption(optional)The position of the message on the screen
{} InboxMetadata
titlestring(optional)The title to display in the inbox
subtitlestring(optional)The subtitle to display in the inbox
iconstring(optional)The icon to display in the inbox
{} InAppDisplaySetting
{} BgColor
alphanumber(optional)The opacity range of the background between 0-1
hexstring(optional)The hex color of the background. Format: #FFFFFF
{} PositionOption
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UPDATE IN-APP TEMPLATE POST
Request URL
Response Body
Response Code
Response Headers
GET A USER BY EMAIL (QUERY PARAMETER)
GET /API/USERS/GETBYEMAIL
Show Samples
Get a user by email address (passed as a query parameter).
Returns the same data as GET /api/users/{email}. However, when making calls from
Iterable's API Documentation page, this endpoint provides better support for
special characters.
Learn about identifying users by userId and email.
Rate limit: 100 requests/second, per project.
PARAMETERS
email:
(query)
string
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"user": {
"email": "string",
"userId": "string",
"dataFields": {}
}
}
Response Schema
{} UserResponse
userApiResponseUser(optional)
{} ApiResponseUser
emailstring
userIdstring(optional)
dataFieldsobject(optional)
GET A USER BY EMAIL (QUERY PARAMETER) GET
Request URL
Response Body
Response Code
Response Headers
DELETE A USER BY EMAIL
DELETE /API/USERS/{EMAIL}
Show Samples
Asynchronous. Deletes a specific user by email. Does not prevent future data
collection about the user. This endpoint can be used to delete users from
email-based projects and hybrid projects, but not userID-based projects.
On Iterable's API Documentation page, this endpoint does not work for email
values that contain a / character. In such cases, you can still call this
endpoint with a tool like curl or Postman, or from your code. To learn how, read
Using API keys.
Learn about identifying users by userId and email.
Rate limit: 100 requests/second, per project.
PARAMETERS
email:
(path)
string
email
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
DELETE A USER BY EMAIL DELETE
Request URL
Response Body
Response Code
Response Headers
GET A USER BY EMAIL (PATH PARAMETER)
GET /API/USERS/{EMAIL}
Show Samples
Get a user by email address (passed as a path parameter).
On Iterable's API Documentation page, this endpoint does not work for email
values that contain a / character. In such cases, you can use GET
/api/users/getByEmail instead, or you can still call this endpoint with a tool
like curl or Postman, or from your code. To learn how, read Using API keys.
Learn about identifying users by userId and email.
Rate limit: 100 requests/second, per project.
PARAMETERS
email:
(path)
string
email
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"user": {
"email": "string",
"userId": "string",
"dataFields": {}
}
}
Response Schema
{} UserResponse
userApiResponseUser(optional)
{} ApiResponseUser
emailstring
userIdstring(optional)
dataFieldsobject(optional)
GET A USER BY EMAIL (PATH PARAMETER) GET
Request URL
Response Body
Response Code
Response Headers
GET A USER BY USERID (QUERY PARAMETER)
GET /API/USERS/BYUSERID
Show Samples
Get a user by userId (passed as a query parameter).
Returns the same data as GET /api/users/byUserId/{userId}. However, when making
calls from Iterable's API Documentation page, this endpoint provides better
support for special characters.
Learn about identifying users by userId and email.
Rate limit: 100 requests/second, per project.
PARAMETERS
userId:
(query)
string
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"user": {
"email": "string",
"userId": "string",
"dataFields": {}
}
}
Response Schema
{} UserResponse
userApiResponseUser(optional)
{} ApiResponseUser
emailstring
userIdstring(optional)
dataFieldsobject(optional)
GET A USER BY USERID (QUERY PARAMETER) GET
Request URL
Response Body
Response Code
Response Headers
REGISTER A BROWSER TOKEN FOR WEB PUSH
POST /API/USERS/REGISTERBROWSERTOKEN
Show Samples
Learn about identifying users by userId and email.
Token limit: Maximum of 500 browser tokens per user profile. Returns a 400
response code when this limit has been exceeded.
PARAMETERS
body:
(body)
Content type:
application/json
RegisterBrowserTokenRequest
Request to register browser
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
409
Email/userId conflict
Body Sample
{
"email": "string",
"browserToken": "string",
"userId": "string"
}
Body Schema
{} RegisterBrowserTokenRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
browserTokenstringThis is provided by Firebase Messaging javascript API.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
REGISTER A BROWSER TOKEN FOR WEB PUSH POST
Request URL
Response Body
Response Code
Response Headers
DELETE USER BY USERID
DELETE /API/USERS/BYUSERID/{USERID}
Show Samples
Asynchronous. Deletes a specific user by userId. Does not prevent future data
collection about the user. If multiple users share the same userId, they'll all
be deleted. This endpoint can be used to delete users from email-based projects,
userID-based projects, and hybrid projects.
On Iterable's API Documentation page, this endpoint does not work for userId
values that contain a / character. In such cases, you can still call this
endpoint with a tool like curl or Postman, or from your code. To learn how, read
Using API keys.
Learn about identifying users by userId and email.
Rate limit: 100 requests/second, per project.
PARAMETERS
userId:
(path)
string
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
DELETE USER BY USERID DELETE
Request URL
Response Body
Response Code
Response Headers
GET A USER BY USERID (PATH PARAMETER)
GET /API/USERS/BYUSERID/{USERID}
Show Samples
Get a user by userId (passed as a path parameter).
On Iterable's API Documentation page, this endpoint does not work for userId
values that contain a / character. In such cases, you can use GET
/api/users/byUserId, or you can still call this endpoint with a tool like curl
or Postman, or from your code. To learn how, read Using API keys.
Learn about identifying users by userId and email.
Rate limit: 100 requests/second, per project.
PARAMETERS
userId:
(path)
string
userId
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"user": {
"email": "string",
"userId": "string",
"dataFields": {}
}
}
Response Schema
{} UserResponse
userApiResponseUser(optional)
{} ApiResponseUser
emailstring
userIdstring(optional)
dataFieldsobject(optional)
GET A USER BY USERID (PATH PARAMETER) GET
Request URL
Response Body
Response Code
Response Headers
UPDATE USER SUBSCRIPTIONS
POST /API/USERS/UPDATESUBSCRIPTIONS
Show Samples
Updates user subscriptions. IMPORTANT: This endpoint overwrites (does not merge)
existing data for any non-null fields specified in the request.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
UpdateSubscriptionsRequest
Subscriptions to update
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
409
Email/userId conflict
Body Sample
{
"email": "string",
"userId": "string",
"emailListIds": [
0
],
"unsubscribedChannelIds": [
0
],
"unsubscribedMessageTypeIds": [
0
],
"subscribedMessageTypeIds": [
0
],
"campaignId": 0,
"templateId": 0
}
Body Schema
{} UpdateSubscriptionsRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. For each user in your request, provide an email or a userId (but not
both), depending on how your project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable. For
each user in your request, provide an email or a userId (but not both),
depending on how your project identifies users.
emailListIdsarray[integer](optional)Lists that a user is subscribed to
unsubscribedChannelIdsarray[integer](optional)Email channel ids to unsubscribe
from
unsubscribedMessageTypeIdsarray[integer](optional)Individual message type IDs to
unsubscribe (does not impact channel subscriptions).
subscribedMessageTypeIdsarray[integer](optional)Individual message type IDs to
subscribe (does not impact channel subscriptions). To set a value for this
field, first have your CSM enable the opt-in message types feature. Otherwise,
attempting to set this field causes an error.
campaignIdinteger(optional)Campaign to attribute unsubscribes
templateIdinteger(optional)Template to attribute unsubscribes
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UPDATE USER SUBSCRIPTIONS POST
Request URL
Response Body
Response Code
Response Headers
BULK UPDATE USER SUBSCRIPTIONS
POST /API/USERS/BULKUPDATESUBSCRIPTIONS
Show Samples
IMPORTANT: This endpoint overwrites (does not merge) existing data for any
non-null fields specified in the request.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
BulkUpdateSubscriptionsRequest
Bulk subscriptions to update
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
409
Email/userId conflict
Body Sample
{
"updateSubscriptionsRequests": [
{
"email": "string",
"userId": "string",
"emailListIds": [
0
],
"unsubscribedChannelIds": [
0
],
"unsubscribedMessageTypeIds": [
0
],
"subscribedMessageTypeIds": [
0
],
"campaignId": 0,
"templateId": 0
}
]
}
Body Schema
{} BulkUpdateSubscriptionsRequest
updateSubscriptionsRequestsarray[UpdateSubscriptionsRequest]List of
UpdateSubscriptionsRequests to process
{} UpdateSubscriptionsRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. For each user in your request, provide an email or a userId (but not
both), depending on how your project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable. For
each user in your request, provide an email or a userId (but not both),
depending on how your project identifies users.
emailListIdsarray[integer](optional)Lists that a user is subscribed to
unsubscribedChannelIdsarray[integer](optional)Email channel ids to unsubscribe
from
unsubscribedMessageTypeIdsarray[integer](optional)Individual message type IDs to
unsubscribe (does not impact channel subscriptions).
subscribedMessageTypeIdsarray[integer](optional)Individual message type IDs to
subscribe (does not impact channel subscriptions). To set a value for this
field, first have your CSM enable the opt-in message types feature. Otherwise,
attempting to set this field causes an error.
campaignIdinteger(optional)Campaign to attribute unsubscribes
templateIdinteger(optional)Template to attribute unsubscribes
Response Sample
{
"successCount": 0,
"failCount": 0,
"invalidEmails": [
"string"
],
"invalidUserIds": [
"string"
],
"validEmailFailures": [
"string"
],
"validUserIdFailures": [
"string"
]
}
Response Schema
{} BulkUpdateSubscriptionsResponse
successCountintegerNumber of users successfully updated
failCountintegerNumber of users that weren't updated (due to invalid email or
internal error)
invalidEmailsarray[string]A list of emails that weren't updated because they are
invalid
invalidUserIdsarray[string]A list of userIds that weren't updated because they
are invalid
validEmailFailuresarray[string]A list of emails that weren't updated due to
internal error
validUserIdFailuresarray[string]A list of userIds that weren't updated due to
internal error
BULK UPDATE USER SUBSCRIPTIONS POST
Request URL
Response Body
Response Code
Response Headers
UPDATE USER EMAIL
POST /API/USERS/UPDATEEMAIL
Show Samples
Updates a user's email.
Use this endpoint with email-based projects. To update an email in a
userID-based or hybrid project, use POST /api/users/update.
In the request body, specify currentEmail or currentUserId, but not both. If you
include both, currentEmail takes precedence.
Returns an error if the new email already exists in Iterable, or if the new
email has been forgotten via a GDPR request.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
UpdateEmailRequest
Update a user's email. All profile data and events will be migrated.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
409
Contact is GDPR forgotten
Email/userId conflict
Body Sample
{
"currentEmail": "string",
"currentUserId": "string",
"newEmail": "string"
}
Body Schema
{} UpdateEmailRequest
currentEmailstring(optional)An email address that identifies a user profile in
Iterable. Provide a currentEmail or a currentUserId (but not both), depending on
how your project identifies users.
currentUserIdstring(optional)A user ID that identifies a user profile in
Iterable. Provide a currentEmail or a currentUserId (but not both), depending on
how your project identifies users.
newEmailstringThe new email address to assign to the specified user.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UPDATE USER EMAIL POST
Request URL
Response Body
Response Code
Response Headers
GET ALL USER FIELDS
GET /API/USERS/GETFIELDS
Show Samples
Get all user fields within a project.
Rate limit: 3 requests/second, per project.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"fields": {}
}
Response Schema
{} GetUserFieldsResponse
fieldsobject
GET ALL USER FIELDS GET
Request URL
Response Body
Response Code
Response Headers
GET MESSAGES SENT TO A USER
GET /API/USERS/GETSENTMESSAGES
Show Samples
Gets messages sent to a user, by email address or userId. Returns 10 by default,
up to 1,000.
Learn about identifying users by userId and email.
Rate limit: 3 requests/second, per project.
PARAMETERS
email:
(query)
string
user's email, either email or userId must be specified
userId:
(query)
string
user's userId, either email or userId must be specified
limit:
(query)
integer
max number of messages to return (default: 10, max limit: 1000)
campaignIds:
(query)
array
only include messages from these campaigns
startDateTime:
(query)
string
start date time (yyyy-MM-dd HH:mm:ss ZZ)
endDateTime:
(query)
string
end date time (yyyy-MM-dd HH:mm:ss ZZ)
excludeBlastCampaigns:
(query)
true false (default)
boolean
exclude results coming from blast campaigns (ignored if campaignId is set)
messageMedium:
(query)
Email Push InApp SMS
string
only include messages of this type
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"messages": [
{
"messageId": "string",
"campaignId": 0,
"templateId": 0,
"createdAt": "string"
}
]
}
Response Schema
{} GetSentMessagesResponse
messagesarray[SentMessage]
{} SentMessage
messageIdstring
campaignIdinteger
templateIdinteger
createdAtstring
GET MESSAGES SENT TO A USER GET
Request URL
Response Body
Response Code
Response Headers
UPDATE USER DATA
POST /API/USERS/UPDATE
Show Samples
Updates user data or adds a user if none exists. Data is merged - missing fields
are not deleted. Please note there is a soft limit (default: 1,000) on the
number of unique fields users can have. Types of data fields must match the
types sent in previous requests, across all data fields in the project.
Processing time varies based on the current load for Iterable's back-end
services. To avoid race conditions, provide a buffer of at least 60 seconds
between this request and subsequent dependent requests, such as POST
/api/email/target.
Learn about identifying users by userId and email.
Rate limit: 500 requests/second, per project.
PARAMETERS
body:
(body)
Content type:
application/json
ApiUserUpdateRequest
user object
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
409
Contact is GDPR forgotten
Email/userId conflict
Body Sample
{
"email": "string",
"userId": "string",
"dataFields": {},
"preferUserId": true,
"mergeNestedObjects": true,
"createNewFields": true
}
Body Schema
{} ApiUserUpdateRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
dataFieldsobject(optional)Data to store on the user profile identified by userId
or email.
preferUserIdboolean(optional)Whether or not a new user should be created if the
request includes a userId that doesn't yet exist in the Iterable project.
Defaults to false. Only respected in API calls for email-based projects.
mergeNestedObjectsboolean(optional)Merge top-level objects instead of
overwriting them. Defaults to false. For example, if a user profile has data
{"mySettings":{"mobile":true}} and the request has data
{"mySettings":{"email":true}}, merging results in
{"mySettings":{"mobile":true,"email":true}}.
createNewFieldsboolean(optional)Whether new fields should be ingested and added
to the schema. Defaults to project's setting to allow or drop unrecognized
fields.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UPDATE USER DATA POST
Request URL
Response Body
Response Code
Response Headers
BULK UPDATE USER DATA
POST /API/USERS/BULKUPDATE
Show Samples
Bulk updates user data. This endpoint adds and overwrites user profile fields as
needed. It does not modify top-level fields omitted from the request body.
If you'd like to merge (rather than overwrite) a user profile's top-level
objects with the values provided for them in the request body, set
mergeNestedObjects to true.
When updating an existing field, you cannot change its data type (the new value
must have the same data type as the old value).
When adding a new field, remember that each project has a soft limit of 1,000
unique user profile fields (across all its users, with a field's uniqueness
determined by its name and position on the user profile).
Iterable handles requests to this endpoint separately from requests to
single-user endpoints (update, updateEmail, updateSubscriptions, etc.). For a
given user, in a short period of time, only use single-user calls or bulk update
calls. Otherwise, results may be inconsistent.
When updating the emailListIds field, this endpoint does not generate subscribe
or unsubscribe events. The same is true for updates to unsubscribedChannelIds
and unsubscribedMessageTypeIds (but these can only be updated by this endpoint
in projects where the opt-in message types feature is not enabled).
Learn about identifying users by userId and email.
Max size of request body: 4MB
Rate limit: 5 requests/second, per project
PARAMETERS
body:
(body)
Content type:
application/json
BulkUpdateUsersRequest
Users to update
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"users": [
{
"email": "string",
"dataFields": {},
"userId": "string",
"preferUserId": true,
"mergeNestedObjects": true
}
],
"createNewFields": true
}
Body Schema
{} BulkUpdateUsersRequest
usersarray[OptionalApiUser]
createNewFieldsboolean(optional)Whether new fields should be ingested and added
to the schema. Defaults to project's setting to allow or drop unrecognized
fields.
{} OptionalApiUser
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
dataFieldsobject(optional)
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
preferUserIdboolean(optional)Whether or not a new user should be created if the
request includes a userId that doesn't yet exist in the Iterable project.
Defaults to false. Only respected in API calls for email-based projects.
mergeNestedObjectsboolean(optional)Merge top-level objects instead of
overwriting them. Defaults to false. For example, if a user profile has data
{"mySettings":{"mobile":true}} and the request has data
{"mySettings":{"email":true}}, merging results in
{"mySettings":{"mobile":true,"email":true}}.
Response Sample
{
"successCount": 0,
"failCount": 0,
"invalidEmails": [
"string"
],
"invalidUserIds": [
"string"
],
"filteredOutFields": [
"string"
],
"createdFields": [
"string"
]
}
Response Schema
{} UserBulkUpdateListResponse
successCountinteger
failCountinteger
invalidEmailsarray[string](optional)
invalidUserIdsarray[string](optional)
filteredOutFieldsarray[string](optional)
createdFieldsarray[string](optional)
BULK UPDATE USER DATA POST
Request URL
Response Body
Response Code
Response Headers
REGISTER A DEVICE TOKEN FOR PUSH
POST /API/USERS/REGISTERDEVICETOKEN
Show Samples
Registers a device token for push. This will add the data if it doesn't exist
yet. It will also update data fields on the device. Data will be merged; missing
fields are not deleted. Also, note that there is a soft limit on the number of
unique fields a user can have (default is 1,000). Types of data fields must
match the types sent in previous requests, across all data fields in the
project.
Learn about identifying users by userId and email.
Device limit: Maximum of 500 devices per user profile. Endpoint returns a 400
response code when this limit has been exceeded.
Rate limit: 500 requests/second, per project.
PARAMETERS
body:
(body)
Content type:
application/json
RegisterDeviceTokenRequest
Request to register device
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
409
Email/userId conflict
Body Sample
{
"email": "string",
"device": {
"token": "string",
"platform": "APNS",
"applicationName": "string",
"dataFields": {}
},
"userId": "string",
"preferUserId": true
}
Body Schema
{} RegisterDeviceTokenRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
deviceDevice
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
preferUserIdboolean(optional)Whether or not a new user should be created if the
request includes a userId that doesn't yet exist in the Iterable project.
Defaults to false. Only respected in API calls for email-based projects.
{} Device
tokenstring
platformstringThe device platform
Can be APNS, APNS_SANDBOX or GCM
applicationNamestringThe Iterable push integration to associate with the device
token. Usually matches the package name (or bundle ID) of the relevant mobile
app. To check, navigate to Settings > Mobile Apps, open the mobile app, look at
the Push section and find the Name column for the relevant push integration.
dataFieldsobject(optional)
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
REGISTER A DEVICE TOKEN FOR PUSH POST
Request URL
Response Body
Response Code
Response Headers
DISABLE PUSHES TO A MOBILE DEVICE
POST /API/USERS/DISABLEDEVICE
Show Samples
Disables push notifications to a given device.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
DisableDeviceRequest
Request to disable device
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"token": "string",
"email": "string",
"userId": "string"
}
Body Schema
{} DisableDeviceRequest
tokenstringThe device token
emailstring(optional)Specific email this device belongs to disable. Will disable
device under all users with this device by default.
userIdstring(optional)Specific userId this device belongs to disable. Will
disable device under all users with this device by default.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
DISABLE PUSHES TO A MOBILE DEVICE POST
Request URL
Response Body
Response Code
Response Headers
INVALIDATE ALL JWTS ISSUED FOR A USER
POST /API/AUTH/JWTS/INVALIDATE
Show Samples
Invalidates all JWTs issued for a given user before the current time or a
specified time.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
InvalidateJwtRequest
Invalid JWT request
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"issuedBefore": 0
}
Body Schema
{} InvalidateJwtRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
issuedBeforeinteger(optional)Timestamp to invalidate JWTs before as epoch time
in milliseconds. Defaults to the current time.
INVALIDATE ALL JWTS ISSUED FOR A USER POST
Request URL
Response Body
Response Code
Response Headers
GET HASHED FORGOTTEN USERS IN COMPLIANCE WITH GDPR
GET /API/USERS/FORGOTTEN
Show Samples
Returns a hash for each email addresses currently forgotten by your project.
Each forgotten email is lowercased, trimmed, and hashed using SHA-256. This
endpoint only works for email-based and hybrid projects. For userID-based
projects, it returns an error.
Learn about identifying users by userId and email.
Rate limit: 3 requests/second, per project.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"hashedEmails": [
"string"
]
}
Response Schema
{} GetForgottenUserEmailsResponse
hashedEmailsarray[string]
GET HASHED FORGOTTEN USERS IN COMPLIANCE WITH GDPR GET
Request URL
Response Body
Response Code
Response Headers
GET HASHED FORGOTTEN USERIDS IN COMPLIANCE WITH GDPR
GET /API/USERS/FORGOTTENUSERIDS
Show Samples
Returns a hash for each userId currently forgotten by your project. Each
forgotten userId is lowercased, trimmed, and hashed using SHA-256. This endpoint
only works for userID-based and hybrid projects. For email-based projects, it
returns an error.
Learn about identifying users by userId and email.
Rate limit: 3 requests/second, per project.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Response Sample
{
"hashedUserIds": [
"string"
]
}
Response Schema
{} GetForgottenUserIdsResponse
hashedUserIdsarray[string]
GET HASHED FORGOTTEN USERIDS IN COMPLIANCE WITH GDPR GET
Request URL
Response Body
Response Code
Response Headers
FORGET A USER IN COMPLIANCE WITH GDPR
POST /API/USERS/FORGET
Show Samples
Deletes the specified user's data from the Iterable project and prevents future
data collection about them. In email-based projects, you must forget users by
email. In userID-based projects, you must forget users by userId. In hybrid
projects, you can forget users by either email or userId.
Learn about identifying users by userId and email.
Rate limit: 3 requests/second, per project.
PARAMETERS
body:
(body)
Content type:
application/json
UserRequest
user's email to be added to blacklist.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string"
}
Body Schema
{} UserRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
FORGET A USER IN COMPLIANCE WITH GDPR POST
Request URL
Response Body
Response Code
Response Headers
UNFORGET A USER IN COMPLIANCE WITH GDPR
POST /API/USERS/UNFORGET
Show Samples
Allows the Iterable project to resume collecting data about a previously
forgotten user. Deleted data cannot be recovered. In email-based projects, you
must unforget users by email. In userID-based projects, you must unforget users
by userId. In hybrid projects, you can unforget users by either email or userId.
Learn about identifying users by userId and email.
Rate limit: 3 requests/second, per project.
PARAMETERS
body:
(body)
Content type:
application/json
UserRequest
user's email to be removed from blacklist.
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string"
}
Body Schema
{} UserRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
UNFORGET A USER IN COMPLIANCE WITH GDPR POST
Request URL
Response Body
Response Code
Response Headers
BEGIN SMS VERIFICATION
POST /API/VERIFY/SMS/BEGIN
Show Samples
Sends an SMS verification code to phoneNumber, using the specified
verificationProfileId. Verification codes are sent from a pool of sender IDs
reserved for this use, not from your sender IDs. Because of this, you don't need
to worry about competing message priority or throughput.
Call this endpoint only for projects that use Iterable SMS to send SMS messages.
If you use your own Twilio or Telnyx account, call their verification endpoints
directly.
To use this endpoint, first ask your Iterable customer success manager to add
SMS phone verification to your project. To learn more, read SMS Phone
Verification.
PARAMETERS
body:
(body)
Content type:
application/json
BeginSmsVerificationRequest
The number to authenticate
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"verificationProfileId": 0,
"phoneNumber": "string"
}
Body Schema
{} BeginSmsVerificationRequest
verificationProfileIdinteger
phoneNumberstring
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
BEGIN SMS VERIFICATION POST
Request URL
Response Body
Response Code
Response Headers
CHECK SMS VERIFICATION CODE
POST /API/VERIFY/SMS/CHECK
Show Samples
Checks whether the code included in the request body matches the most recent,
non-expired, not-yet-verified SMS verification code sent to phoneNumber by the
specified verificationProfileId.
If code is correct, the endpoint returns a 200 response with a JSON body that
has a params object with status set to verified.
If code is incorrect, the endpoint returns a 200 response with a JSON body that
has a params object with status set to rejected.
Call this endpoint only for projects that use Iterable SMS to send SMS messages.
If you use your own Twilio or Telnyx account, call their verification endpoints
directly.
To use this endpoint, first ask your Iterable customer success manager to add
SMS phone verification to your project. To learn more, read SMS Phone
Verification.
PARAMETERS
body:
(body)
Content type:
application/json
CheckSmsVerificationRequest
The number to authenticate
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"verificationProfileId": 0,
"phoneNumber": "string",
"code": "string"
}
Body Schema
{} CheckSmsVerificationRequest
verificationProfileIdinteger
phoneNumberstring
codestring
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CHECK SMS VERIFICATION CODE POST
Request URL
Response Body
Response Code
Response Headers
GET WEBHOOKS
GET /API/WEBHOOKS
Show Samples
Get webhooks for a project.
Response Type:
application/json
RESPONSES
401
Invalid API key
Response Sample
{
"webhooks": [
{
"id": 0,
"enabled": true,
"endpoint": "string",
"authType": "string",
"triggeredSendEnabled": true,
"blastSendEnabled": true
}
]
}
Response Schema
{} GetWebhooksResponse
webhooksarray[ApiWebhookResponse]
{} ApiWebhookResponse
idintegerWebhook ID
enabledbooleanEnabled
endpointstringEndpoint
authTypestringAuth type
triggeredSendEnabledbooleanTriggered Send Enabled
blastSendEnabledbooleanBlast Send Enabled
GET WEBHOOKS GET
Request URL
Response Body
Response Code
Response Headers
UPDATE WEBHOOK
POST /API/WEBHOOKS
Show Samples
PARAMETERS
body:
(body)
Content type:
application/json
ApiWebhookModel
Only the specified fields will be updated
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"id": 0,
"enabled": true,
"endpoint": "string",
"authType": "NoAuth",
"authToken": "string",
"headers": [
{
"key": "string",
"value": "string"
}
],
"triggeredSendEnabled": true,
"blastSendEnabled": true
}
Body Schema
{} ApiWebhookModel
idintegerWebhook ID
enabledboolean(optional)Enabled
endpointstring(optional)Endpoint
authTypestring(optional)Auth type
Can be NoAuth, Basic or OAuth2
authTokenstring(optional)Auth token
headersarray[LinkParam](optional)Headers
triggeredSendEnabledboolean(optional)Triggered Send Enabled
blastSendEnabledboolean(optional)Blast Send Enabled
{} LinkParam
keystringLink parameter key
valuestringLink parameter value
Response Sample
{
"id": 0,
"enabled": true,
"endpoint": "string",
"authType": "string",
"triggeredSendEnabled": true,
"blastSendEnabled": true
}
Response Schema
{} ApiWebhookResponse
idintegerWebhook ID
enabledbooleanEnabled
endpointstringEndpoint
authTypestringAuth type
triggeredSendEnabledbooleanTriggered Send Enabled
blastSendEnabledbooleanBlast Send Enabled
UPDATE WEBHOOK POST
Request URL
Response Body
Response Code
Response Headers
SEND WEB PUSH NOTIFICATION TO USER
POST /API/WEBPUSH/TARGET
Show Samples
Sends a web push notification to a specific user. Request data fields override
user profile data fields. A reference to the user profile is provided via the
profile field, to help resolve field collisions.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
TargetWebPushRequest
Recipient and email id
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"campaignId": 0,
"recipientEmail": "string",
"recipientUserId": "string",
"dataFields": {},
"sendAt": "string",
"allowRepeatMarketingSends": true
}
Body Schema
{} TargetWebPushRequest
campaignIdinteger
recipientEmailstring(optional)An email address that identifies a user profile in
Iterable. Provide a recipientEmail or a recipientUserId (but not both),
depending on how your project identifies users.
recipientUserIdstring(optional)A user ID that identifies a user profile in
Iterable. Provide a recipientEmail or a recipientUserId (but not both),
depending on how your project identifies users.
dataFieldsobject(optional)Fields to merge into template
sendAtstring(optional)Schedule the message for up to 365 days in the future. If
set in the past, message is sent immediately. Format is YYYY-MM-DD HH:MM:SS in
UTC
allowRepeatMarketingSendsboolean(optional)Allow repeat marketing sends? Defaults
to true.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
SEND WEB PUSH NOTIFICATION TO USER POST
Request URL
Response Body
Response Code
Response Headers
CANCEL A WEB PUSH NOTIFICATION TO A USER
POST /API/WEBPUSH/CANCEL
Show Samples
Cancels a web push notification to a specific user. Request must include a
campaignId and an email or userId, or just a scheduledMessageId.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
CancelScheduledMessageRequest - campaignId OR scheduledMessageId are required
Email and Campaign ID
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"campaignId": 0,
"scheduledMessageId": 0,
"userId": "string"
}
Body Schema
{} CancelScheduledMessageRequest - campaignId OR scheduledMessageId are required
emailstring(optional)An email address that identifies a user profile in
Iterable. If you provide a campaignId, you must also provide an email or a
userId, depending on how your project identifies users.
campaignIdnumber(optional)The ID of the campaign associated with the scheduled
message you'd like to cancel. If you provide a campaignId, you must also provide
an email or userId, depending on how your project identifies users.
scheduledMessageIdnumber(optional)
userIdstring(optional)A user ID that identifies a user profile in Iterable. If
you provide a campaignId, you must also provide an email or a userId, depending
on how your project identifies users.
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
CANCEL A WEB PUSH NOTIFICATION TO A USER POST
Request URL
Response Body
Response Code
Response Headers
TRIGGER A JOURNEY (WORKFLOW)
POST /API/WORKFLOWS/TRIGGERWORKFLOW
Show Samples
Triggers a journey (formerly known as workflow). Triggering with a list is
asynchronous. If a list trigger is in progress, it must finish before the same
list can be triggered again for a particular journey. The journey stats may take
several minutes to update if other journeys are running.
Learn about identifying users by userId and email.
PARAMETERS
body:
(body)
Content type:
application/json
TriggerWorkflowRequest
Trigger workflow request
Response Type:
application/json
RESPONSES
400
Invalid parameters
401
Invalid API key
Body Sample
{
"email": "string",
"userId": "string",
"workflowId": 0,
"dataFields": {},
"listId": 0
}
Body Schema
{} TriggerWorkflowRequest
emailstring(optional)An email address that identifies a user profile in
Iterable. Provide an email or a userId (but not both), depending on how your
project identifies users.
userIdstring(optional)A user ID that identifies a user profile in Iterable.
Provide an email or a userId (but not both), depending on how your project
identifies users.
workflowIdintegerID of journey (workflow) to trigger
dataFieldsobject(optional)Additional data associated triggering event
listIdinteger(optional)(Optional) Trigger the journey for all users in a list
(standard or dynamic)
Response Sample
{
"msg": "string",
"code": "Success",
"params": {}
}
Response Schema
{} IterableApiResponse
msgstringResponse description
codestring
Can be Success, BadApiKey, BadAuthorizationHeader, BadJsonBody, BadParams,
BatchTooLarge, DatabaseError, EmailAlreadyExists, ExternalKeyConflict,
Forbidden, ForbiddenParamsError, ForgottenUserError, GenericError,
InvalidEmailAddressError, InvalidJwtPayload, InvalidUserIdError,
JwtUserIdentifiersMismatched, NotFound, QueueEmailError, RateLimitExceeded,
RequestFieldsTypesMismatched, Unauthorized, UniqueFieldsLimitExceeded,
UnknownEmailError, UnknownUserIdError or UserIdAlreadyExists
paramsobject(optional)Additional info
TRIGGER A JOURNEY (WORKFLOW) POST
Request URL
Response Body
Response Code
Response Headers