swagger.smartzip-services.com
Open in
urlscan Pro
44.241.128.82
Public Scan
Submitted URL: http://nurture-api.smartzip-services.com/
Effective URL: http://swagger.smartzip-services.com/?url=http://notification-api.smartzip-services.com/api/1.0/production/api-docs.json
Submission Tags: @phish_report
Submission: On August 02 via api from FI — Scanned from AU
Effective URL: http://swagger.smartzip-services.com/?url=http://notification-api.smartzip-services.com/api/1.0/production/api-docs.json
Submission Tags: @phish_report
Submission: On August 02 via api from FI — Scanned from AU
Form analysis 30 forms found in the DOM
<form id="api_selector">
<div class="input"><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"></div>
<div class="input"><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"></div>
<div class="input"><a id="explore" href="#">Explore</a></div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_id</td>
<td>
<input class="parameter required" minlength="1" name="user_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>User ID</p>
</span></strong>
</td>
<td>form</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code">platform</td>
<td>
<select class="parameter" name="platform">
<option value="APNS">APNS</option>
<option value="APNS_SANDBOX">APNS_SANDBOX</option>
<option value="GCM">GCM</option>
</select>
</td>
<td class="markdown">
<p>Platform</p>
</td>
<td>form</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">device_token</td>
<td>
<input class="parameter required" minlength="1" name="device_token" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Device Token</p>
</span></strong>
</td>
<td>form</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required">Authentication-Token</td>
<td>
<input class="parameter required" minlength="1" name="Authentication-Token" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Authentication Token</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">406</td>
<td>Not Acceptable</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_id</td>
<td>
<input class="parameter required" minlength="1" name="user_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>User ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required">notification_text</td>
<td>
<input class="parameter required" minlength="1" name="notification_text" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Notification Text</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">context</td>
<td>
<input class="parameter" minlength="0" name="context" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>context</p>
</td>
<td>query</td>
<td>
<span class="model-signature">hash</span>
</td>
</tr>
<tr>
<td class="code required">Authentication-Token</td>
<td>
<input class="parameter required" minlength="1" name="Authentication-Token" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Authentication Token</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">respondent_id</td>
<td>
<input class="parameter required" minlength="1" name="respondent_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Respondent ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required">campaign_id</td>
<td>
<input class="parameter required" minlength="1" name="campaign_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Campaign ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required">agent_site_offer_id</td>
<td>
<input class="parameter required" minlength="1" name="agent_site_offer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Agent Site Offer ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required">marketing_action</td>
<td>
<input class="parameter required" minlength="1" name="marketing_action" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Action</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">406</td>
<td>Not Acceptable</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">campaign_id</td>
<td>
<input class="parameter required" minlength="1" name="campaign_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Campaign ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code">respondent_id</td>
<td>
<input class="parameter" minlength="0" name="respondent_id" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">agent_site_offer_id</td>
<td>
<input class="parameter" minlength="0" name="agent_site_offer_id" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">marketing_action</td>
<td>
<input class="parameter" minlength="0" name="marketing_action" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">year</td>
<td>
<input class="parameter" minlength="0" name="year" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">month</td>
<td>
<input class="parameter" minlength="0" name="month" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">406</td>
<td>Not Acceptable</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">user_id</td>
<td>
<input class="parameter" minlength="0" name="user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_user_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">type</td>
<td>
<select class="parameter" name="type">
<option selected="" value=""></option>
<option value="AgentBrandProfile">AgentBrandProfile</option>
<option value="BrokerBrandProfile">BrokerBrandProfile</option>
<option value="TeamBrandProfile">TeamBrandProfile</option>
</select>
</td>
<td class="markdown">
<p>Type</p>
</td>
<td>form</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>BrandProfile ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">HTTP_X_AMZ_SNS_MESSAGE_TYPE</td>
<td>
<input class="parameter required" minlength="1" name="HTTP_X_AMZ_SNS_MESSAGE_TYPE" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>HTTP_X_AMZ_SNS_MESSAGE_TYPE</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">406</td>
<td>Not Acceptable</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">json</td>
<td>
<input class="parameter required" minlength="1" name="json" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>JSON</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">406</td>
<td>Not Acceptable</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">id</td>
<td>
<input class="parameter" minlength="0" name="id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Campaign ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_fulfillment_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_fulfillment_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy Fulfillment ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">campaign_properties</td>
<td>
<input class="parameter" minlength="0" name="campaign_properties" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Campaign Audience (Comma-Separated Property IDs)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">utm_campaign</td>
<td>
<input class="parameter required" minlength="1" name="utm_campaign" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Campaign ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code">utm_template</td>
<td>
<input class="parameter" minlength="0" name="utm_template" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Online Ad Template ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">utm_medium</td>
<td>
<input class="parameter" minlength="0" name="utm_medium" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Online Ad Type</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">utm_source</td>
<td>
<input class="parameter" minlength="0" name="utm_source" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Online Ad Vendor</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">user_id</td>
<td>
<input class="parameter" minlength="0" name="user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">type</td>
<td>
<select class="parameter" name="type">
<option selected="" value=""></option>
<option value="OnlineAdCampaign">OnlineAdCampaign</option>
<option value="DirectMailCampaign">DirectMailCampaign</option>
</select>
</td>
<td class="markdown">
<p>Type</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">mode</td>
<td>
<select class="parameter" name="mode">
<option selected="" value=""></option>
<option value="dashboard">dashboard</option>
<option value="list">list</option>
<option value="action_needed_campaigns">action_needed_campaigns</option>
<option value="active_campaigns">active_campaigns</option>
<option value="archived_campaigns">archived_campaigns</option>
<option value="upcoming_campaigns">upcoming_campaigns</option>
<option value="missed_approval">missed_approval</option>
<option value="approval_needed">approval_needed</option>
</select>
</td>
<td class="markdown">
<p>Mode</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">page</td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Page Number</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">per_page</td>
<td>
<input class="parameter" minlength="0" name="per_page" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Items per Page</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">active_only</td>
<td>
<input class="parameter" minlength="0" name="active_only" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Active Only Flag</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">user_id</td>
<td>
<input class="parameter" minlength="0" name="user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">territory_id</td>
<td>
<input class="parameter" minlength="0" name="territory_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Territory ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">mode</td>
<td>
<select class="parameter" name="mode">
<option selected="" value=""></option>
<option value="home_trends_report">home_trends_report</option>
</select>
</td>
<td class="markdown">
<p>Mode</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">type</td>
<td>
<select class="parameter" name="type">
<option selected="" value=""></option>
<option value=""></option>
<option value="PostcardMailing">PostcardMailing</option>
<option value="EmailNurtureCampaign">EmailNurtureCampaign</option>
<option value="HomeTrendsReportCampaign">HomeTrendsReportCampaign</option>
<option value="PostcardMailing">PostcardMailing</option>
<option value="JustListedMailing">JustListedMailing</option>
<option value="JustSoldMailing">JustSoldMailing</option>
<option value="HandwrittenNoteMailing">HandwrittenNoteMailing</option>
<option value="FacebookRightHandSideCampaign">FacebookRightHandSideCampaign</option>
<option value="FacebookNewsfeedAdCampaign">FacebookNewsfeedAdCampaign</option>
<option value="DisplayAdCampaign">DisplayAdCampaign</option>
</select>
</td>
<td class="markdown">
<p>Type</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">id</td>
<td>
<input class="parameter" minlength="0" name="id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Campaign ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_fulfillment_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_fulfillment_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy Fulfillment ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">mode</td>
<td>
<select class="parameter" name="mode">
<option selected="" value=""></option>
<option value="all">all</option>
<option value="mobile">mobile</option>
</select>
</td>
<td class="markdown">
<p>Mode</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">year</td>
<td>
<input class="parameter required" minlength="1" name="year" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Year</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">month</td>
<td>
<input class="parameter required" minlength="1" name="month" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Month</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">type</td>
<td>
<input class="parameter required" minlength="1" name="type" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Direct Mail Template Type</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">territory_id</td>
<td>
<input class="parameter required" minlength="1" name="territory_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Territory ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required">legacy_territory_id</td>
<td>
<input class="parameter required" minlength="1" name="legacy_territory_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Legacy Territory ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code">mode</td>
<td>
<input class="parameter" minlength="0" name="mode" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Mode (default, ids_only)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">user_id</td>
<td>
<input class="parameter" minlength="0" name="user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_user_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">user_id</td>
<td>
<input class="parameter" minlength="0" name="user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_user_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">first_name</td>
<td>
<input class="parameter" minlength="0" name="first_name" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>First Name</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">last_name</td>
<td>
<input class="parameter" minlength="0" name="last_name" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Last Name</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">street_address</td>
<td>
<input class="parameter" minlength="0" name="street_address" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Street Address</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">unit_number</td>
<td>
<input class="parameter" minlength="0" name="unit_number" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Unit Number</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">city</td>
<td>
<input class="parameter" minlength="0" name="city" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>City</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">state</td>
<td>
<input class="parameter" minlength="0" name="state" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>State</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">zip</td>
<td>
<input class="parameter" minlength="0" name="zip" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Zip</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Mailer Seed Address ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">campaign_id</td>
<td>
<input class="parameter" minlength="0" name="campaign_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Campaign ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_fulfillment_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_fulfillment_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy Fulfillment ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">id</td>
<td>
<input class="parameter" minlength="0" name="id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Keycode ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">keycode</td>
<td>
<input class="parameter" minlength="0" name="keycode" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Keycode</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">online_ad_resource_type</td>
<td>
<select class="parameter" name="online_ad_resource_type">
<option value=""></option>
<option value="DisplayAdResource300x250">DisplayAdResource300x250</option>
<option value="DisplayAdResource160x600">DisplayAdResource160x600</option>
<option value="DisplayAdResource728x90">DisplayAdResource728x90</option>
<option value="FacebookNewsfeedAdResource">FacebookNewsfeedAdResource</option>
<option value="FacebookRightHandSideAdResource">FacebookRightHandSideAdResource</option>
</select>
</td>
<td class="markdown">
<p>Online Ad Resource Type</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Online Ad Resource Id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code">user_id</td>
<td>
<input class="parameter" minlength="0" name="user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_id</td>
<td>
<input class="parameter required" minlength="1" name="user_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>User ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required">sub_type</td>
<td>
<input class="parameter required" minlength="1" name="sub_type" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Client Pixel Sub Type (retargeting: 1, conversion: 0)</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">user_id</td>
<td>
<input class="parameter" minlength="0" name="user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_user_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">mode</td>
<td>
<select class="parameter" name="mode">
<option selected="" value=""></option>
<option value="home_trends_report">home_trends_report</option>
</select>
</td>
<td class="markdown">
<p>Mode</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Territory ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">mode</td>
<td>
<select class="parameter" name="mode">
<option selected="" value=""></option>
<option value="all">all</option>
<option value="last">last</option>
</select>
</td>
<td class="markdown">
<p>Mode</p>
</td>
<td>form</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">user_id</td>
<td>
<input class="parameter" minlength="0" name="user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_user_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">territory_id</td>
<td>
<input class="parameter" minlength="0" name="territory_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Territory ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_territory_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_territory_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy Territory ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">user_id</td>
<td>
<input class="parameter" minlength="0" name="user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_user_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">territory_id</td>
<td>
<input class="parameter" minlength="0" name="territory_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Territory ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">legacy_territory_id</td>
<td>
<input class="parameter" minlength="0" name="legacy_territory_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Legacy Territory ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code required">ranked_properties</td>
<td>
<input class="parameter required" minlength="1" name="ranked_properties" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Ranked Property IDs, Comma-Separated.</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>List ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">territory_id</td>
<td>
<input class="parameter required" minlength="1" name="territory_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Territory ID</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required">property_ids</td>
<td>
<input class="parameter required" minlength="1" name="property_ids" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Comma-Separated Property IDs</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">api_key</td>
<td>
<input class="parameter required" minlength="1" name="api_key" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>API Key</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">user_id</td>
<td>
<input class="parameter" minlength="0" name="user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>User ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td>Unauthorized</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form>Text Content
swagger
Explore
SmartZip Platform :: Notification API
Rails API project handling delivery & tracking of all system notifications (SMS,
Push, Email)
* USER_ENDPOINTS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * POST /USER_ENDPOINTS.JSON
* User Endpoint Creation
IMPLEMENTATION NOTES
Creates a User Endpoint with a valid params
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string user_id
User ID
form integer platform APNS APNS_SANDBOX GCM
Platform
form stringdevice_token
Device Token
form integer Authentication-Token
Authentication Token
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized 406 Not
Acceptable
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /USER_ENDPOINTS/SEND_NOTIFICATION.JSON
* Sends the notification
IMPLEMENTATION NOTES
Sends the notification
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string user_id
User ID
query integer notification_text
Notification Text
query string context
context
query hash Authentication-Token
Authentication Token
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MARKETING_ACTIVITY_NOTIFICATIONS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * POST /MARKETING_ACTIVITY_NOTIFICATIONS.JSON
* Marketing Activity Notification Creation
IMPLEMENTATION NOTES
Creates a Marketing Activity using the params and a Notification. Returns
a Marketing Activity Notification that connects both.
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string respondent_id
Respondent ID
query integer campaign_id
Campaign ID
query integer agent_site_offer_id
Agent Site Offer ID
query integer marketing_action
Action
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 406 Not Acceptable
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MARKETING_ACTIVITIES
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /MARKETING_ACTIVITIES.JSON
* Marketing Activities List
IMPLEMENTATION NOTES
Returns marketing activities for a campaigns and filter option.
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string campaign_id
Campaign ID
query integer respondent_id query integer agent_site_offer_id query
integer marketing_action query string year query integer month query
integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 406 Not Acceptable
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* EMAIL_NOTIFICATIONS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* BRAND_PROFILES
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /BRAND_PROFILES.JSON
* All Brand Profiles
IMPLEMENTATION NOTES
Returns an array of Brand Profile objects for a given user
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string user_id
User ID
query integer legacy_user_id
Legacy User ID
query integer type AgentBrandProfile BrokerBrandProfile TeamBrandProfile
Type
form string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BRAND_PROFILES/{ID}.JSON
* Brand Profile Details
IMPLEMENTATION NOTES
Fetches a single Brand Profile item
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string id
BrandProfile ID
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* BRAND_PROFILE_RESOURCES
* Show/Hide
* List Operations
* Expand Operations
* Raw
* ACTION_FRAMEWORK_EVENTS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * POST /ACTION_FRAMEWORK_EVENTS.JSON
* Action Framework Events
IMPLEMENTATION NOTES
Posting a Action Framework Events
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string HTTP_X_AMZ_SNS_MESSAGE_TYPE
HTTP_X_AMZ_SNS_MESSAGE_TYPE
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized 406 Not
Acceptable
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* AGREEMENTS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * POST /AGREEMENTS/SIGNATURE_REQUEST.JSON
* Signature Request
IMPLEMENTATION NOTES
Posting a signature request
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string json
JSON
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized 406 Not
Acceptable
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CAMPAIGNS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * PUT /CAMPAIGNS/UPDATE.JSON
* Campaign Update
IMPLEMENTATION NOTES
Updates a Campaign object
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string id
Campaign ID
query integer legacy_fulfillment_id
Legacy Fulfillment ID
query integer campaign_properties
Campaign Audience (Comma-Separated Property IDs)
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CAMPAIGNS/TRACK.JSON
* Campaign Tracking
IMPLEMENTATION NOTES
Tracks campaign performance/clicks
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string utm_campaign
Campaign ID
query integer utm_template
Online Ad Template ID
query integer utm_medium
Online Ad Type
query string utm_source
Online Ad Vendor
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CAMPAIGNS/CAMPAIGNS_LIST.JSON
* Campaign List
IMPLEMENTATION NOTES
Returns an array of Campaigns List for a given user
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string user_id
User ID
query integer type OnlineAdCampaign DirectMailCampaign
Type
query stringmode dashboard list action_needed_campaigns active_campaigns
archived_campaigns upcoming_campaigns missed_approval approval_needed
Mode
query stringpage
Page Number
query string per_page
Items per Page
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CAMPAIGNS.JSON
* All Campaigns
IMPLEMENTATION NOTES
Returns all campaigns for a given user or territory
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string active_only
Active Only Flag
query string user_id
User ID
query integer territory_id
Territory ID
query integer mode home_trends_report
Mode
query stringtype PostcardMailing EmailNurtureCampaign
HomeTrendsReportCampaign PostcardMailing JustListedMailing
JustSoldMailing HandwrittenNoteMailing FacebookRightHandSideCampaign
FacebookNewsfeedAdCampaign DisplayAdCampaign
Type
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CAMPAIGNS/{ID}.JSON
* Campaign Details
IMPLEMENTATION NOTES
Fetches a single Campaign object
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string id
Campaign ID
query integer legacy_fulfillment_id
Legacy Fulfillment ID
query integer mode all mobile
Mode
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CAMPAIGN_LOGS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* DIRECT_MAIL_TEMPLATES
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /DIRECT_MAIL_TEMPLATES.JSON
* All Direct Mail Templates but excluded by colliding templates
IMPLEMENTATION NOTES
Returns all Direct Mail Templates but excluded by colliding templates
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string year
Year
query string month
Month
query string type
Direct Mail Template Type
query string territory_id
Territory ID
query integer legacy_territory_id
Legacy Territory ID
query integer mode
Mode (default, ids_only)
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MAILER_SEED_ADDRESSES
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /MAILER_SEED_ADDRESSES.JSON
* All Mailer Seed Addresses
IMPLEMENTATION NOTES
Returns all mailer seed addresses for a given user or legacy user
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string user_id
User ID
query integer legacy_user_id
Legacy User ID
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MAILER_SEED_ADDRESSES.JSON
* Create Mailer Seed Address
IMPLEMENTATION NOTES
Creates new Mailer Seed Address object
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string user_id
User ID
query integer legacy_user_id
Legacy User ID
query integer first_name
First Name
query string last_name
Last Name
query string street_address
Street Address
query string unit_number
Unit Number
query string city
City
query string state
State
query string zip
Zip
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MAILER_SEED_ADDRESSES/{ID}.JSON
* Mailer Seed Address
IMPLEMENTATION NOTES
Fetches a single Mailer Seed Address object
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string id
Mailer Seed Address ID
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* KEYCODES
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /KEYCODES.JSON
* All Keycodes
IMPLEMENTATION NOTES
Returns all keycodes for a given campaign
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string campaign_id
Campaign ID
query integer legacy_fulfillment_id
Legacy Fulfillment ID
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /KEYCODES/{ID}.JSON
* Keycode Details
IMPLEMENTATION NOTES
Fetches a single Keycode object (if found)
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string id
Keycode ID
query integer keycode
Keycode
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ONLINE_AD_TEMPLATES
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /ONLINE_AD_TEMPLATES.JSON
* All Online Ad Templates
IMPLEMENTATION NOTES
Returns all available Online Ad Templates
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string online_ad_resource_type DisplayAdResource300x250
DisplayAdResource160x600 DisplayAdResource728x90
FacebookNewsfeedAdResource FacebookRightHandSideAdResource
Online Ad Resource Type
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ONLINE_AD_RESOURCES
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /ONLINE_AD_RESOURCES/{ID}.JSON
* Online Ad resource Details
IMPLEMENTATION NOTES
Fetches a single Online Ad Resource object
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string id
Online Ad Resource Id
path integer user_id
User ID
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CLIENT_PIXELS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /CLIENT_PIXELS.JSON
* Client Pixels
IMPLEMENTATION NOTES
Returns all Client Pixels to display on an agent's lead capture site
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string user_id
User ID
query integer sub_type
Client Pixel Sub Type (retargeting: 1, conversion: 0)
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TERRITORIES
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /TERRITORIES.JSON
* All Territories
IMPLEMENTATION NOTES
Returns an array of Territory objects for a given user
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string user_id
User ID
query integer legacy_user_id
Legacy User ID
query integer mode home_trends_report
Mode
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /TERRITORIES/{ID}.JSON
* Territory Details
IMPLEMENTATION NOTES
Fetches a single Territory item
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string id
Territory ID
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* LISTS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /LISTS.JSON
* All Lists
IMPLEMENTATION NOTES
Returns an array of List objects for a given user
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string mode all last
Mode
form stringuser_id
User ID
query integer legacy_user_id
Legacy User ID
query integer territory_id
Territory ID
query integer legacy_territory_id
Legacy Territory ID
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /LISTS.JSON
* Create New List
IMPLEMENTATION NOTES
Given ranked property_ids, creates a new List and its associated
target_ranks records
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string user_id
User ID
query integer legacy_user_id
Legacy User ID
query integer territory_id
Territory ID
query integer legacy_territory_id
Legacy Territory ID
query integer ranked_properties
Ranked Property IDs, Comma-Separated.
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /LISTS/{ID}.JSON
* List Details
IMPLEMENTATION NOTES
Fetches a single List and its associated target_ranks
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string id
List ID
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PREDICTIONS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * POST /PREDICTIONS.JSON
* PL Service
IMPLEMENTATION NOTES
Based on a given set of property_ids, generates pre-mover score-based
output that can be used to generate a SmartTargeting List.
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string territory_id
Territory ID
query integer property_ids
Comma-Separated Property IDs
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* RECOMMENDATIONS
* Show/Hide
* List Operations
* Expand Operations
* Raw
* * GET /RECOMMENDATIONS.JSON
* All Recommendations
IMPLEMENTATION NOTES
Returns an array of Reach150 Recommendations for a given user
PARAMETERS
Parameter Value Description Parameter Type Data Type api_key
API Key
query string user_id
User ID
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 401 Unauthorized
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
[ BASE URL: HTTP://NOTIFICATION-API.SMARTZIP-SERVICES.COM ]