developers.brandtrack.fm
Open in
urlscan Pro
54.214.192.126
Public Scan
URL:
https://developers.brandtrack.fm/
Submission: On August 06 via automatic, source certstream-suspicious — Scanned from DE
Submission: On August 06 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 25 forms found in the DOM
<form id="form-GETv2-accounts" data-method="GET" data-path="v2/accounts" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-accounts', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-accounts" onclick="tryItOut('GETv2-accounts');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-accounts" onclick="cancelTryOut('GETv2-accounts');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-accounts" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send Request 💥
</button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/accounts</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-accounts" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-accounts" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-accounts" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="page" data-endpoint="GETv2-accounts" value="1" data-component="query">
<br>
<p>The page requested. Default to 1. Example: <code>1</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>per_page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="per_page" data-endpoint="GETv2-accounts" value="100"
data-component="query">
<br>
<p>The number of items per page. Default to 25. Example: <code>100</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>order_by</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="order_by" data-endpoint="GETv2-accounts" value="name" data-component="query">
<br>
<p>The field to order the results by. Default to id. Example: <code>name</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>direction</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="direction" data-endpoint="GETv2-accounts" value="desc" data-component="query">
<br>
<p>The direction method to sort results. Default to asc. Example: <code>desc</code></p>
</div>
</form><form id="form-GETv2-accounts--id-" data-method="GET" data-path="v2/accounts/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-accounts--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-accounts--id-" onclick="tryItOut('GETv2-accounts--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-accounts--id-" onclick="cancelTryOut('GETv2-accounts--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-accounts--id-" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send
Request 💥 </button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/accounts/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-accounts--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-accounts--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-accounts--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="GETv2-accounts--id-" value="19120" data-component="url">
<br>
<p>The ID of the account. Example: <code>19120</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>using_account_id</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="using_account_id" data-endpoint="GETv2-accounts--id-"
value="0" data-component="query">
<br>
<p>Set this ID to filter records only to this particular account. By not providing anything, results from all accounts will be returned. Default to null. Example: <code>0</code></p>
</div>
</form><form id="form-PATCHv2-accounts--id-" data-method="PATCH" data-path="v2/accounts/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('PATCHv2-accounts--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-PATCHv2-accounts--id-" onclick="tryItOut('PATCHv2-accounts--id-');">Try it out ⚡
</button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-PATCHv2-accounts--id-" onclick="cancelTryOut('PATCHv2-accounts--id-');" hidden="">Cancel 🛑
</button> <button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-PATCHv2-accounts--id-" data-initial-text="Send Request 💥"
data-loading-text="⏱ Sending..." hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-purple">PATCH</small>
<b><code>v2/accounts/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="PATCHv2-accounts--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="PATCHv2-accounts--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="PATCHv2-accounts--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="PATCHv2-accounts--id-" value="19120" data-component="url">
<br>
<p>The ID of the account. Example: <code>19120</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>name</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="name" data-endpoint="PATCHv2-accounts--id-" value="ly" data-component="body">
<br>
<p>Must not be greater than 100 characters. Example: <code>ly</code></p>
</div>
</form><form id="form-GETv2-subscriptions" data-method="GET" data-path="v2/subscriptions" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-subscriptions', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-subscriptions" onclick="tryItOut('GETv2-subscriptions');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-subscriptions" onclick="cancelTryOut('GETv2-subscriptions');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-subscriptions" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send
Request 💥 </button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/subscriptions</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-subscriptions" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-subscriptions" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-subscriptions" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="page" data-endpoint="GETv2-subscriptions" value="1"
data-component="query">
<br>
<p>The page requested. Default to 1. Example: <code>1</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>per_page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="per_page" data-endpoint="GETv2-subscriptions" value="100"
data-component="query">
<br>
<p>The number of items per page. Default to 25. Example: <code>100</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>order_by</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="order_by" data-endpoint="GETv2-subscriptions" value="name" data-component="query">
<br>
<p>The field to order the results by. Default to id. Example: <code>name</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>direction</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="direction" data-endpoint="GETv2-subscriptions" value="desc"
data-component="query">
<br>
<p>The direction method to sort results. Default to asc. Example: <code>desc</code></p>
</div>
</form><form id="form-GETv2-subscriptions--id-" data-method="GET" data-path="v2/subscriptions/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off"
onsubmit="event.preventDefault(); executeTryOut('GETv2-subscriptions--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-subscriptions--id-" onclick="tryItOut('GETv2-subscriptions--id-');">Try it out ⚡
</button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-subscriptions--id-" onclick="cancelTryOut('GETv2-subscriptions--id-');" hidden="">Cancel 🛑
</button> <button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-subscriptions--id-" data-initial-text="Send Request 💥"
data-loading-text="⏱ Sending..." hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/subscriptions/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-subscriptions--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-subscriptions--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-subscriptions--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="GETv2-subscriptions--id-" value="5392" data-component="url">
<br>
<p>The ID of the subscription. Example: <code>5392</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>using_account_id</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="using_account_id" data-endpoint="GETv2-subscriptions--id-"
value="0" data-component="query">
<br>
<p>Set this ID to filter records only to this particular account. By not providing anything, results from all accounts will be returned. Default to null. Example: <code>0</code></p>
</div>
</form><form id="form-GETv2-users" data-method="GET" data-path="v2/users" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-users', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-users" onclick="tryItOut('GETv2-users');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-users" onclick="cancelTryOut('GETv2-users');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-users" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send Request 💥
</button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/users</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-users" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-users" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-users" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="page" data-endpoint="GETv2-users" value="1" data-component="query">
<br>
<p>The page requested. Default to 1. Example: <code>1</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>per_page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="per_page" data-endpoint="GETv2-users" value="100"
data-component="query">
<br>
<p>The number of items per page. Default to 25. Example: <code>100</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>order_by</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="order_by" data-endpoint="GETv2-users" value="name" data-component="query">
<br>
<p>The field to order the results by. Default to id. Example: <code>name</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>direction</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="direction" data-endpoint="GETv2-users" value="desc" data-component="query">
<br>
<p>The direction method to sort results. Default to asc. Example: <code>desc</code></p>
</div>
</form><form id="form-GETv2-users--id-" data-method="GET" data-path="v2/users/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-users--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-users--id-" onclick="tryItOut('GETv2-users--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-users--id-" onclick="cancelTryOut('GETv2-users--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-users--id-" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send
Request 💥 </button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/users/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-users--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-users--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-users--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="GETv2-users--id-" value="18782" data-component="url">
<br>
<p>The ID of the user. Example: <code>18782</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="page" data-endpoint="GETv2-users--id-" value="1" data-component="query">
<br>
<p>The page requested. Default to 1. Example: <code>1</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>per_page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="per_page" data-endpoint="GETv2-users--id-" value="100"
data-component="query">
<br>
<p>The number of items per page. Default to 25. Example: <code>100</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>order_by</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="order_by" data-endpoint="GETv2-users--id-" value="name" data-component="query">
<br>
<p>The field to order the results by. Default to id. Example: <code>name</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>direction</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="direction" data-endpoint="GETv2-users--id-" value="desc" data-component="query">
<br>
<p>The direction method to sort results. Default to asc. Example: <code>desc</code></p>
</div>
</form><form id="form-POSTv2-users" data-method="POST" data-path="v2/users" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTv2-users', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTv2-users" onclick="tryItOut('POSTv2-users');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTv2-users" onclick="cancelTryOut('POSTv2-users');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTv2-users" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send Request 💥
</button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>v2/users</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="POSTv2-users" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="POSTv2-users" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="POSTv2-users" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>account_id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="account_id" data-endpoint="POSTv2-users" value="19120" data-component="body">
<br>
<p>The account where this user will be created. Example: <code>19120</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>email</code></b> <small>string</small> <input type="text" style="display: none" name="email" data-endpoint="POSTv2-users" value="testexample@example.com" data-component="body">
<br>
<p>The email to be registered. Example: <code>testexample@example.com</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>firstname</code></b> <small>string</small> <input type="text" style="display: none" name="firstname" data-endpoint="POSTv2-users" value="John" data-component="body">
<br>
<p>User's firstname. Example: <code>John</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>lastname</code></b> <small>string</small> <input type="text" style="display: none" name="lastname" data-endpoint="POSTv2-users" value="Doe" data-component="body">
<br>
<p>User's lastname. Example: <code>Doe</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>role_id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="role_id" data-endpoint="POSTv2-users" value="74" data-component="body">
<br>
<p>The role to assign to the new user. Example: <code>74</code></p>
</div>
</form><form id="form-POSTv2-users--id--token" data-method="POST" data-path="v2/users/{id}/token" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTv2-users--id--token', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTv2-users--id--token" onclick="tryItOut('POSTv2-users--id--token');">Try it out ⚡
</button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTv2-users--id--token" onclick="cancelTryOut('POSTv2-users--id--token');" hidden="">Cancel 🛑
</button> <button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTv2-users--id--token" data-initial-text="Send Request 💥"
data-loading-text="⏱ Sending..." hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>v2/users/{id}/token</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="POSTv2-users--id--token" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="POSTv2-users--id--token" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="POSTv2-users--id--token" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="POSTv2-users--id--token" value="18782" data-component="url">
<br>
<p>The ID of the user. Example: <code>18782</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="page" data-endpoint="POSTv2-users--id--token" value="1"
data-component="query">
<br>
<p>The page requested. Default to 1. Example: <code>1</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>per_page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="per_page" data-endpoint="POSTv2-users--id--token" value="100"
data-component="query">
<br>
<p>The number of items per page. Default to 25. Example: <code>100</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>order_by</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="order_by" data-endpoint="POSTv2-users--id--token" value="name"
data-component="query">
<br>
<p>The field to order the results by. Default to id. Example: <code>name</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>direction</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="direction" data-endpoint="POSTv2-users--id--token" value="desc"
data-component="query">
<br>
<p>The direction method to sort results. Default to asc. Example: <code>desc</code></p>
</div>
</form><form id="form-GETv2-locations" data-method="GET" data-path="v2/locations" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-locations', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-locations" onclick="tryItOut('GETv2-locations');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-locations" onclick="cancelTryOut('GETv2-locations');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-locations" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send Request 💥
</button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/locations</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-locations" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-locations" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-locations" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="page" data-endpoint="GETv2-locations" value="1" data-component="query">
<br>
<p>The page requested. Default to 1. Example: <code>1</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>per_page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="per_page" data-endpoint="GETv2-locations" value="100"
data-component="query">
<br>
<p>The number of items per page. Default to 25. Example: <code>100</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>order_by</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="order_by" data-endpoint="GETv2-locations" value="name" data-component="query">
<br>
<p>The field to order the results by. Default to id. Example: <code>name</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>direction</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="direction" data-endpoint="GETv2-locations" value="desc" data-component="query">
<br>
<p>The direction method to sort results. Default to asc. Example: <code>desc</code></p>
</div>
</form><form id="form-GETv2-locations--id-" data-method="GET" data-path="v2/locations/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-locations--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-locations--id-" onclick="tryItOut('GETv2-locations--id-');">Try it out ⚡
</button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-locations--id-" onclick="cancelTryOut('GETv2-locations--id-');" hidden="">Cancel 🛑
</button> <button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-locations--id-" data-initial-text="Send Request 💥"
data-loading-text="⏱ Sending..." hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/locations/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-locations--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-locations--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-locations--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="GETv2-locations--id-" value="26440" data-component="url">
<br>
<p>The ID of the location. Example: <code>26440</code></p>
</div>
</form><form id="form-POSTv2-locations" data-method="POST" data-path="v2/locations" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTv2-locations', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTv2-locations" onclick="tryItOut('POSTv2-locations');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTv2-locations" onclick="cancelTryOut('POSTv2-locations');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTv2-locations" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send
Request 💥 </button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>v2/locations</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="POSTv2-locations" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="POSTv2-locations" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="POSTv2-locations" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>name</code></b> <small>string</small> <input type="text" style="display: none" name="name" data-endpoint="POSTv2-locations" value="fgqcjldslimywuvu" data-component="body">
<br>
<p>Must not be greater than 100 characters. Example: <code>fgqcjldslimywuvu</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>country</code></b> <small>string</small> <input type="text" style="display: none" name="country" data-endpoint="POSTv2-locations" value="fj" data-component="body">
<br>
<p>Must be 2 characters. Example: <code>fj</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>city</code></b> <small>string</small> <input type="text" style="display: none" name="city" data-endpoint="POSTv2-locations" value="jd" data-component="body">
<br>
<p>Must not be greater than 100 characters. Example: <code>jd</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>address</code></b> <small>string</small> <input type="text" style="display: none" name="address" data-endpoint="POSTv2-locations" value="hsbytrpuwxaoq" data-component="body">
<br>
<p>Must not be greater than 255 characters. Example: <code>hsbytrpuwxaoq</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>zip_code</code></b> <small>string</small> <input type="text" style="display: none" name="zip_code" data-endpoint="POSTv2-locations" value="yevxbrw" data-component="body">
<br>
<p>Must not be greater than 20 characters. Example: <code>yevxbrw</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>phone_number</code></b> <small>string</small> <input type="text" style="display: none" name="phone_number" data-endpoint="POSTv2-locations" value="ofcymmuawwwdre" data-component="body">
<br>
<p>Must not be greater than 40 characters. Example: <code>ofcymmuawwwdre</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>email</code></b> <small>string</small> <input type="text" style="display: none" name="email" data-endpoint="POSTv2-locations" value="cgrimes@example.org" data-component="body">
<br>
<p>Must be a valid email address. Must not be greater than 100 characters. Example: <code>cgrimes@example.org</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>manager</code></b> <small>string</small> <input type="text" style="display: none" name="manager" data-endpoint="POSTv2-locations" value="ikaokvl" data-component="body">
<br>
<p>Must not be greater than 255 characters. Example: <code>ikaokvl</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>type</code></b> <small>string</small> <input type="text" style="display: none" name="type" data-endpoint="POSTv2-locations" value="franchise" data-component="body">
<br>
<p>Example: <code>franchise</code></p> Must be one of: <ul style="list-style-type: square;">
<li><code>own</code></li>
<li><code>franchise</code></li>
</ul>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>additional_information</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="additional_information" data-endpoint="POSTv2-locations"
value="typsgiwtntntki" data-component="body">
<br>
<p>Must not be greater than 1024 characters. Example: <code>typsgiwtntntki</code></p>
</div>
</form><form id="form-PATCHv2-locations--id-" data-method="PATCH" data-path="v2/locations/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('PATCHv2-locations--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-PATCHv2-locations--id-" onclick="tryItOut('PATCHv2-locations--id-');">Try it out ⚡
</button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-PATCHv2-locations--id-" onclick="cancelTryOut('PATCHv2-locations--id-');" hidden="">Cancel 🛑
</button> <button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-PATCHv2-locations--id-" data-initial-text="Send Request 💥"
data-loading-text="⏱ Sending..." hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-purple">PATCH</small>
<b><code>v2/locations/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="PATCHv2-locations--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="PATCHv2-locations--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="PATCHv2-locations--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="PATCHv2-locations--id-" value="26440" data-component="url">
<br>
<p>The ID of the location. Example: <code>26440</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>name</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="name" data-endpoint="PATCHv2-locations--id-" value="lwtcjhtnytmgvjtb"
data-component="body">
<br>
<p>Must not be greater than 100 characters. Example: <code>lwtcjhtnytmgvjtb</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>country</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="country" data-endpoint="PATCHv2-locations--id-" value="ul" data-component="body">
<br>
<p>Must be 2 characters. Example: <code>ul</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>city</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="city" data-endpoint="PATCHv2-locations--id-" value="qnaxypynigkmerb"
data-component="body">
<br>
<p>Must not be greater than 100 characters. Example: <code>qnaxypynigkmerb</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>address</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="address" data-endpoint="PATCHv2-locations--id-" value="la" data-component="body">
<br>
<p>Must not be greater than 255 characters. Example: <code>la</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>zip_code</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="zip_code" data-endpoint="PATCHv2-locations--id-" value="ae" data-component="body">
<br>
<p>Must not be greater than 20 characters. Example: <code>ae</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>phone_number</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="phone_number" data-endpoint="PATCHv2-locations--id-" value="bojb"
data-component="body">
<br>
<p>Must not be greater than 40 characters. Example: <code>bojb</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>email</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="email" data-endpoint="PATCHv2-locations--id-" value="feil.fredy@example.com"
data-component="body">
<br>
<p>Must be a valid email address. Must not be greater than 100 characters. Example: <code>feil.fredy@example.com</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>manager</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="manager" data-endpoint="PATCHv2-locations--id-" value="rofhbnafzbdyft"
data-component="body">
<br>
<p>Must not be greater than 255 characters. Example: <code>rofhbnafzbdyft</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>additional_information</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="additional_information" data-endpoint="PATCHv2-locations--id-"
value="zhmmcdnjsulunypvmxzddxisf" data-component="body">
<br>
<p>Must not be greater than 1024 characters. Example: <code>zhmmcdnjsulunypvmxzddxisf</code></p>
</div>
</form><form id="form-DELETEv2-locations--id-" data-method="DELETE" data-path="v2/locations/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('DELETEv2-locations--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-DELETEv2-locations--id-" onclick="tryItOut('DELETEv2-locations--id-');">Try it out ⚡
</button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-DELETEv2-locations--id-" onclick="cancelTryOut('DELETEv2-locations--id-');" hidden="">Cancel 🛑
</button> <button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-DELETEv2-locations--id-" data-initial-text="Send Request 💥"
data-loading-text="⏱ Sending..." hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-red">DELETE</small>
<b><code>v2/locations/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="DELETEv2-locations--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="DELETEv2-locations--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="DELETEv2-locations--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="DELETEv2-locations--id-" value="26440" data-component="url">
<br>
<p>The ID of the location. Example: <code>26440</code></p>
</div>
</form><form id="form-GETv2-zones" data-method="GET" data-path="v2/zones" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-zones', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-zones" onclick="tryItOut('GETv2-zones');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-zones" onclick="cancelTryOut('GETv2-zones');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-zones" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send Request 💥
</button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/zones</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-zones" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-zones" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-zones" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="page" data-endpoint="GETv2-zones" value="1" data-component="query">
<br>
<p>The page requested. Default to 1. Example: <code>1</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>per_page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="per_page" data-endpoint="GETv2-zones" value="100"
data-component="query">
<br>
<p>The number of items per page. Default to 25. Example: <code>100</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>order_by</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="order_by" data-endpoint="GETv2-zones" value="name" data-component="query">
<br>
<p>The field to order the results by. Default to id. Example: <code>name</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>direction</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="direction" data-endpoint="GETv2-zones" value="desc" data-component="query">
<br>
<p>The direction method to sort results. Default to asc. Example: <code>desc</code></p>
</div>
</form><form id="form-GETv2-zones--id-" data-method="GET" data-path="v2/zones/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-zones--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-zones--id-" onclick="tryItOut('GETv2-zones--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-zones--id-" onclick="cancelTryOut('GETv2-zones--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-zones--id-" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send
Request 💥 </button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/zones/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-zones--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-zones--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-zones--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="GETv2-zones--id-" value="17351" data-component="url">
<br>
<p>The ID of the zone. Example: <code>17351</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="page" data-endpoint="GETv2-zones--id-" value="1" data-component="query">
<br>
<p>The page requested. Default to 1. Example: <code>1</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>per_page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="per_page" data-endpoint="GETv2-zones--id-" value="100"
data-component="query">
<br>
<p>The number of items per page. Default to 25. Example: <code>100</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>order_by</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="order_by" data-endpoint="GETv2-zones--id-" value="name" data-component="query">
<br>
<p>The field to order the results by. Default to id. Example: <code>name</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>direction</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="direction" data-endpoint="GETv2-zones--id-" value="desc" data-component="query">
<br>
<p>The direction method to sort results. Default to asc. Example: <code>desc</code></p>
</div>
</form><form id="form-POSTv2-zones" data-method="POST" data-path="v2/zones" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTv2-zones', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTv2-zones" onclick="tryItOut('POSTv2-zones');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTv2-zones" onclick="cancelTryOut('POSTv2-zones');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTv2-zones" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send Request 💥
</button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>v2/zones</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="POSTv2-zones" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="POSTv2-zones" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="POSTv2-zones" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>name</code></b> <small>string</small> <input type="text" style="display: none" name="name" data-endpoint="POSTv2-zones" value="emuxwzyzvfjapfrgjcijdum" data-component="body">
<br>
<p>Must not be greater than 255 characters. Example: <code>emuxwzyzvfjapfrgjcijdum</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>normalization_type</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="normalization_type" data-endpoint="POSTv2-zones" value="2020"
data-component="body">
<br>
<p>Example: <code>2020</code></p> Must be one of: <ul style="list-style-type: square;">
<li><code>default</code></li>
<li><code>2020</code></li>
<li><code>2021</code></li>
</ul>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>acknowledgement</code></b> <small>boolean</small> <label data-endpoint="POSTv2-zones" style="display: none">
<input type="radio" name="acknowledgement" value="true" data-endpoint="POSTv2-zones" data-component="body">
<code>true</code>
</label>
<label data-endpoint="POSTv2-zones" style="display: none">
<input type="radio" name="acknowledgement" value="false" data-endpoint="POSTv2-zones" data-component="body">
<code>false</code>
</label>
<br>
<p>Example: <code>false</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>account_id</code></b> <small>string</small> <input type="text" style="display: none" name="account_id" data-endpoint="POSTv2-zones" value="officiis" data-component="body">
<br>
<p>Example: <code>officiis</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>fudo_integration_id</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="fudo_integration_id" data-endpoint="POSTv2-zones" value="pbmfewglca"
data-component="body">
<br>
<p>Must not be greater than 20 characters. Example: <code>pbmfewglca</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>store_id</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store_id" data-endpoint="POSTv2-zones" value="" data-component="body">
<br>
<p>This field is required when <code>store</code> is not present.</p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<details>
<summary style="padding-bottom: 10px;">
<b style="line-height: 2;"><code>store</code></b> <small>object</small> <i>optional</i> <br>
<p>This field is required when <code>store_id</code> is not present.</p>
</summary>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>account_id</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.account_id" data-endpoint="POSTv2-zones" value=""
data-component="body">
<br>
<p>This field is required when <code>store_id</code> is not present.</p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>name</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.name" data-endpoint="POSTv2-zones" value="bquboyaonmutzbiohb"
data-component="body">
<br>
<p>This field is required when <code>store_id</code> is not present. Must not be greater than 100 characters. Example: <code>bquboyaonmutzbiohb</code></p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>country</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.country" data-endpoint="POSTv2-zones" value="on" data-component="body">
<br>
<p>This field is required when <code>store_id</code> is not present. Must be 2 characters. Example: <code>on</code></p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>type</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.type" data-endpoint="POSTv2-zones" value="franchise" data-component="body">
<br>
<p>This field is required when <code>store_id</code> is not present. Example: <code>franchise</code></p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>address</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.address" data-endpoint="POSTv2-zones" value="zdiuvhwvnhohammz"
data-component="body">
<br>
<p>Must not be greater than 255 characters. Example: <code>zdiuvhwvnhohammz</code></p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>phone_number</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.phone_number" data-endpoint="POSTv2-zones"
value="yiafjnnstbwqmyebzraa" data-component="body">
<br>
<p>Must not be greater than 40 characters. Example: <code>yiafjnnstbwqmyebzraa</code></p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>email</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.email" data-endpoint="POSTv2-zones" value="kathryn.terry@example.com"
data-component="body">
<br>
<p>Must be a valid email address. Must not be greater than 100 characters. Example: <code>kathryn.terry@example.com</code></p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>manager</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.manager" data-endpoint="POSTv2-zones" value="zjcxeldnvlgziwgujcykllfw"
data-component="body">
<br>
<p>Must not be greater than 255 characters. Example: <code>zjcxeldnvlgziwgujcykllfw</code>
</p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>timezone</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.timezone" data-endpoint="POSTv2-zones" value="Europe/Oslo"
data-component="body">
<br>
<p>Example: <code>Europe/Oslo</code></p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>city</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.city" data-endpoint="POSTv2-zones" value="fueomxvia" data-component="body">
<br>
<p>Must not be greater than 100 characters. Example: <code>fueomxvia</code></p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>zip_code</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.zip_code" data-endpoint="POSTv2-zones" value="ssmko"
data-component="body">
<br>
<p>Must not be greater than 20 characters. Example: <code>ssmko</code></p>
</div>
<div style="margin-left: 14px; clear: unset;">
<b style="line-height: 2;"><code>additional_information</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="store.additional_information" data-endpoint="POSTv2-zones"
value="znzuo" data-component="body">
<br>
<p>Must not be greater than 1024 characters. Example: <code>znzuo</code></p>
</div>
</details>
</div>
<div style=" padding-left: 28px; clear: unset;">
<details>
<summary style="padding-bottom: 10px;">
<b style="line-height: 2;"><code>box</code></b> <small>object</small> <i>optional</i> <br>
</summary>
<div style=" margin-left: 14px; clear: unset;">
<details>
<summary style="padding-bottom: 10px;">
<b style="line-height: 2;"><code>recipient</code></b> <small>object</small> <i>optional</i> <br>
<p>This field is required when <code>box</code> is present.</p>
</summary>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>name</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.recipient.name" data-endpoint="POSTv2-zones" value="evwppxzz"
data-component="body">
<br>
<p>This field is required when <code>box</code> is present. Must be at least 3 characters. Must not be greater than 100 characters. Example: <code>evwppxzz</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>address</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.recipient.address" data-endpoint="POSTv2-zones"
value="flejgjwmxracubjoidgt" data-component="body">
<br>
<p>This field is required when <code>box</code> is present. Must be at least 6 characters. Must not be greater than 255 characters. Example: <code>flejgjwmxracubjoidgt</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>city</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.recipient.city" data-endpoint="POSTv2-zones" value="ikmvmgykrmnw"
data-component="body">
<br>
<p>This field is required when <code>box</code> is present. Must be at least 6 characters. Must not be greater than 100 characters. Example: <code>ikmvmgykrmnw</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>zip_code</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.recipient.zip_code" data-endpoint="POSTv2-zones" value="wtkwno"
data-component="body">
<br>
<p>This field is required when <code>box</code> is present. Must be at least 3 characters. Must not be greater than 20 characters. Example: <code>wtkwno</code>
</p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>identification_type</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.recipient.identification_type" data-endpoint="POSTv2-zones"
value="DNI" data-component="body">
<br>
<p>This field is required when <code>box</code> is present. Example: <code>DNI</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>identification_number</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.recipient.identification_number"
data-endpoint="POSTv2-zones" value="egafvljuhjulbj" data-component="body">
<br>
<p>This field is required when <code>box</code> is present. Must be at least 4 characters. Must not be greater than 20 characters. Example: <code>egafvljuhjulbj</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>phone</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.recipient.phone" data-endpoint="POSTv2-zones" value="ouhftqcifgxumyotlkok"
data-component="body">
<br>
<p>This field is required when <code>box</code> is present. Must be at least 8 characters. Must not be greater than 40 characters. Example: <code>ouhftqcifgxumyotlkok</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>additional_information</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.recipient.additional_information"
data-endpoint="POSTv2-zones" value="uusfdasjhmclntcpzubt" data-component="body">
<br>
<p>Must not be greater than 1024 characters. Example: <code>uusfdasjhmclntcpzubt</code></p>
</div>
</details>
</div>
<div style=" margin-left: 14px; clear: unset;">
<details>
<summary style="padding-bottom: 10px;">
<b style="line-height: 2;"><code>connection_settings</code></b> <small>object</small> <i>optional</i> <br>
<p>This field is required when <code>box</code> is present.</p>
</summary>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>connection_type</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.connection_type"
data-endpoint="POSTv2-zones" value="WIFI" data-component="body">
<br>
<p>This field is required when <code>box</code> is present. Example: <code>WIFI</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>network</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.network" data-endpoint="POSTv2-zones" value="qf"
data-component="body">
<br>
<p>This field is required when <code>box.connection_settings.connection_type</code> is <code>WIFI</code>. Must not be greater than 255 characters. Example: <code>qf</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>password</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.password" data-endpoint="POSTv2-zones"
value="_R_&FZ8`" data-component="body">
<br>
<p>This field is required when <code>box.connection_settings.connection_type</code> is <code>WIFI</code>. Must not be greater than 255 characters. Example: `<em>R</em>&FZ8``</p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>type_of_network</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.type_of_network"
data-endpoint="POSTv2-zones" value="WPA2" data-component="body">
<br>
<p>This field is required when <code>box.connection_settings.connection_type</code> is <code>WIFI</code>. Example: <code>WPA2</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>ip_protocol_assignment</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.ip_protocol_assignment"
data-endpoint="POSTv2-zones" value="Static" data-component="body">
<br>
<p>This field is required when <code>box.connection_settings.connection_type</code> is <code>WIFI</code>. Example: <code>Static</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>ip_address</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.ip_address" data-endpoint="POSTv2-zones" value=""
data-component="body">
<br>
<p>This field is required when <code>box.connection_settings.ip_protocol_assignment</code> is <code>Static</code>.</p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>dns_1</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.dns_1" data-endpoint="POSTv2-zones" value=""
data-component="body">
<br>
<p>This field is required when <code>box.connection_settings.ip_protocol_assignment</code> is <code>Static</code>.</p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>dns_2</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.dns_2" data-endpoint="POSTv2-zones" value=""
data-component="body">
<br>
<p>This field is required when <code>box.connection_settings.ip_protocol_assignment</code> is <code>Static</code>.</p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>netmask</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.netmask" data-endpoint="POSTv2-zones" value=""
data-component="body">
<br>
<p>This field is required when <code>box.connection_settings.ip_protocol_assignment</code> is <code>Static</code>.</p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>gateway</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.gateway" data-endpoint="POSTv2-zones" value=""
data-component="body">
<br>
<p>This field is required when <code>box.connection_settings.ip_protocol_assignment</code> is <code>Static</code>.</p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>ntp_address</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.ntp_address" data-endpoint="POSTv2-zones"
value="maxime" data-component="body">
<br>
<p>Example: <code>maxime</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>proxy_address</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.proxy_address" data-endpoint="POSTv2-zones"
value="et" data-component="body">
<br>
<p>This field is required when <code>proxy_port</code> is present. Example: <code>et</code></p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>proxy_port</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.proxy_port" data-endpoint="POSTv2-zones" value=""
data-component="body">
<br>
<p>This field is required when <code>proxy_address</code> is present.</p>
</div>
<div style="margin-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>additional_information</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="box.connection_settings.additional_information"
data-endpoint="POSTv2-zones" value="ars" data-component="body">
<br>
<p>Must not be greater than 1024 characters. Example: <code>ars</code></p>
</div>
</details>
</div>
</details>
</div>
</form><form id="form-PATCHv2-zones--id-" data-method="PATCH" data-path="v2/zones/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('PATCHv2-zones--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-PATCHv2-zones--id-" onclick="tryItOut('PATCHv2-zones--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-PATCHv2-zones--id-" onclick="cancelTryOut('PATCHv2-zones--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-PATCHv2-zones--id-" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send
Request 💥 </button>
</h3>
<p>
<small class="badge badge-purple">PATCH</small>
<b><code>v2/zones/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="PATCHv2-zones--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="PATCHv2-zones--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="PATCHv2-zones--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="PATCHv2-zones--id-" value="17351" data-component="url">
<br>
<p>The ID of the zone. Example: <code>17351</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>name</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="name" data-endpoint="PATCHv2-zones--id-" value="zehtwfoagwwdhlsdmpsgx"
data-component="body">
<br>
<p>Must not be greater than 255 characters. Example: <code>zehtwfoagwwdhlsdmpsgx</code></p>
</div>
</form><form id="form-DELETEv2-zones--id-" data-method="DELETE" data-path="v2/zones/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('DELETEv2-zones--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-DELETEv2-zones--id-" onclick="tryItOut('DELETEv2-zones--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-DELETEv2-zones--id-" onclick="cancelTryOut('DELETEv2-zones--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-DELETEv2-zones--id-" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send
Request 💥 </button>
</h3>
<p>
<small class="badge badge-red">DELETE</small>
<b><code>v2/zones/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="DELETEv2-zones--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="DELETEv2-zones--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="DELETEv2-zones--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="DELETEv2-zones--id-" value="17351" data-component="url">
<br>
<p>The ID of the zone. Example: <code>17351</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>reason</code></b> <small>string</small> <input type="text" style="display: none" name="reason" data-endpoint="DELETEv2-zones--id-" value="STORE_CLOSED" data-component="body">
<br>
<p>Example: <code>STORE_CLOSED</code></p> Must be one of: <ul style="list-style-type: square;">
<li><code>STORE_CLOSED</code></li>
<li><code>TECHNICAL_ISSUES</code></li>
<li><code>MUSICAL_DECISION</code></li>
</ul>
</div>
</form><form id="form-GETv2-groups" data-method="GET" data-path="v2/groups" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-groups', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-groups" onclick="tryItOut('GETv2-groups');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-groups" onclick="cancelTryOut('GETv2-groups');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-groups" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send Request 💥
</button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/groups</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-groups" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-groups" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-groups" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="page" data-endpoint="GETv2-groups" value="1" data-component="query">
<br>
<p>The page requested. Default to 1. Example: <code>1</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>per_page</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="per_page" data-endpoint="GETv2-groups" value="100"
data-component="query">
<br>
<p>The number of items per page. Default to 25. Example: <code>100</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>order_by</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="order_by" data-endpoint="GETv2-groups" value="name" data-component="query">
<br>
<p>The field to order the results by. Default to id. Example: <code>name</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>direction</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="direction" data-endpoint="GETv2-groups" value="desc" data-component="query">
<br>
<p>The direction method to sort results. Default to asc. Example: <code>desc</code></p>
</div>
</form><form id="form-GETv2-groups--id-" data-method="GET" data-path="v2/groups/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-groups--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-groups--id-" onclick="tryItOut('GETv2-groups--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-groups--id-" onclick="cancelTryOut('GETv2-groups--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-groups--id-" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send
Request 💥 </button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/groups/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-groups--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-groups--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-groups--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="GETv2-groups--id-" value="17351" data-component="url">
<br>
<p>The ID of the group. Example: <code>17351</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>include</code></b> <small>string</small> <i>optional</i> <input type="text" style="display: none" name="include" data-endpoint="GETv2-groups--id-" value="announcements,mixes"
data-component="query">
<br>
<p>Any relation to be included, separated by commas. You can use: announcements, mixes, account. Example: <code>announcements,mixes</code></p>
</div>
</form><form id="form-POSTv2-groups" data-method="POST" data-path="v2/groups" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('POSTv2-groups', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-POSTv2-groups" onclick="tryItOut('POSTv2-groups');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-POSTv2-groups" onclick="cancelTryOut('POSTv2-groups');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-POSTv2-groups" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send Request 💥
</button>
</h3>
<p>
<small class="badge badge-black">POST</small>
<b><code>v2/groups</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="POSTv2-groups" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="POSTv2-groups" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="POSTv2-groups" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>account_id</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="account_id" data-endpoint="POSTv2-groups" value="8"
data-component="body">
<br>
<p>Example: <code>8</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>music_profile_id</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="music_profile_id" data-endpoint="POSTv2-groups" value="18"
data-component="body">
<br>
<p>Example: <code>18</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>name</code></b> <small>string</small> <input type="text" style="display: none" name="name" data-endpoint="POSTv2-groups" value="mollitia" data-component="body">
<br>
<p>Example: <code>mollitia</code></p>
</div>
</form><form id="form-PATCHv2-groups--id-" data-method="PATCH" data-path="v2/groups/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('PATCHv2-groups--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-PATCHv2-groups--id-" onclick="tryItOut('PATCHv2-groups--id-');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-PATCHv2-groups--id-" onclick="cancelTryOut('PATCHv2-groups--id-');" hidden="">Cancel 🛑 </button>
<button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-PATCHv2-groups--id-" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send
Request 💥 </button>
</h3>
<p>
<small class="badge badge-purple">PATCH</small>
<b><code>v2/groups/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="PATCHv2-groups--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="PATCHv2-groups--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="PATCHv2-groups--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="PATCHv2-groups--id-" value="17351" data-component="url">
<br>
<p>The ID of the group. Example: <code>17351</code></p>
</div>
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>account_id</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="account_id" data-endpoint="PATCHv2-groups--id-" value="8"
data-component="body">
<br>
<p>Example: <code>8</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>music_profile_id</code></b> <small>integer</small> <i>optional</i> <input type="number" style="display: none" step="any" name="music_profile_id" data-endpoint="PATCHv2-groups--id-"
value="6" data-component="body">
<br>
<p>Example: <code>6</code></p>
</div>
<div style=" padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>name</code></b> <small>string</small> <input type="text" style="display: none" name="name" data-endpoint="PATCHv2-groups--id-" value="libero" data-component="body">
<br>
<p>Example: <code>libero</code></p>
</div>
</form><form id="form-DELETEv2-groups--id-" data-method="DELETE" data-path="v2/groups/{id}" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('DELETEv2-groups--id-', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-DELETEv2-groups--id-" onclick="tryItOut('DELETEv2-groups--id-');">Try it out ⚡
</button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-DELETEv2-groups--id-" onclick="cancelTryOut('DELETEv2-groups--id-');" hidden="">Cancel 🛑
</button> <button type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-DELETEv2-groups--id-" data-initial-text="Send Request 💥"
data-loading-text="⏱ Sending..." hidden="">Send Request 💥 </button>
</h3>
<p>
<small class="badge badge-red">DELETE</small>
<b><code>v2/groups/{id}</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="DELETEv2-groups--id-" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="DELETEv2-groups--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="DELETEv2-groups--id-" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>id</code></b> <small>integer</small> <input type="number" style="display: none" step="any" name="id" data-endpoint="DELETEv2-groups--id-" value="17351" data-component="url">
<br>
<p>The ID of the group. Example: <code>17351</code></p>
</div>
</form><form id="form-GETv2-roles" data-method="GET" data-path="v2/roles" data-authed="1" data-hasfiles="0" data-isarraybody="0" autocomplete="off" onsubmit="event.preventDefault(); executeTryOut('GETv2-roles', this);">
<h3> Request <button type="button" style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-tryout-GETv2-roles" onclick="tryItOut('GETv2-roles');">Try it out ⚡ </button>
<button type="button" style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-canceltryout-GETv2-roles" onclick="cancelTryOut('GETv2-roles');" hidden="">Cancel 🛑 </button> <button
type="submit" style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" id="btn-executetryout-GETv2-roles" data-initial-text="Send Request 💥" data-loading-text="⏱ Sending..." hidden="">Send Request 💥
</button>
</h3>
<p>
<small class="badge badge-green">GET</small>
<b><code>v2/roles</code></b>
</p>
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>x-customer-api-key</code></b> <input type="text" style="display: none" name="x-customer-api-key" class="auth-value" data-endpoint="GETv2-roles" value="{YOUR_AUTH_KEY}"
data-component="header">
<br>
<p>Example: <code>{YOUR_AUTH_KEY}</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Content-Type</code></b> <input type="text" style="display: none" name="Content-Type" data-endpoint="GETv2-roles" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
<div style="padding-left: 28px; clear: unset;">
<b style="line-height: 2;"><code>Accept</code></b> <input type="text" style="display: none" name="Accept" data-endpoint="GETv2-roles" value="application/json" data-component="header">
<br>
<p>Example: <code>application/json</code></p>
</div>
</form>Text Content
MENU
bash php
* Introduction
* Authenticating requests
* Accounts
* List accounts
* Get an account by its ID
* Update an account
* Subscriptions
* List subscriptions
* Get a subscription by its ID
* Users
* List users
* Get a user by its ID
* Invites a user to the platform
* Create temporary auth token
* Locations
* List locations
* Return a location by its ID
* Create a location
* Update a location
* Delete a location
* Zones
* List zones
* Return a zone by its ID
* Create a zone
* Update a zone
* Delete a zone
* Groups
* List groups
* Get a group by its ID
* Create a new group
* Update a group
* Delete a group
* Roles
* List all roles
* View Postman collection
* View OpenAPI spec
* Documentation powered by Scribe ✍
* Last updated: August 2, 2024
INTRODUCTION
This is the official documentation for the Brandtrack API.
Base URL: https://api.brandtrack.fm
This documentation aims to provide all the information you need to work with our
API.
As you scroll, you'll see code examples for working with the API in different
programming languages in the dark area to the right (or as part of the content
on mobile). You can switch the language used with the tabs at the top right (or
from the nav menu at the top left on mobile).
AUTHENTICATING REQUESTS
To authenticate requests, include a x-customer-api-key header with the value
"{YOUR_AUTH_KEY}".
All authenticated endpoints are marked with a requires authentication badge in
the documentation below.
If are not sure about how to get your token feel free to contact our team.
ACCOUNTS
LIST ACCOUNTS
requires authentication
Return a paginated list of accounts available for the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/accounts?page=1&per_page=100&order_by=name&direction=desc" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/accounts';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'per_page' => '100',
'order_by' => 'name',
'direction' => 'desc',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": [
{
"id": 19120,
"name": "John's Bakery US",
"country": "US",
"source": null
},
{
"id": 19121,
"name": "John's Bakery CA",
"country": "CA",
"source": null
},
{
"id": 19118,
"name": "John's Bakery",
"country": "BE",
"source": "Inbound"
}
],
"meta": {
"pagination": {
"total": 3,
"count": 3,
"per_page": 100,
"current_page": 1,
"total_pages": 1,
"links": []
}
}
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/accounts
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
QUERY PARAMETERS
page integer optional
The page requested. Default to 1. Example: 1
per_page integer optional
The number of items per page. Default to 25. Example: 100
order_by string optional
The field to order the results by. Default to id. Example: name
direction string optional
The direction method to sort results. Default to asc. Example: desc
GET AN ACCOUNT BY ITS ID
requires authentication
Return a single account by its ID, if available to the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/accounts/19120?using_account_id=0" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/accounts/19120';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'using_account_id' => '0',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": {
"id": 19120,
"name": "John's Bakery US",
"country": "US",
"source": null
}
}
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/accounts/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the account. Example: 19120
QUERY PARAMETERS
using_account_id integer optional
Set this ID to filter records only to this particular account. By not providing
anything, results from all accounts will be returned. Default to null. Example:
0
UPDATE AN ACCOUNT
requires authentication
Only values provided in the request will be updated.
> Example request:
curl --request PATCH \
"https://api.brandtrack.fm/v2/accounts/19120" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"ly\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/accounts/19120';
$response = $client->patch(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'ly',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200, Success):
{
"data": {
"id": 19120,
"name": "John's Bakery US",
"country": "US",
"source": null
}
}
> Example response (403, Wrong ID):
{
"message": "This action is unauthorized.",
"status_code": 403
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
PATCH v2/accounts/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the account. Example: 19120
BODY PARAMETERS
name string optional
Must not be greater than 100 characters. Example: ly
SUBSCRIPTIONS
LIST SUBSCRIPTIONS
requires authentication
Return a paginated list of subscriptions available for the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/subscriptions?page=1&per_page=100&order_by=name&direction=desc" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/subscriptions';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'per_page' => '100',
'order_by' => 'name',
'direction' => 'desc',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": [
{
"id": 5393,
"account_id": 19118,
"plan_id": 2,
"start_at": "2024-07-31T14:50:30+00:00",
"end_at": null,
"trial_start_at": null,
"trial_end_at": null,
"first_billing_at": null,
"next_billing_at": null,
"period_cycle": "monthly_1",
"currency": "USD",
"status": "active",
"total": 30,
"created_at": "2024-07-31T14:50:32+00:00"
},
{
"id": 5392,
"account_id": 19120,
"plan_id": 2,
"start_at": "2024-07-31T14:50:08+00:00",
"end_at": null,
"trial_start_at": null,
"trial_end_at": null,
"first_billing_at": null,
"next_billing_at": null,
"period_cycle": "monthly_1",
"currency": "USD",
"status": "active",
"total": 15,
"created_at": "2024-07-31T14:50:09+00:00"
}
],
"meta": {
"pagination": {
"total": 2,
"count": 2,
"per_page": 100,
"current_page": 1,
"total_pages": 1,
"links": []
}
}
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/subscriptions
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
QUERY PARAMETERS
page integer optional
The page requested. Default to 1. Example: 1
per_page integer optional
The number of items per page. Default to 25. Example: 100
order_by string optional
The field to order the results by. Default to id. Example: name
direction string optional
The direction method to sort results. Default to asc. Example: desc
GET A SUBSCRIPTION BY ITS ID
requires authentication
Return a single subscription by its ID, if available to the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/subscriptions/5392?using_account_id=0" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/subscriptions/5392';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'using_account_id' => '0',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": {
"id": 5392,
"account_id": 19120,
"plan_id": 2,
"start_at": "2024-07-31T14:50:08+00:00",
"end_at": null,
"trial_start_at": null,
"trial_end_at": null,
"first_billing_at": null,
"next_billing_at": null,
"period_cycle": "monthly_1",
"currency": "USD",
"status": "active",
"total": 15,
"created_at": "2024-07-31T14:50:09+00:00"
}
}
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/subscriptions/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the subscription. Example: 5392
QUERY PARAMETERS
using_account_id integer optional
Set this ID to filter records only to this particular account. By not providing
anything, results from all accounts will be returned. Default to null. Example:
0
USERS
LIST USERS
requires authentication
Return a paginated list of users available for the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/users?page=1&per_page=100&order_by=name&direction=desc" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/users';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'per_page' => '100',
'order_by' => 'name',
'direction' => 'desc',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": [
{
"id": 18782,
"uuid": "e66f37fd-ac0a-4cb6-adba-33196a5c6f3e",
"email": "john.doe@brandtrack.fm",
"firstname": "John",
"lastname": "Doe",
"phone_number": "+9332312323",
"country": "BE",
"role": "owner",
"business_category_id": 62,
"flags": [],
"created_at": "2024-07-09T13:34:16+00:00"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 100,
"current_page": 1,
"total_pages": 1,
"links": []
}
}
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/users
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
QUERY PARAMETERS
page integer optional
The page requested. Default to 1. Example: 1
per_page integer optional
The number of items per page. Default to 25. Example: 100
order_by string optional
The field to order the results by. Default to id. Example: name
direction string optional
The direction method to sort results. Default to asc. Example: desc
GET A USER BY ITS ID
requires authentication
Return a single user by its ID, if available to the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/users/18782?page=1&per_page=100&order_by=name&direction=desc" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/users/18782';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'per_page' => '100',
'order_by' => 'name',
'direction' => 'desc',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": {
"id": 18782,
"uuid": "e66f37fd-ac0a-4cb6-adba-33196a5c6f3e",
"email": "john.doe@brandtrack.fm",
"firstname": "John",
"lastname": "Doe",
"phone_number": "+9332312323",
"country": "BE",
"role": "owner",
"business_category_id": 62,
"flags": [],
"created_at": "2024-07-09T13:34:16+00:00"
}
}
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/users/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the user. Example: 18782
QUERY PARAMETERS
page integer optional
The page requested. Default to 1. Example: 1
per_page integer optional
The number of items per page. Default to 25. Example: 100
order_by string optional
The field to order the results by. Default to id. Example: name
direction string optional
The direction method to sort results. Default to asc. Example: desc
INVITES A USER TO THE PLATFORM
requires authentication
It will send automatically an email to the provided email address with a unique
link to setup the user's account.
> Example request:
curl --request POST \
"https://api.brandtrack.fm/v2/users" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"account_id\": 19120,
\"email\": \"testexample@example.com\",
\"firstname\": \"John\",
\"lastname\": \"Doe\",
\"role_id\": 74
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/users';
$response = $client->post(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'account_id' => 19120,
'email' => 'testexample@example.com',
'firstname' => 'John',
'lastname' => 'Doe',
'role_id' => 74,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200, Success):
{
"data": {
"id": 18782,
"uuid": "e66f37fd-ac0a-4cb6-adba-33196a5c6f3e",
"email": "john.doe@brandtrack.fm",
"firstname": "John",
"lastname": "Doe",
"phone_number": "+9332312323",
"country": "BE",
"role": "owner",
"business_category_id": 62,
"flags": [],
"created_at": "2024-07-09T13:34:16+00:00"
}
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST v2/users
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
BODY PARAMETERS
account_id integer
The account where this user will be created. Example: 19120
email string
The email to be registered. Example: testexample@example.com
firstname string
User's firstname. Example: John
lastname string
User's lastname. Example: Doe
role_id integer
The role to assign to the new user. Example: 74
CREATE TEMPORARY AUTH TOKEN
requires authentication
Create a one-time token that allows to access to the account by opening the link
provided. It lasts only 1 hour and any attempting to use this token after 1 hour
will result in a 401 Unauthorized response.
> Example request:
curl --request POST \
"https://api.brandtrack.fm/v2/users/18782/token?page=1&per_page=100&order_by=name&direction=desc" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/users/18782/token';
$response = $client->post(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'per_page' => '100',
'order_by' => 'name',
'direction' => 'desc',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200, Sucess):
{
"data": {
"user_id": 123456,
"token": "kz1OrilDejZlzpId2kuxwu91LYdlzi2B",
"created_at": "2024-08-01T16:03:50Z",
"expires_at": "2024-08-01T17:03:50Z",
"url": "https://api.brandtrack.fm/login/token/kz1OrilDejZlzpId2kuxwu91LYdlzi2B",
"requested_by": 7303
}
}
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST v2/users/{id}/token
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the user. Example: 18782
QUERY PARAMETERS
page integer optional
The page requested. Default to 1. Example: 1
per_page integer optional
The number of items per page. Default to 25. Example: 100
order_by string optional
The field to order the results by. Default to id. Example: name
direction string optional
The direction method to sort results. Default to asc. Example: desc
LOCATIONS
LIST LOCATIONS
requires authentication
Return a paginated list of groups available for the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/locations?page=1&per_page=100&order_by=name&direction=desc" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/locations';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'per_page' => '100',
'order_by' => 'name',
'direction' => 'desc',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": [
{
"id": 26440,
"account_id": 19120,
"name": "Downtown Bakery",
"country": "US",
"address": "176 Berry St, Brooklyn",
"phone_number": "11002929",
"email": "john.doe@brandtrack.fm",
"manager": "John Doe",
"created_at": "2024-07-31T14:38:34+00:00",
"timezone": "America/Los_Angeles",
"type": "own",
"city": "New York",
"zip_code": "11249",
"additional_information": null
},
{
"id": 26441,
"account_id": 19121,
"name": "Default SM",
"country": "CA",
"address": null,
"phone_number": null,
"email": null,
"manager": null,
"created_at": "2024-07-31T14:39:07+00:00",
"timezone": "7303",
"type": "own",
"city": null,
"zip_code": null,
"additional_information": null
}
],
"meta": {
"pagination": {
"total": 2,
"count": 2,
"per_page": 100,
"current_page": 1,
"total_pages": 1,
"links": []
}
}
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/locations
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
QUERY PARAMETERS
page integer optional
The page requested. Default to 1. Example: 1
per_page integer optional
The number of items per page. Default to 25. Example: 100
order_by string optional
The field to order the results by. Default to id. Example: name
direction string optional
The direction method to sort results. Default to asc. Example: desc
RETURN A LOCATION BY ITS ID
requires authentication
Return a single location by its ID, if available to the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/locations/26440" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/locations/26440';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": {
"id": 26440,
"account_id": 19120,
"name": "Downtown Bakery",
"country": "US",
"address": "176 Berry St, Brooklyn",
"phone_number": "11002929",
"email": "john.doe@brandtrack.fm",
"manager": "John Doe",
"created_at": "2024-07-31T14:38:34+00:00",
"timezone": "America/Los_Angeles",
"type": "own",
"city": "New York",
"zip_code": "11249",
"additional_information": null
}
}
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/locations/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the location. Example: 26440
CREATE A LOCATION
requires authentication
This endpoint is designed to by used by My Brandtrack users.
> Example request:
curl --request POST \
"https://api.brandtrack.fm/v2/locations" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"fgqcjldslimywuvu\",
\"country\": \"fj\",
\"city\": \"jd\",
\"address\": \"hsbytrpuwxaoq\",
\"zip_code\": \"yevxbrw\",
\"phone_number\": \"ofcymmuawwwdre\",
\"email\": \"cgrimes@example.org\",
\"manager\": \"ikaokvl\",
\"type\": \"franchise\",
\"additional_information\": \"typsgiwtntntki\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/locations';
$response = $client->post(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'fgqcjldslimywuvu',
'country' => 'fj',
'city' => 'jd',
'address' => 'hsbytrpuwxaoq',
'zip_code' => 'yevxbrw',
'phone_number' => 'ofcymmuawwwdre',
'email' => 'cgrimes@example.org',
'manager' => 'ikaokvl',
'type' => 'franchise',
'additional_information' => 'typsgiwtntntki',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (201, Success):
{
"data": {
"id": 26440,
"account_id": 19120,
"name": "Downtown Bakery",
"country": "US",
"address": "176 Berry St, Brooklyn",
"phone_number": "11002929",
"email": "john.doe@brandtrack.fm",
"manager": "John Doe",
"created_at": "2024-07-31T14:38:34+00:00",
"timezone": "America/Los_Angeles",
"type": "own",
"city": "New York",
"zip_code": "11249",
"additional_information": null
}
}
> Example response (403, Wrong ID):
{
"message": "This action is unauthorized.",
"status_code": 403
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST v2/locations
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
BODY PARAMETERS
name string
Must not be greater than 100 characters. Example: fgqcjldslimywuvu
country string
Must be 2 characters. Example: fj
city string
Must not be greater than 100 characters. Example: jd
address string
Must not be greater than 255 characters. Example: hsbytrpuwxaoq
zip_code string
Must not be greater than 20 characters. Example: yevxbrw
phone_number string
Must not be greater than 40 characters. Example: ofcymmuawwwdre
email string
Must be a valid email address. Must not be greater than 100 characters. Example:
cgrimes@example.org
manager string
Must not be greater than 255 characters. Example: ikaokvl
type string
Example: franchise
Must be one of:
* own
* franchise
additional_information string optional
Must not be greater than 1024 characters. Example: typsgiwtntntki
UPDATE A LOCATION
requires authentication
Only values provided in the request will be updated.
> Example request:
curl --request PATCH \
"https://api.brandtrack.fm/v2/locations/26440" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"lwtcjhtnytmgvjtb\",
\"country\": \"ul\",
\"city\": \"qnaxypynigkmerb\",
\"address\": \"la\",
\"zip_code\": \"ae\",
\"phone_number\": \"bojb\",
\"email\": \"feil.fredy@example.com\",
\"manager\": \"rofhbnafzbdyft\",
\"additional_information\": \"zhmmcdnjsulunypvmxzddxisf\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/locations/26440';
$response = $client->patch(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'lwtcjhtnytmgvjtb',
'country' => 'ul',
'city' => 'qnaxypynigkmerb',
'address' => 'la',
'zip_code' => 'ae',
'phone_number' => 'bojb',
'email' => 'feil.fredy@example.com',
'manager' => 'rofhbnafzbdyft',
'additional_information' => 'zhmmcdnjsulunypvmxzddxisf',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200, Success):
{
"data": {
"id": 26440,
"account_id": 19120,
"name": "Downtown Bakery",
"country": "US",
"address": "176 Berry St, Brooklyn",
"phone_number": "11002929",
"email": "john.doe@brandtrack.fm",
"manager": "John Doe",
"created_at": "2024-07-31T14:38:34+00:00",
"timezone": "America/Los_Angeles",
"type": "own",
"city": "New York",
"zip_code": "11249",
"additional_information": null
}
}
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
PATCH v2/locations/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the location. Example: 26440
BODY PARAMETERS
name string optional
Must not be greater than 100 characters. Example: lwtcjhtnytmgvjtb
country string optional
Must be 2 characters. Example: ul
city string optional
Must not be greater than 100 characters. Example: qnaxypynigkmerb
address string optional
Must not be greater than 255 characters. Example: la
zip_code string optional
Must not be greater than 20 characters. Example: ae
phone_number string optional
Must not be greater than 40 characters. Example: bojb
email string optional
Must be a valid email address. Must not be greater than 100 characters. Example:
feil.fredy@example.com
manager string optional
Must not be greater than 255 characters. Example: rofhbnafzbdyft
additional_information string optional
Must not be greater than 1024 characters. Example: zhmmcdnjsulunypvmxzddxisf
DELETE A LOCATION
requires authentication
Delete a location using the ID. Any location with at least 1 zone related to,
won't be deleted.
> Example request:
curl --request DELETE \
"https://api.brandtrack.fm/v2/locations/26440" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/locations/26440';
$response = $client->delete(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (204, Success):
Empty response
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
DELETE v2/locations/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the location. Example: 26440
ZONES
LIST ZONES
requires authentication
Return a paginated list of zones available for the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/zones?page=1&per_page=100&order_by=name&direction=desc" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/zones';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'per_page' => '100',
'order_by' => 'name',
'direction' => 'desc',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": [
{
"id": 30120,
"account_id": 19120,
"account_name": "John's Bakery US",
"code": "207642",
"uuid": "d1f91b09-f1f9-41d9-ad59-417f6b37766d",
"name": "Downtown Bakery",
"store_id": 26440,
"storage_info": {
"available": null,
"required": null,
"is_critical": false
},
"volume": 100,
"has_volume_change_pending": false,
"send_logs": false,
"reset_state": false,
"fudo_integration_id": null,
"created_at": "2024-07-31T14:53:07+00:00",
"updated_at": "2024-07-31T14:53:07+00:00"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 100,
"current_page": 1,
"total_pages": 1,
"links": []
}
}
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/zones
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
QUERY PARAMETERS
page integer optional
The page requested. Default to 1. Example: 1
per_page integer optional
The number of items per page. Default to 25. Example: 100
order_by string optional
The field to order the results by. Default to id. Example: name
direction string optional
The direction method to sort results. Default to asc. Example: desc
RETURN A ZONE BY ITS ID
requires authentication
Return a single zone by its ID, if available to the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/zones/17351?page=1&per_page=100&order_by=name&direction=desc" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/zones/17351';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'per_page' => '100',
'order_by' => 'name',
'direction' => 'desc',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/zones/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the zone. Example: 17351
QUERY PARAMETERS
page integer optional
The page requested. Default to 1. Example: 1
per_page integer optional
The number of items per page. Default to 25. Example: 100
order_by string optional
The field to order the results by. Default to id. Example: name
direction string optional
The direction method to sort results. Default to asc. Example: desc
CREATE A ZONE
requires authentication
It has an acknowledgement of the creation of the zone. If set to true, the zone
will be created even if it is over the limits of the account and the
subscription will be updated as well. Be aware with it, because you might update
your subscription.
This endpoint might affect your subscription according to the parameters
provided.
> Example request:
curl --request POST \
"https://api.brandtrack.fm/v2/zones" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"emuxwzyzvfjapfrgjcijdum\",
\"normalization_type\": \"2020\",
\"acknowledgement\": false,
\"account_id\": \"officiis\",
\"fudo_integration_id\": \"pbmfewglca\",
\"store\": {
\"name\": \"bquboyaonmutzbiohb\",
\"country\": \"on\",
\"type\": \"franchise\",
\"address\": \"zdiuvhwvnhohammz\",
\"phone_number\": \"yiafjnnstbwqmyebzraa\",
\"email\": \"kathryn.terry@example.com\",
\"manager\": \"zjcxeldnvlgziwgujcykllfw\",
\"timezone\": \"Europe\\/Oslo\",
\"city\": \"fueomxvia\",
\"zip_code\": \"ssmko\",
\"additional_information\": \"znzuo\"
},
\"box\": {
\"recipient\": {
\"name\": \"evwppxzz\",
\"address\": \"flejgjwmxracubjoidgt\",
\"city\": \"ikmvmgykrmnw\",
\"zip_code\": \"wtkwno\",
\"identification_type\": \"DNI\",
\"identification_number\": \"egafvljuhjulbj\",
\"phone\": \"ouhftqcifgxumyotlkok\",
\"additional_information\": \"uusfdasjhmclntcpzubt\"
},
\"connection_settings\": {
\"connection_type\": \"WIFI\",
\"network\": \"qf\",
\"password\": \"_R_&FZ8`\",
\"type_of_network\": \"WPA2\",
\"ip_protocol_assignment\": \"Static\",
\"ntp_address\": \"maxime\",
\"proxy_address\": \"et\",
\"additional_information\": \"ars\"
}
}
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/zones';
$response = $client->post(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'emuxwzyzvfjapfrgjcijdum',
'normalization_type' => '2020',
'acknowledgement' => false,
'account_id' => 'officiis',
'fudo_integration_id' => 'pbmfewglca',
'store' => [
'name' => 'bquboyaonmutzbiohb',
'country' => 'on',
'type' => 'franchise',
'address' => 'zdiuvhwvnhohammz',
'phone_number' => 'yiafjnnstbwqmyebzraa',
'email' => 'kathryn.terry@example.com',
'manager' => 'zjcxeldnvlgziwgujcykllfw',
'timezone' => 'Europe/Oslo',
'city' => 'fueomxvia',
'zip_code' => 'ssmko',
'additional_information' => 'znzuo',
],
'box' => [
'recipient' => [
'name' => 'evwppxzz',
'address' => 'flejgjwmxracubjoidgt',
'city' => 'ikmvmgykrmnw',
'zip_code' => 'wtkwno',
'identification_type' => 'DNI',
'identification_number' => 'egafvljuhjulbj',
'phone' => 'ouhftqcifgxumyotlkok',
'additional_information' => 'uusfdasjhmclntcpzubt',
],
'connection_settings' => [
'connection_type' => 'WIFI',
'network' => 'qf',
'password' => '_R_&FZ8`',
'type_of_network' => 'WPA2',
'ip_protocol_assignment' => 'Static',
'ntp_address' => 'maxime',
'proxy_address' => 'et',
'additional_information' => 'ars',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (201, Success):
{
"data": {
"id": 30120,
"account_id": 19120,
"account_name": "John's Bakery US",
"code": "207642",
"uuid": "d1f91b09-f1f9-41d9-ad59-417f6b37766d",
"name": "Downtown Bakery",
"store_id": 26440,
"storage_info": {
"available": null,
"required": null,
"is_critical": false
},
"volume": 100,
"has_volume_change_pending": false,
"send_logs": false,
"reset_state": false,
"fudo_integration_id": null,
"created_at": "2024-07-31T14:53:07+00:00",
"updated_at": "2024-07-31T14:53:07+00:00"
}
}
> Example response (404, Wrong Store ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST v2/zones
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
BODY PARAMETERS
name string
Must not be greater than 255 characters. Example: emuxwzyzvfjapfrgjcijdum
normalization_type string optional
Example: 2020
Must be one of:
* default
* 2020
* 2021
acknowledgement boolean true false
Example: false
account_id string
Example: officiis
fudo_integration_id string optional
Must not be greater than 20 characters. Example: pbmfewglca
store_id string optional
This field is required when store is not present.
store object optional
This field is required when store_id is not present.
account_id string optional
This field is required when store_id is not present.
name string optional
This field is required when store_id is not present. Must not be greater than
100 characters. Example: bquboyaonmutzbiohb
country string optional
This field is required when store_id is not present. Must be 2 characters.
Example: on
type string optional
This field is required when store_id is not present. Example: franchise
address string optional
Must not be greater than 255 characters. Example: zdiuvhwvnhohammz
phone_number string optional
Must not be greater than 40 characters. Example: yiafjnnstbwqmyebzraa
email string optional
Must be a valid email address. Must not be greater than 100 characters. Example:
kathryn.terry@example.com
manager string optional
Must not be greater than 255 characters. Example: zjcxeldnvlgziwgujcykllfw
timezone string optional
Example: Europe/Oslo
city string optional
Must not be greater than 100 characters. Example: fueomxvia
zip_code string optional
Must not be greater than 20 characters. Example: ssmko
additional_information string optional
Must not be greater than 1024 characters. Example: znzuo
box object optional
recipient object optional
This field is required when box is present.
name string optional
This field is required when box is present. Must be at least 3 characters. Must
not be greater than 100 characters. Example: evwppxzz
address string optional
This field is required when box is present. Must be at least 6 characters. Must
not be greater than 255 characters. Example: flejgjwmxracubjoidgt
city string optional
This field is required when box is present. Must be at least 6 characters. Must
not be greater than 100 characters. Example: ikmvmgykrmnw
zip_code string optional
This field is required when box is present. Must be at least 3 characters. Must
not be greater than 20 characters. Example: wtkwno
identification_type string optional
This field is required when box is present. Example: DNI
identification_number string optional
This field is required when box is present. Must be at least 4 characters. Must
not be greater than 20 characters. Example: egafvljuhjulbj
phone string optional
This field is required when box is present. Must be at least 8 characters. Must
not be greater than 40 characters. Example: ouhftqcifgxumyotlkok
additional_information string optional
Must not be greater than 1024 characters. Example: uusfdasjhmclntcpzubt
connection_settings object optional
This field is required when box is present.
connection_type string optional
This field is required when box is present. Example: WIFI
network string optional
This field is required when box.connection_settings.connection_type is WIFI.
Must not be greater than 255 characters. Example: qf
password string optional
This field is required when box.connection_settings.connection_type is WIFI.
Must not be greater than 255 characters. Example: `R&FZ8``
type_of_network string optional
This field is required when box.connection_settings.connection_type is WIFI.
Example: WPA2
ip_protocol_assignment string optional
This field is required when box.connection_settings.connection_type is WIFI.
Example: Static
ip_address string optional
This field is required when box.connection_settings.ip_protocol_assignment is
Static.
dns_1 string optional
This field is required when box.connection_settings.ip_protocol_assignment is
Static.
dns_2 string optional
This field is required when box.connection_settings.ip_protocol_assignment is
Static.
netmask string optional
This field is required when box.connection_settings.ip_protocol_assignment is
Static.
gateway string optional
This field is required when box.connection_settings.ip_protocol_assignment is
Static.
ntp_address string optional
Example: maxime
proxy_address string optional
This field is required when proxy_port is present. Example: et
proxy_port string optional
This field is required when proxy_address is present.
additional_information string optional
Must not be greater than 1024 characters. Example: ars
UPDATE A ZONE
requires authentication
Only values provided in the request will be updated.
> Example request:
curl --request PATCH \
"https://api.brandtrack.fm/v2/zones/17351" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"zehtwfoagwwdhlsdmpsgx\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/zones/17351';
$response = $client->patch(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'zehtwfoagwwdhlsdmpsgx',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200, Success):
{
"data": {
"id": 30120,
"account_id": 19120,
"account_name": "John's Bakery US",
"code": "207642",
"uuid": "d1f91b09-f1f9-41d9-ad59-417f6b37766d",
"name": "Downtown Bakery",
"store_id": 26440,
"storage_info": {
"available": null,
"required": null,
"is_critical": false
},
"volume": 100,
"has_volume_change_pending": false,
"send_logs": false,
"reset_state": false,
"fudo_integration_id": null,
"created_at": "2024-07-31T14:53:07+00:00",
"updated_at": "2024-07-31T14:53:07+00:00"
}
}
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
PATCH v2/zones/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the zone. Example: 17351
BODY PARAMETERS
name string optional
Must not be greater than 255 characters. Example: zehtwfoagwwdhlsdmpsgx
DELETE A ZONE
requires authentication
This won't affect your subscription.
> Example request:
curl --request DELETE \
"https://api.brandtrack.fm/v2/zones/17351" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"reason\": \"STORE_CLOSED\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/zones/17351';
$response = $client->delete(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'reason' => 'STORE_CLOSED',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (204, Success):
Empty response
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
DELETE v2/zones/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the zone. Example: 17351
BODY PARAMETERS
reason string
Example: STORE_CLOSED
Must be one of:
* STORE_CLOSED
* TECHNICAL_ISSUES
* MUSICAL_DECISION
GROUPS
LIST GROUPS
requires authentication
Return a paginated list of groups available for the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/groups?page=1&per_page=100&order_by=name&direction=desc" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/groups';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'per_page' => '100',
'order_by' => 'name',
'direction' => 'desc',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": [
{
"id": 17351,
"account_id": 19120,
"music_profile_id": null,
"name": "Music",
"analytics": {
"data": {
"players": 0,
"announcements": 1,
"mixes": 0,
"radios": 0
}
}
},
{
"id": 17352,
"account_id": 19121,
"music_profile_id": null,
"name": "John's Bakery CA - Default",
"analytics": {
"data": {
"players": 0,
"announcements": 1,
"mixes": 0,
"radios": 0
}
}
}
],
"meta": {
"pagination": {
"total": 2,
"count": 2,
"per_page": 100,
"current_page": 1,
"total_pages": 1,
"links": []
}
}
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/groups
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
QUERY PARAMETERS
page integer optional
The page requested. Default to 1. Example: 1
per_page integer optional
The number of items per page. Default to 25. Example: 100
order_by string optional
The field to order the results by. Default to id. Example: name
direction string optional
The direction method to sort results. Default to asc. Example: desc
GET A GROUP BY ITS ID
requires authentication
Return a single group by its ID, if available to the authenticated user.
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/groups/17351?include=announcements%2Cmixes" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/groups/17351';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'include' => 'announcements,mixes',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": {
"id": 17351,
"account_id": 19120,
"music_profile_id": null,
"name": "Music",
"analytics": {
"data": {
"players": 0,
"announcements": 1,
"mixes": 0,
"radios": 0
}
},
"mixes": {
"data": []
},
"announcements": {
"data": [
{
"id": 36193,
"account_id": 19120,
"name": "Announcement",
"rrule": "FREQ=MINUTELY;INTERVAL=15;WKST=MO",
"rrule_type": "advanced",
"exdate": [],
"type": "other",
"priority": false,
"created_at": "2024-07-31T14:38:34.000000Z",
"adverts": {
"data": []
},
"account": {
"data": {
"id": 19120,
"name": "John's Bakery US",
"country": "US",
"source": null
}
}
}
]
}
}
}
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/groups/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the group. Example: 17351
QUERY PARAMETERS
include string optional
Any relation to be included, separated by commas. You can use: announcements,
mixes, account. Example: announcements,mixes
CREATE A NEW GROUP
requires authentication
Create a new group using the provided data.
> Example request:
curl --request POST \
"https://api.brandtrack.fm/v2/groups" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"account_id\": 8,
\"music_profile_id\": 18,
\"name\": \"mollitia\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/groups';
$response = $client->post(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'account_id' => 8,
'music_profile_id' => 18,
'name' => 'mollitia',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (201, Success):
{
"data": {
"id": 17351,
"account_id": 19120,
"music_profile_id": null,
"name": "Music",
"analytics": {
"data": {
"players": 0,
"announcements": 1,
"mixes": 0,
"radios": 0
}
}
}
}
> Example response (403, Forbidden):
{
"message": "This action is unauthorized.",
"status_code": 403
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
POST v2/groups
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
BODY PARAMETERS
account_id integer optional
Example: 8
music_profile_id integer optional
Example: 18
name string
Example: mollitia
UPDATE A GROUP
requires authentication
Update a group with the data provided in the request.
> Example request:
curl --request PATCH \
"https://api.brandtrack.fm/v2/groups/17351" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"account_id\": 8,
\"music_profile_id\": 6,
\"name\": \"libero\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/groups/17351';
$response = $client->patch(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'account_id' => 8,
'music_profile_id' => 6,
'name' => 'libero',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200, Success):
{
"data": {
"id": 17351,
"account_id": 19120,
"music_profile_id": null,
"name": "Music",
"analytics": {
"data": {
"players": 0,
"announcements": 1,
"mixes": 0,
"radios": 0
}
}
}
}
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
PATCH v2/groups/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the group. Example: 17351
BODY PARAMETERS
account_id integer optional
Example: 8
music_profile_id integer optional
Example: 6
name string
Example: libero
DELETE A GROUP
requires authentication
Delete a group using the ID. Any zone related will lose the access to the
playlists and announcements immediately.
> Example request:
curl --request DELETE \
"https://api.brandtrack.fm/v2/groups/17351" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/groups/17351';
$response = $client->delete(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (204, Success):
Empty response
> Example response (404, Wrong ID):
{
"message": "404 Not Found",
"status_code": 404
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
DELETE v2/groups/{id}
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
URL PARAMETERS
id integer
The ID of the group. Example: 17351
ROLES
LIST ALL ROLES
requires authentication
> Example request:
curl --request GET \
--get "https://api.brandtrack.fm/v2/roles" \
--header "x-customer-api-key: {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.brandtrack.fm/v2/roles';
$response = $client->get(
$url,
[
'headers' => [
'x-customer-api-key' => '{YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
> Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
{
"data": [
{
"id": 75,
"name": "cus_finances",
"public_name": "Finances",
"description": "This role can only view the main sections of the platform. They can download and view all billing reports and update billing and profile info."
},
{
"id": 74,
"name": "cus_manager",
"public_name": "Administrator",
"description": "This role can view and manage most features of the platform except for the ones that change subscriptions and future invoices."
},
{
"id": 73,
"name": "owner",
"public_name": "Super Administrator",
"description": "This role can view and manage all features, including subscription updates that may impact future invoices. Superadmins can also “login as users” in other Sub-accounts related to their main “Parent” account."
}
]
}
> Received response:
> Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
REQUEST TRY IT OUT ⚡ CANCEL 🛑 SEND REQUEST 💥
GET v2/roles
HEADERS
x-customer-api-key
Example: {YOUR_AUTH_KEY}
Content-Type
Example: application/json
Accept
Example: application/json
bash php