1<!doctype html> 2<html lang="en"> 3<head> 4 <meta charset="utf-8"> 5 <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"> 6 <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> 7 <title>PROlinks API Documentation</title> 8 9 <link href="https://fonts.googleapis.com/css?family=Open+Sans&display=swap" rel="stylesheet"> 10 11 <link rel="stylesheet" href="../docs/css/theme-default.style.css" media="screen"> 12 <link rel="stylesheet" href="../docs/css/theme-default.print.css" media="print"> 13 14
14<script src="https://cdn.jsdelivr.net/npm/[email protected]/lodash.min.js"></script>
14 15 16 <link rel="stylesheet" 17 href="https://unpkg.com/@highlightjs/[email protected]/styles/obsidian.min.css"> 18
18<script src="https://unpkg.com/@highlightjs/[email protected]/highlight.min.js"></script>
18 19 20
20<script src="https://cdnjs.cloudflare.com/ajax/libs/jets/0.14.1/jets.min.js"></script>
20 21 22 <style id="language-style"> 23 /* starts out as display none and is replaced with js later */ 24 body .content .bash-example code { display: none; } 25 body .content .javascript-example code { display: none; } 26 </style> 27 28
28<script> 29 var tryItOutBaseUrl = "prolinks.pro"; 30 var useCsrf = Boolean(); 31 var csrfUrl = "/sanctum/csrf-cookie"; 32 </script>
32 33
33<script src="../docs/js/tryitout-5.11.0.js"></script>
33 34 35
35<script src="../docs/js/theme-default-5.11.0.js"></script>
35 36 37</head> 38 39<body data-languages="["bash","javascript"]"> 40 41<a href="#" id="nav-button"> 42 <span> 43 MENU 44 <img src="../docs/images/navbar.png" alt="navbar-image"/> 45 </span> 46</a> 47<div class="tocify-wrapper"> 48 49 <div class="lang-selector"> 50 <button type="button" class="lang-button" data-language-name="bash">bash</button> 51 <button type="button" class="lang-button" data-language-name="javascript">javascript</button> 52 </div> 53 54 <div class="search"> 55 <input type="text" class="search" id="input-search" placeholder="Search"> 56 </div> 57 58 <div id="toc"> 59 <ul id="tocify-header-introduction" class="tocify-header"> 60 <li class="tocify-item level-1" data-unique="introduction"> 61 <a href="#introduction">Introduction</a> 62 </li> 63 </ul> 64 <ul id="tocify-header-authenticating-requests" class="tocify-header"> 65 <li class="tocify-item level-1" data-unique="authenticating-requests"> 66 <a href="#authenticating-requests">Authenticating requests</a> 67 </li> 68 </ul> 69 <ul id="tocify-header-campaign-mediums" class="tocify-header"> 70 <li class="tocify-item level-1" data-unique="campaign-mediums"> 71 <a href="#campaign-mediums">Campaign Mediums</a> 72 </li> 73 <ul id="tocify-subheader-campaign-mediums" class="tocify-subheader"> 74 <li class="tocify-item level-2" data-unique="campaign-mediums-GETapi-v1-campaign-mediums"> 75 <a href="#campaign-mediums-GETapi-v1-campaign-mediums">Display a listing of the resource.</a> 76 </li> 77 <li class="tocify-item level-2" data-unique="campaign-mediums-POSTapi-v1-campaign-mediums"> 78 <a href="#campaign-mediums-POSTapi-v1-campaign-mediums">Store a newly created resource in storage.</a> 79 </li> 80 <li class="tocify-item level-2" data-unique="campaign-mediums-GETapi-v1-campaign-mediums--id-"> 81 <a href="#campaign-mediums-GETapi-v1-campaign-mediums--id-">Display the specified resource.</a> 82 </li> 83 <li class="tocify-item level-2" data-unique="campaign-mediums-PATCHapi-v1-campaign-mediums--id-"> 84 <a href="#campaign-mediums-PATCHapi-v1-campaign-mediums--id-">Update the specified resource in storage.</a> 85 </li> 86 <li class="tocify-item level-2" data-unique="campaign-mediums-DELETEapi-v1-campaign-mediums--id-"> 87 <a href="#campaign-mediums-DELETEapi-v1-campaign-mediums--id-">Remove the specified resource from storage.</a> 88 </li> 89 </ul> 90 </ul> 91 <ul id="tocify-header-campaign-sources" class="tocify-header"> 92 <li class="tocify-item level-1" data-unique="campaign-sources"> 93 <a href="#campaign-sources">Campaign Sources</a> 94 </li> 95 <ul id="tocify-subheader-campaign-sources" class="tocify-subheader"> 96 <li class="tocify-item level-2" data-unique="campaign-sources-GETapi-v1-campaign-sources"> 97 <a href="#campaign-sources-GETapi-v1-campaign-sources">Display a listing of the resource.</a> 98 </li> 99 <li class="tocify-item level-2" data-unique="campaign-sources-POSTapi-v1-campaign-sources"> 100 <a href="#campaign-sources-POSTapi-v1-campaign-sources">Store a newly created resource in storage.</a> 101 </li> 102 <li class="tocify-item level-2" data-unique="campaign-sources-GETapi-v1-campaign-sources--id-"> 103 <a href="#campaign-sources-GETapi-v1-campaign-sources--id-">Display the specified resource.</a> 104 </li> 105 <li class="tocify-item level-2" data-unique="campaign-sources-PATCHapi-v1-campaign-sources--id-"> 106 <a href="#campaign-sources-PATCHapi-v1-campaign-sources--id-">Update the specified resource in storage.</a> 107 </li> 108 <li class="tocify-item level-2" data-unique="campaign-sources-DELETEapi-v1-campaign-sources--id-"> 109 <a href="#campaign-sources-DELETEapi-v1-campaign-sources--id-">Remove the specified resource from storage.</a> 110 </li> 111 </ul> 112 </ul> 113 <ul id="tocify-header-domains" class="tocify-header"> 114 <li class="tocify-item level-1" data-unique="domains"> 115 <a href="#domains">Domains</a> 116 </li> 117 <ul id="tocify-subheader-domains" class="tocify-subheader"> 118 <li class="tocify-item level-2" data-unique="domains-GETapi-v1-domains"> 119 <a href="#domains-GETapi-v1-domains">GET api/v1/domains</a> 120 </li> 121 <li class="tocify-item level-2" data-unique="domains-POSTapi-v1-domains"> 122 <a href="#domains-POSTapi-v1-domains">POST api/v1/domains</a> 123 </li> 124 <li class="tocify-item level-2" data-unique="domains-GETapi-v1-domains--id-"> 125 <a href="#domains-GETapi-v1-domains--id-">GET api/v1/domains/{id}</a> 126 </li> 127 <li class="tocify-item level-2" data-unique="domains-PATCHapi-v1-domains--id-"> 128 <a href="#domains-PATCHapi-v1-domains--id-">PATCH api/v1/domains/{id}</a> 129 </li> 130 <li class="tocify-item level-2" data-unique="domains-DELETEapi-v1-domains--id-"> 131 <a href="#domains-DELETEapi-v1-domains--id-">DELETE api/v1/domains/{id}</a> 132 </li> 133 </ul> 134 </ul> 135 <ul id="tocify-header-endpoints" class="tocify-header"> 136 <li class="tocify-item level-1" data-unique="endpoints"> 137 <a href="#endpoints">Endpoints</a> 138 </li> 139 <ul id="tocify-subheader-endpoints" class="tocify-subheader"> 140 <li class="tocify-item level-2" data-unique="endpoints-GETapi-user"> 141 <a href="#endpoints-GETapi-user">GET api/user</a> 142 </li> 143 <li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-user"> 144 <a href="#endpoints-GETapi-v1-user">GET api/v1/user</a> 145 </li> 146 </ul> 147 </ul> 148 <ul id="tocify-header-links" class="tocify-header"> 149 <li class="tocify-item level-1" data-unique="links"> 150 <a href="#links">Links</a> 151 </li> 152 <ul id="tocify-subheader-links" class="tocify-subheader"> 153 <li class="tocify-item level-2" data-unique="links-GETapi-v1-links"> 154 <a href="#links-GETapi-v1-links">GET api/v1/links</a> 155 </li> 156 <li class="tocify-item level-2" data-unique="links-POSTapi-v1-links"> 157 <a href="#links-POSTapi-v1-links">POST api/v1/links</a> 158 </li> 159 <li class="tocify-item level-2" data-unique="links-GETapi-v1-links--id-"> 160 <a href="#links-GETapi-v1-links--id-">GET api/v1/links/{id}</a> 161 </li> 162 <li class="tocify-item level-2" data-unique="links-GETapi-v1-links--link_id--qr-code"> 163 <a href="#links-GETapi-v1-links--link_id--qr-code">GET api/v1/links/{link_id}/qr-code</a> 164 </li> 165 <li class="tocify-item level-2" data-unique="links-GETapi-v1-links--link_id--cl
165icks"> 166 <a href="#links-GETapi-v1-links--link_id--clicks">GET api/v1/links/{link_id}/clicks</a> 167 </li> 168 <li class="tocify-item level-2" data-unique="links-PATCHapi-v1-links--id-"> 169 <a href="#links-PATCHapi-v1-links--id-">PATCH api/v1/links/{id}</a> 170 </li> 171 <li class="tocify-item level-2" data-unique="links-DELETEapi-v1-links--id-"> 172 <a href="#links-DELETEapi-v1-links--id-">DELETE api/v1/links/{id}</a> 173 </li> 174 </ul> 175 </ul> 176 <ul id="tocify-header-organizations" class="tocify-header"> 177 <li class="tocify-item level-1" data-unique="organizations"> 178 <a href="#organizations">Organizations</a> 179 </li> 180 <ul id="tocify-subheader-organizations" class="tocify-subheader"> 181 <li class="tocify-item level-2" data-unique="organizations-GETapi-v1-organizations"> 182 <a href="#organizations-GETapi-v1-organizations">GET api/v1/organizations</a> 183 </li> 184 <li class="tocify-item level-2" data-unique="organizations-GETapi-v1-organizations--id-"> 185 <a href="#organizations-GETapi-v1-organizations--id-">GET api/v1/organizations/{id}</a> 186 </li> 187 </ul> 188 </ul> 189 <ul id="tocify-header-tags" class="tocify-header"> 190 <li class="tocify-item level-1" data-unique="tags"> 191 <a href="#tags">Tags</a> 192 </li> 193 <ul id="tocify-subheader-tags" class="tocify-subheader"> 194 <li class="tocify-item level-2" data-unique="tags-GETapi-v1-tags"> 195 <a href="#tags-GETapi-v1-tags">GET api/v1/tags</a> 196 </li> 197 <li class="tocify-item level-2" data-unique="tags-POSTapi-v1-tags"> 198 <a href="#tags-POSTapi-v1-tags">POST api/v1/tags</a> 199 </li> 200 <li class="tocify-item level-2" data-unique="tags-GETapi-v1-tags--id-"> 201 <a href="#tags-GETapi-v1-tags--id-">GET api/v1/tags/{id}</a> 202 </li> 203 <li class="tocify-item level-2" data-unique="tags-PATCHapi-v1-tags--id-"> 204 <a href="#tags-PATCHapi-v1-tags--id-">PATCH api/v1/tags/{id}</a> 205 </li> 206 <li class="tocify-item level-2" data-unique="tags-DELETEapi-v1-tags--id-"> 207 <a href="#tags-DELETEapi-v1-tags--id-">DELETE api/v1/tags/{id}</a> 208 </li> 209 </ul> 210 </ul> 211 </div> 212 213 <ul class="toc-footer" id="toc-footer"> 214 <li style="padding-bottom: 5px;"><a href="../docs/collection.json">View Postman collection</a></li> 215 <li style="padding-bottom: 5px;"><a href="../docs/openapi.yaml">View OpenAPI spec</a></li> 216 <li><a href="https://github.com/knuckleswtf/scribe">Documentation powered by Scribe â</a></li> 217 </ul> 218 219 <ul class="toc-footer" id="last-updated"> 220 <li>Last updated: June 15, 2026</li> 221 </ul> 222</div> 223 224<div class="page-wrapper"> 225 <div class="dark-box"></div> 226 <div class="content"> 227 <h1 id="introduction">Introduction</h1> 228<aside> 229 <strong>Base URL</strong>: <code>prolinks.pro</code> 230</aside> 231<pre><code>This documentation aims to provide all the information you need to work with our API. 232 233<aside>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). 234You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside></code></pre> 235 236 <h1 id="authenticating-requests">Authenticating requests</h1> 237<p>To authenticate requests, include an <strong><code>Authorization</code></strong> header with the value <strong><code>"Bearer {YOUR_AUTH_KEY}"</code></strong>.</p> 238<p>All authenticated endpoints are marked with a <code>requires authentication</code> badge in the documentation below.</p> 239<p>You can retrieve your token by visiting your dashboard and clicking <b>Generate API token</b>.</p> 240 241 <h1 id="campaign-mediums">Campaign Mediums</h1> 242 243 244 245 <h2 id="campaign-mediums-GETapi-v1-campaign-mediums">Display a listing of the resource.</h2> 246 247<p> 248</p> 249 250 251 252<span id="example-requests-GETapi-v1-campaign-mediums"> 253<blockquote>Example request:</blockquote> 254 255 256<div class="bash-example"> 257 <pre><code class="language-bash">curl --request GET \ 258 --get "prolinks.pro/api/v1/campaign-mediums" \ 259 --header "Content-Type: application/json" \ 260 --header "Accept: application/json" \ 261 --data "{ 262 \"organization_id\": 16 263}" 264</code></pre></div> 265 266 267<div class="javascript-example"> 268 <pre><code class="language-javascript">const url = new URL( 269 "prolinks.pro/api/v1/campaign-mediums"
270); 271 272const headers = { 273 "Content-Type": "application/json", 274 "Accept": "application/json", 275}; 276 277let body = { 278 "organization_id": 16 279}; 280 281fetch(url, { 282 method: "GET", 283 headers, 284 body: JSON.stringify(body), 285}).then(response => response.json());</code></pre></div> 286 287</span> 288 289<span id="example-responses-GETapi-v1-campaign-mediums"> 290 <blockquote> 291 <p>Example response (401):</p> 292 </blockquote> 293 <details class="annotation"> 294 <summary style="cursor: pointer;"> 295 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 296 </summary> 297 <pre><code class="language-http">cache-control: no-cache, private 298content-type: application/json 299access-control-allow-origin: * 300 </code></pre></details> <pre> 301 302<code class="language-json" style="max-height: 300px;">{ 303 "message": "Unauthenticated." 304}</code> 305 </pre> 306 </span> 307<span id="execution-results-GETapi-v1-campaign-mediums" hidden> 308 <blockquote>Received response<span 309 id="execution-response-status-GETapi-v1-campaign-mediums"></span>: 310 </blockquote> 311 <pre class="json"><code id="execution-response-content-GETapi-v1-campaign-mediums" 312 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 313</span> 314<span id="execution-error-GETapi-v1-campaign-mediums" hidden> 315 <blockquote>Request failed with error:</blockquote> 316 <pre><code id="execution-error-message-GETapi-v1-campaign-mediums"> 317 318Tip: Check that you're properly connected to the network. 319If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 320You can check the Dev Tools console for debugging information.</code></pre> 321</span> 322<form id="form-GETapi-v1-campaign-mediums" data-method="GET" 323 data-path="api/v1/campaign-mediums" 324 data-authed="0" 325 data-hasfiles="0" 326 data-isarraybody="0" 327 autocomplete="off" 328 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-campaign-mediums', this);"> 329 <h3> 330 Request 331 <button type="button" 332 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 333 id="btn-tryout-GETapi-v1-campaign-mediums" 334 onclick="tryItOut('GETapi-v1-campaign-mediums');">Try it out â¡ 335 </button> 336 <button type="button" 337 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 338 id="btn-canceltryout-GETapi-v1-campaign-mediums" 339 onclick="cancelTryOut('GETapi-v1-campaign-mediums');" hidden>Cancel ð 340 </button> 341 <button type="submit" 342 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 343 id="btn-executetryout-GETapi-v1-campaign-mediums" 344 data-initial-text="Send Request ð¥" 345 data-loading-text="â± Sending..." 346 hidden>Send Request ð¥ 347 </button> 348 </h3> 349 <p> 350 <small class="badge badge-green">GET</small> 351 <b><code>api/v1/campaign-mediums</code></b> 352 </p> 353 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 354 <div style="padding-left: 28px; clear: unset;"> 355 <b style="line-height: 2;"><code>Content-Type</code></b> 356 357 358 359 <input type="text" style="display: none" 360 name="Content-Type" data-endpoint="GETapi-v1-campaign-mediums" 361 value="application/json" 362 data-component="header"> 363 <br> 364<p>Example: <code>application/json</code></p> 365 </div> 366 <div style="padding-left: 28px; clear: unset;"> 367 <b style="line-height: 2;"><code>Accept</code></b> 368 369 370 371 <input type="text" style="display: none" 372 name="Accept" data-endpoint="GETapi-v1-campaign-mediums"
373 value="application/json" 374 data-component="header"> 375 <br> 376<p>Example: <code>application/json</code></p> 377 </div> 378 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 379 <div style=" padding-left: 28px; clear: unset;"> 380 <b style="line-height: 2;"><code>organization_id</code></b> 381<small>integer</small> 382 383 384 <input type="number" style="display: none" 385 step="any" name="organization_id" data-endpoint="GETapi-v1-campaign-mediums" 386 value="16" 387 data-component="body"> 388 <br> 389<p>Must match an existing stored value. Example: <code>16</code></p> 390 </div> 391 </form> 392 393 <h2 id="campaign-mediums-POSTapi-v1-campaign-mediums">Store a newly created resource in storage.</h2> 394 395<p> 396</p> 397 398 399 400<span id="example-requests-POSTapi-v1-campaign-mediums"> 401<blockquote>Example request:</blockquote> 402 403 404<div class="bash-example"> 405 <pre><code class="language-bash">curl --request POST \ 406 "prolinks.pro/api/v1/campaign-mediums" \ 407 --header "Content-Type: application/json" \ 408 --header "Accept: application/json" \ 409 --data "{ 410 \"organization_id\": 16, 411 \"name\": \"n\" 412}" 413</code></pre></div> 414 415 416<div class="javascript-example"> 417 <pre><code class="language-javascript">const url = new URL( 418 "prolinks.pro/api/v1/campaign-mediums" 419); 420 421const headers = { 422 "Content-Type": "application/json", 423 "Accept": "application/json", 424}; 425 426let body = { 427 "organization_id": 16, 428 "name": "n" 429}; 430 431fetch(url, { 432 method: "POST", 433 headers, 434 body: JSON.stringify(body), 435}).then(response => response.json());</code></pre></div> 436 437</span> 438 439<span id="example-responses-POSTapi-v1-campaign-mediums"> 440</span> 441<span id="execution-results-POSTapi-v1-campaign-mediums" hidden> 442 <blockquote>Received response<span 443 id="execution-response-status-POSTapi-v1-campaign-mediums"></span>: 444 </blockquote> 445 <pre class="json"><code id="execution-response-content-POSTapi-v1-campaign-mediums" 446 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 447</span> 448<span id="execution-error-POSTapi-v1-campaign-mediums" hidden> 449 <blockquote>Request failed with error:</blockquote> 450 <pre><code id="execution-error-message-POSTapi-v1-campaign-mediums"> 451 452Tip: Check that you're properly connected to the network. 453If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 454You can check the Dev Tools console for debugging information.</code></pre> 455</span> 456<form id="form-POSTapi-v1-campaign-mediums" data-method="POST" 457 data-path="api/v1/campaign-mediums" 458 data-authed="0" 459 data-hasfiles="0" 460 data-isarraybody="0" 461 autocomplete="off" 462 onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-campaign-mediums', this);"> 463 <h3> 464 Request 465 <button type="button" 466 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 467 id="btn-tryout-POSTapi-v1-campaign-mediums" 468 onclick="tryItOut('POSTapi-v1-campaign-mediums');">Try it out â¡ 469 </button> 470 <button type="button" 471 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 472 id="btn-canceltryout-POSTapi-v1-campaign-mediums" 473 onclick="cancelTryOut('POSTapi-v1-campaign-mediums');" hidden>Cancel ð 474 </button> 475 <button type="submit" 476 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 477 id="btn-executetryout-POSTapi-v1-campaign-mediums" 478 data-initial-text="Send Request ð¥" 479 data-loading-text="â± Sending..." 480 hidden>Send Request ð¥ 481 </button> 482 </h3> 483 <p> 484 <small class="badge badge-black">POST</small> 485 <b><code>api/v1/campaign-mediums</code></b> 486 </p> 487 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 488 <div style="padding-left: 28px; clear: unset;"> 489 <b style="line-height: 2;"><code>Content-Type</code></b> 490 491 492 493 <input type="text" style="display: none" 494 name="Content-Type" data-endpoint="POSTapi-v1-campaign-mediums"
495 value="application/json" 496 data-component="header"> 497 <br> 498<p>Example: <code>application/json</code></p> 499 </div> 500 <div style="padding-left: 28px; clear: unset;"> 501 <b style="line-height: 2;"><code>Accept</code></b> 502 503 504 505 <input type="text" style="display: none" 506 name="Accept" data-endpoint="POSTapi-v1-campaign-mediums" 507 value="application/json" 508 data-component="header"> 509 <br> 510<p>Example: <code>application/json</code></p> 511 </div> 512 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 513 <div style=" padding-left: 28px; clear: unset;"> 514 <b style="line-height: 2;"><code>organization_id</code></b> 515<small>integer</small> 516 517 518 <input type="number" style="display: none" 519 step="any" name="organization_id" data-endpoint="POSTapi-v1-campaign-mediums" 520 value="16" 521 data-component="body"> 522 <br> 523<p>Must match an existing stored value. Example: <code>16</code></p> 524 </div> 525 <div style=" padding-left: 28px; clear: unset;"> 526 <b style="line-height: 2;"><code>name</code></b> 527<small>string</small> 528 529 530 <input type="text" style="display: none" 531 name="name" data-endpoint="POSTapi-v1-campaign-mediums" 532 value="n" 533 data-component="body"> 534 <br> 535<p>Must not be greater than 255 characters. Example: <code>n</code></p> 536 </div> 537 </form> 538 539 <h2 id="campaign-mediums-GETapi-v1-campaign-mediums--id-">Display the specified resource.</h2> 540 541<p> 542</p> 543 544 545 546<span id="example-requests-GETapi-v1-campaign-mediums--id-"> 547<blockquote>Example request:</blockquote> 548 549 550<div class="bash-example"> 551 <pre><code class="language-bash">curl --request GET \ 552 --get "prolinks.pro/api/v1/campaign-mediums/16" \ 553 --header "Content-Type: application/json" \ 554 --header "Accept: application/json" \ 555 --data "{ 556 \"organization_id\": 16 557}" 558</code></pre></div> 559 560 561<div class="javascript-example"> 562 <pre><code class="language-javascript">const url = new URL( 563 "prolinks.pro/api/v1/campaign-mediums/16" 564); 565 566const headers = { 567 "Content-Type": "application/json", 568 "Accept": "application/json", 569}; 570 571let body = { 572 "organization_id": 16 573}; 574 575fetch(url, { 576 method: "GET", 577 headers, 578 body: JSON.stringify(body), 579}).then(response => response.json());</code></pre></div> 580 581</span> 582 583<span id="example-responses-GETapi-v1-campaign-mediums--id-"> 584 <blockquote> 585 <p>Example response (401):</p> 586 </blockquote> 587 <details class="annotation"> 588 <summary style="cursor: pointer;"> 589 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 590 </summary> 591 <pre><code class="language-http">cache-control: no-cache, private 592content-type: application/json 593access-control-allow-origin: * 594 </code></pre></details> <pre> 595 596<code class="language-json" style="max-height: 300px;">{ 597 "message": "Unauthenticated." 598}</code> 599 </pre> 600 </span> 601<span id="execution-results-GETapi-v1-campaign-mediums--id-" hidden> 602 <blockquote>Received response<span 603 id="execution-response-status-GETapi-v1-campaign-mediums--id-"></span>: 604 </blockquote> 605 <pre class="json"><code id="execution-response-content-GETapi-v1-campaign-mediums--id-" 606 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 607</span> 608<span id="execution-error-GETapi-v1-campaign-mediums--id-" hidden> 609 <blockquote>Request failed with error:</blockquote> 610 <pre><code id="execution-error-message-GETapi-v1-campaign-mediums--id-"> 611 612Tip: Check that you're properly connected to the network. 613If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 614You can check the Dev Tools console for debugging information.</code></pre> 615</span> 616<form id="form-GETapi-v1-campaign-mediums--id-" data-method="GET" 617 data-path="api/v1/campaign-mediums/{id}" 618 data-authed="0" 619 data-hasfiles="0" 620 data-isarraybody="0" 621 autocomplete="off" 622 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-campaign-mediums--id-', this);"> 623 <h3> 624 Request 625 <button type="button" 626 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 627 id="btn-tryout-GETapi-v1-campaign-mediums--id-" 628 onclick="tryItOut('GETapi-v1-campaign-mediums--id-');">Try it out â¡ 629 </button> 630 <button type="button" 631 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 632 id="btn-canceltryout-GETapi-v1-campaign-mediums--id-" 633 onclick="cancelTryOut('GETapi-v1-campaign-mediums--id-');" hidden>Cancel ð 634 </button> 635 <button type="submit" 636 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 637 id="btn-executetryout-GETapi-v1-campaign-mediums--id-" 638 data-initial-text="Send Request ð¥" 639 data-loading-text="â± Sending..." 640 hidden>Send Request ð¥ 641 </button> 642 </h3> 643 <p> 644 <small class="badge badge-green">GET</small> 645 <b><code>api/v1/campaign-mediums/{id}</code></b> 646 </p> 647 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 648 <div style="padding-left: 28px; clear: unset;"> 649 <b style="line-height: 2;"><code>Content-Type</code></b> 650 651 652 653 <input type="text" style="display: none" 654 name="Content-Type" data-endpoint="GETapi-v1-campaign-mediums--id-" 655 value="application/json" 656 data-component="header"> 657 <br> 658<p>Example: <code>application/json</code></p> 659 </div> 660 <div style="padding-left: 28px; clear: unset;"> 661 <b style="line-height: 2;"><code>Accept</code></b> 662 663 664 665 <input type="text" style="display: none" 666 name="Accept" data-endpoint="GETapi-v1-campaign-mediums--id-" 667 value="application/json" 668 data-component="header"> 669 <br> 670<p>Example: <code>application/json</code></p> 671 </div> 672 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 673 <div style="padding-left: 28px; clear: unset;"> 674 <b style="line-height: 2;"><code>id</code></b> 675<small>integer</small> 676 677 678 <input type="number" style="display: none" 679 step="any" name="id" data-endpoint="GETapi-v1-campaign-mediums--id-" 680 value="16" 681 data-component="url"> 682 <br> 683<p>The ID of the campaign medium. Example: <code>16</code></p> 684 </div> 685 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 686 <div style=" padding-left: 28px; clear: unset;"> 687 <b style="line-height: 2;"><code>organization_id</code></b> 688<small>integer</small> 689 690 691 <input type="number" style="display: none" 692 step="any" name="organization_id" data-endpoint="GETapi-v1-campaign-mediums--id-" 693 value="16" 694 data-component="body"> 695 <br> 696<p>Must match an existing stored value. Example: <code>16</code></p> 697 </div> 698 </form> 699 700 <h2 id="campaign-mediums-PATCHapi-v1-campaign-mediums--id-">Update the specified resource in storage.</h2> 701 702<p> 703</p> 704 705 706 707<span id="example-requests-PATCHapi-v1-campaign-mediums--id-"> 708<blockquote>Example request:</blockquote> 709 710 711<div class="bash-example"> 712 <pre><code class="language-bash">curl --request PATCH \ 713 "prolinks.pro/api/v1/campaign-mediums/16" \ 714 --header "Content-Type: application/json" \ 715 --header "Accept: application/json" \ 716 --data "{ 717 \"organization_id\": 16, 718 \"name\": \"n\" 719}" 720</code></pre></div> 721 722 723<div class="javascript-example"> 724 <pre><code class="language-javascript">const url = new URL( 725 "prolinks.pro/api/v1/campaign-mediums/16" 726); 727 728const headers = { 729 "Content-Type": "application/json", 730 "Accept": "application/json", 731}; 732 733let body = { 734 "organization_id": 16, 735 "name": "n" 736}; 737 738fetch(url, { 739 method: "PATCH", 740 headers, 741 body: JSON.stringify(body), 742}).then(response => response.json());</code></pre></div> 743 744</span> 745 746<span id="example-responses-PATCHapi-v1-campaign-mediums--id-"> 747</span> 748<span id="execution-results-PATCHapi-v1-campaign-mediums--id-" hidden> 749 <blockquote>Received response<span 750 id="execution-response-status-PATCHapi-v1-campaign-mediums--id-"></span>: 751 </blockquote> 752 <pre class="json"><code id="execution-response-content-PATCHapi-v1-campaign-mediums--id-" 753 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 754</span> 755<span id="execution-error-PATCHapi-v1-campaign-mediums--id-" hidden> 756 <blockquote>Request failed with error:</blockquote> 757 <pre><code id="execution-error-message-PATCHapi-v1-campaign-mediums--id-"> 758 759Tip: Check that you're properly connected to the network. 760If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 761You can check the Dev Tools console for debugging information.</code></pre> 762</span> 763<form id="form-PATCHapi-v1-campaign-mediums--id-" data-method="PATCH" 764 data-path="api/v1/campaign-mediums/{id}" 765 data-authed="0" 766 data-hasfiles="0" 767 data-isarraybody="0" 768 autocomplete="off" 769 onsubmit="event.preventDefault(); executeTryOut('PATCHapi-v1-campaign-mediums--id-', this);"> 770 <h3> 771 Request 772 <button type="button" 773 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 774 id="btn-tryout-PATCHapi-v1-campaign-mediums--id-" 775 onclick="tryItOut('PATCHapi-v1-campaign-mediums--id-');">Try it out â¡ 776 </button> 777 <button type="button" 778 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 779 id="btn-canceltryout-PATCHapi-v1-campaign-mediums--id-" 780 onclick="cancelTryOut('PATCHapi-v1-campaign-mediums--id-');" hidden>Cancel ð 781 </button> 782 <button type="submit" 783 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 784 id="btn-executetryout-PATCHapi-v1-campaign-mediums--id-" 785 data-initial-text="Send Request ð¥" 786 data-loading-text="â± Sending..." 787 hidden>Send Request ð¥ 788 </button> 789 </h3> 790 <p> 791 <small class="badge badge-purple">PATCH</small> 792 <b><code>api/v1/campaign-mediums/{id}</code></b> 793 </p> 794 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 795 <div style="padding-left: 28px; clear: unset;"> 796 <b style="line-height: 2;"><code>Content-Type</code></b> 797 798 799 800 <input type="text" style="display: none" 801 name="Content-Type" data-endpoint="PATCHapi-v1-campaign-mediums--id-" 802 value="application/json" 803 data-component="header"> 804 <br> 805<p>Example: <code>application/json</code></p> 806 </div> 807 <div style="padding-left: 28px; clear: unset;"> 808 <b style="line-height: 2;"><code>Accept</code></b> 809 810 811 812 <input type="text" style="display: none" 813 name="Accept" data-endpoint="PATCHapi-v1-campaign-mediums--id-" 814 value="application/json" 815 data-component="header"> 816 <br> 817<p>Example: <code>application/json</code></p> 818 </div> 819 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 820 <div style="padding-left: 28px; clear: unset;"> 821 <b style="line-height: 2;"><code>id</code></b> 822<small>integer</small> 823 824 825 <input type="number" style="display: none" 826 step="any" name="id" data-endpoint="PATCHapi-v1-campaign-mediums--id-" 827 value="16" 828 data-component="url"> 829 <br> 830<p>The ID of the campaign medium. Example: <code>16</code></p> 831 </div> 832 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 833 <div style=" padding-left: 28px; clear: unset;"> 834 <b style="line-height: 2;"><code>organization_id</code></b> 835<small>integer</small> 836 837 838 <input type="number" style="display: none" 839 step="any" name="organization_id" data-endpoint="PATCHapi-v1-campaign-mediums--id-" 840 value="16" 841 data-component="body"> 842 <br> 843<p>Must match an existing stored value. Example: <code>16</code></p> 844 </div> 845 <div style=" padding-left: 28px; clear: unset;"> 846 <b style="line-height: 2;"><code>name</code></b> 847<small>string</small> 848 849 850 <input type="text" style="display: none" 851 name="name" data-endpoint="PATCHapi-v1-campaign-mediums--id-" 852 value="n" 853 data-component="body"> 854 <br> 855<p>Must not be greater than 255 characters. Example: <code>n</code></p> 856 </div> 857 </form> 858 859 <h2 id="campaign-mediums-DELETEapi-v1-campaign-mediums--id-">Remove the specified resource from storage.</h2> 860 861<p> 862</p> 863 864 865 866<span id="example-requests-DELETEapi-v1-campaign-mediums--id-"> 867<blockquote>Example request:</blockquote> 868 869 870<div class="bash-example"> 871 <pre><code class="language-bash">curl --request DELETE \ 872 "prolinks.pro/api/v1/campaign-mediums/16" \ 873 --header "Content-Type: application/json" \ 874 --header "Accept: application/json" \ 875 --data "{ 876 \"organization_id\": 16 877}" 878</code></pre></div> 879 880 881<div class="javascript-example"> 882 <pre><code class="language-javascript">const url = new URL( 883 "prolinks.pro/api/v1/campaign-mediums/16" 884); 885 886const headers = { 887 "Content-Type": "application/json", 888 "Accept": "application/json", 889}; 890 891let body = { 892 "organization_id": 16 893}; 894 895fetch(url, { 896 method: "DELETE", 897 headers, 898 body: JSON.stringify(body), 899}).then(response => response.json());</code></pre></div> 900 901</span> 902 903<span id="example-responses-DELETEapi-v1-campaign-mediums--id-"> 904</span> 905<span id="execution-results-DELETEapi-v1-campaign-mediums--id-" hidden> 906 <blockquote>Received response<span 907 id="execution-response-status-DELETEapi-v1-campaign-mediums--id-"></span>: 908 </blockquote> 909 <pre class="json"><code id="execution-response-content-DELETEapi-v1-campaign-mediums--id-" 910 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 911</span> 912<span id="execution-error-DELETEapi-v1-campaign-mediums--id-" hidden> 913 <blockquote>Request failed with error:</blockquote> 914 <pre><code id="execution-error-message-DELETEapi-v1-campaign-mediums--id-"> 915 916Tip: Check that you're properly connected to the network.
917If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 918You can check the Dev Tools console for debugging information.</code></pre> 919</span> 920<form id="form-DELETEapi-v1-campaign-mediums--id-" data-method="DELETE" 921 data-path="api/v1/campaign-mediums/{id}" 922 data-authed="0" 923 data-hasfiles="0" 924 data-isarraybody="0" 925 autocomplete="off" 926 onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-campaign-mediums--id-', this);"> 927 <h3> 928 Request 929 <button type="button" 930 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 931 id="btn-tryout-DELETEapi-v1-campaign-mediums--id-" 932 onclick="tryItOut('DELETEapi-v1-campaign-mediums--id-');">Try it out â¡ 933 </button> 934 <button type="button" 935 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 936 id="btn-canceltryout-DELETEapi-v1-campaign-mediums--id-" 937 onclick="cancelTryOut('DELETEapi-v1-campaign-mediums--id-');" hidden>Cancel ð 938 </button> 939 <button type="submit" 940 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 941 id="btn-executetryout-DELETEapi-v1-campaign-mediums--id-" 942 data-initial-text="Send Request ð¥" 943 data-loading-text="â± Sending..." 944 hidden>Send Request ð¥ 945 </button> 946 </h3> 947 <p> 948 <small class="badge badge-red">DELETE</small> 949 <b><code>api/v1/campaign-mediums/{id}</code></b> 950 </p> 951 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 952 <div style="padding-left: 28px; clear: unset;"> 953 <b style="line-height: 2;"><code>Content-Type</code></b> 954 955 956 957 <input type="text" style="display: none" 958 name="Content-Type" data-endpoint="DELETEapi-v1-campaign-mediums--id-" 959 value="application/json" 960 data-component="header"> 961 <br> 962<p>Example: <code>application/json</code></p> 963 </div> 964 <div style="padding-left: 28px; clear: unset;"> 965 <b style="line-height: 2;"><code>Accept</code></b> 966 967 968 969 <input type="text" style="display: none" 970 name="Accept" data-endpoint="DELETEapi-v1-campaign-mediums--id-" 971 value="application/json" 972 data-component="header"> 973 <br> 974<p>Example: <code>application/json</code></p> 975 </div> 976 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 977 <div style="padding-left: 28px; clear: unset;"> 978 <b style="line-height: 2;"><code>id</code></b> 979<small>integer</small> 980 981 982 <input type="number" style="display: none" 983 step="any" name="id" data-endpoint="DELETEapi-v1-campaign-mediums--id-" 984 value="16" 985 data-component="url"> 986 <br> 987<p>The ID of the campaign medium. Example: <code>16</code></p> 988 </div> 989 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 990 <div style=" padding-left: 28px; clear: unset;"> 991 <b style="line-height: 2;"><code>organization_id</code></b> 992<small>integer</small> 993 994 995 <input type="number" style="display: none" 996 step="any" name="organization_id" data-endpoint="DELETEapi-v1-campaign-mediums--id-" 997 value="16" 998 data-component="body"> 999 <br> 1000<p>Must match an existing stored value. Example: <code>16</code></p> 1001 </div> 1002 </form> 1003 1004 <h1 id="campaign-sources">Campaign Sources</h1> 1005 1006 1007 1008 <h2 id="campaign-sources-GETapi-v1-campaign-sources">Display a listing of the resource.</h2> 1009 1010<p> 1011</p> 1012 1013 1014 1015<span id="example-requests-GETapi-v1-campaign-sources"> 1016<blockquote>Example request:</blockquote> 1017 1018 1019<div class="bash-example"> 1020 <pre><code class="language-bash">curl --request GET \ 1021 --get "prolinks.pro/api/v1/campaign-sources" \ 1022 --header "Content-Type: application/json" \ 1023 --header "Accept: application/json" \ 1024 --data "{ 1025 \"organization_id\": 16 1026}" 1027</code></pre></div> 1028 1029 1030<div class="javascript-example"> 1031 <pre><code class="language-javascript">const url = new URL( 1032 "prolinks.pro/api/v1/campaign-sources" 1033); 1034 1035const headers = { 1036 "Content-Type": "application/json", 1037 "Accept": "application/json", 1038}; 1039 1040let body = { 1041 "organization_id": 16 1042}; 1043 1044fetch(url, { 1045 method: "GET", 1046 headers, 1047 body: JSON.stringify(body), 1048}).then(response => response.json());</code></pre></div> 1049 1050</span> 1051 1052<span id="example-responses-GETapi-v1-campaign-sources"> 1053 <blockquote> 1054 <p>
1054Example response (401):</p> 1055 </blockquote> 1056 <details class="annotation"> 1057 <summary style="cursor: pointer;"> 1058 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 1059 </summary> 1060 <pre><code class="language-http">cache-control: no-cache, private 1061content-type: application/json 1062access-control-allow-origin: * 1063 </code></pre></details> <pre> 1064 1065<code class="language-json" style="max-height: 300px;">{ 1066 "message": "Unauthenticated." 1067}</code> 1068 </pre> 1069 </span> 1070<span id="execution-results-GETapi-v1-campaign-sources" hidden> 1071 <blockquote>Received response<span 1072 id="execution-response-status-GETapi-v1-campaign-sources"></span>: 1073 </blockquote> 1074 <pre class="json"><code id="execution-response-content-GETapi-v1-campaign-sources" 1075 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 1076</span> 1077<span id="execution-error-GETapi-v1-campaign-sources" hidden> 1078 <blockquote>Request failed with error:</blockquote> 1079 <pre><code id="execution-error-message-GETapi-v1-campaign-sources"> 1080 1081Tip: Check that you're properly connected to the network. 1082If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 1083You can check the Dev Tools console for debugging information.</code></pre> 1084</span> 1085<form id="form-GETapi-v1-campaign-sources" data-method="GET" 1086 data-path="api/v1/campaign-sources" 1087 data-authed="0" 1088 data-hasfiles="0" 1089 data-isarraybody="0" 1090 autocomplete="off" 1091 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-campaign-sources', this);"> 1092 <h3> 1093 Request 1094 <button type="button" 1095 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1096 id="btn-tryout-GETapi-v1-campaign-sources" 1097 onclick="tryItOut('GETapi-v1-campaign-sources');">Try it out â¡ 1098 </button> 1099 <button type="button" 1100 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1101 id="btn-canceltryout-GETapi-v1-campaign-sources" 1102 onclick="cancelTryOut('GETapi-v1-campaign-sources');" hidden>Cancel ð 1103 </button> 1104 <button type="submit" 1105 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1106 id="btn-executetryout-GETapi-v1-campaign-sources" 1107 data-initial-text="Send Request ð¥" 1108 data-loading-text="â± Sending..." 1109 hidden>Send Request ð¥ 1110 </button> 1111 </h3> 1112 <p> 1113 <small class="badge badge-green">GET</small> 1114 <b><code>api/v1/campaign-sources</code></b> 1115 </p> 1116 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 1117 <div style="padding-left: 28px; clear: unset;"> 1118 <b style="line-height: 2;"><code>Content-Type</code></b> 1119 1120 1121 1122 <input type="text" style="display: none" 1123 name="Content-Type" data-endpoint="GETapi-v1-campaign-sources" 1124 value="application/json" 1125 data-component="header"> 1126 <br> 1127<p>Example: <code>application/json</code></p> 1128 </div> 1129 <div style="padding-left: 28px; clear: unset;"> 1130 <b style="line-height: 2;"><code>Accept</code></b> 1131 1132 1133 1134 <input type="text" style="display: none" 1135 name="Accept" data-endpoint="GETapi-v1-campaign-sources" 1136 value="application/json" 1137 data-component="header"> 1138 <br> 1139<p>Example: <code>application/json</code></p> 1140 </div> 1141 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 1142 <div style=" padding-left: 28px; clear: unset;"> 1143 <b style="line-height: 2;"><code>organization_id</code></b> 1144<small>integer</small> 1145 1146 1147 <input type="number" style="display: none" 1148 step="any" name="organization_id" data-endpoint="GETapi-v1-campaign-sources" 1149 value="16" 1150 data-component="body"> 1151 <br> 1152<p>Must match an existing stored value. Example: <code>16</code></p> 1153 </div> 1154 </form> 1155 1156 <h2 id="campaign-sources-POSTapi-v1-campaign-sources">Store a newly created resource in storage.</h2> 1157 1158<p> 1159</p> 1160 1161 1162 1163<span id="example-requests-POSTapi-v1-campaign-sources"> 1164<blockquote>Example request:</blockquote> 1165 1166 1167<div class="bash-example"> 1168 <pre><code class="language-bash">curl --request POST \ 1169 "prolinks.pro/api/v1/campaign-sources" \ 1170 --header "Content-Type: application/json" \ 1171 --header "Accept: application/json" \ 1172 --data "{ 1173 \"organization_id\": 16, 1174 \"name\": \"n\" 1175}" 1176</code></pre></div> 1177 1178 1179<div class="javascript-example"> 1180 <pre><code class="language-javascript">const url = new URL( 1181 "prolinks.pro/api/v1/campaign-sources" 1182); 1183 1184const headers = { 1185 "Content-Type": "application/json", 1186 "Accept": "application/json", 1187}; 1188 1189let body = { 1190 "organization_id": 16, 1191 "name": "n" 1192}; 1193 1194fetch(url, { 1195 method: "POST", 1196 headers, 1197 body: JSON.stringify(body), 1198}).then(response => response.json());</code></pre></div> 1199 1200</span> 1201 1202<span id="example-responses-POSTapi-v1-campaign-sources"> 1203</span> 1204<span id="execution-results-POSTapi-v1-campaign-sources" hidden> 1205 <blockquote>Received response<span 1206 id="execution-response-status-POSTapi-v1-campaign-sources"></span>: 1207 </blockquote> 1208 <pre class="json"><code id="execution-response-content-POSTapi-v1-campaign-sources" 1209 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 1210</span> 1211<span id="execution-error-POSTapi-v1-campaign-sources" hidden> 1212 <blockquote>Request failed with error:</blockquote> 1213 <pre><code id="execution-error-message-POSTapi-v1-campaign-sources"> 1214 1215Tip: Check that you're properly connected to the network. 1216If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 1217You can check the Dev Tools console for debugging information.</code></pre> 1218</span> 1219<form id="form-POSTapi-v1-campaign-sources" data-method="POST" 1220 data-path="api/v1/campaign-sources" 1221 data-authed="0" 1222 data-hasfiles="0" 1223 data-isarraybody="0" 1224 autocomplete="off" 1225 onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-campaign-sources', this);"> 1226 <h3> 1227 Request 1228 <button type="button" 1229 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1230 id="btn-tryout-POSTapi-v1-campaign-sources" 1231 onclick="tryItOut('POSTapi-v1-campaign-sources');">Try it out â¡ 1232 </button> 1233 <button type="button" 1234 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1235 id="btn-canceltryout-POSTapi-v1-campaign-sources" 1236 onclick="cancelTryOut('POSTapi-v1-campaign-sources');" hidden>Cancel ð 1237 </button> 1238 <button type="submit" 1239 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1240 id="btn-executetryout-POSTapi-v1-campaign-sources" 1241 data-initial-text="Send Request ð¥" 1242 data-loading-text="â± Sending..." 1243 hidden>Send Request ð¥ 1244 </button> 1245 </h3> 1246 <p> 1247 <small class="badge badge-black">POST</small> 1248 <b><code>api/v1/campaign-sources</code></b> 1249 </p> 1250 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 1251 <div style="padding-left: 28px; clear: unset;"> 1252 <b style="line-height: 2;"><code>Content-Type</code></b> 1253 1254 1255 1256 <input type="text" style="display: none" 1257 name="Content-Type" data-endpoint="POSTapi-v1-campaign-sources" 1258 value="application/json" 1259 data-component="header"> 1260 <br> 1261<p>Example: <code>application/json</code></p> 1262 </div> 1263 <div style="padding-left: 28px; clear: unset;"> 1264 <b style="line-height: 2;"><code>Accept</code></b> 1265 1266 1267 1268 <input type="text" style="display: none" 1269 name="Accept" data-endpoint="POSTapi-v1-campaign-sources" 1270 value="application/json" 1271 data-component="header"> 1272 <br> 1273<p>Example: <code>application/json</code></p> 1274 </div> 1275 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 1276 <div style=" padding-left: 28px; clear: unset;"> 1277 <b style="line-height: 2;"><code>organization_id</code></b> 1278<small>integer</small> 1279 1280 1281 <input type="number" style="display: none" 1282 step="any" name="organization_id" data-endpoint="POSTapi-v1-campaign-sources" 1283 value="16" 1284 data-component="body"> 1285 <br> 1286<p>Must match an existing stored value. Example: <code>16</code></p> 1287 </div> 1288 <div style=" padding-left: 28px; clear: unset;"> 1289 <b style="line-height: 2;"><code>name</code></b> 1290<small>string</small> 1291 1292 1293 <input type="text" style="display: none" 1294 name="name" data-endpoint="POSTapi-v1-campaign-sources" 1295 value="n" 1296 data-component="body"> 1297 <br> 1298<p>Must not be greater than 255 characters. Example: <code>n</code></p> 1299 </div> 1300 </form> 1301 1302 <h2 id="campaign-sources-GETapi-v1-campaign-sources--id-">Display the specified resource.</h2> 1303 1304<p> 1305</p> 1306 1307 1308 1309<span id="example-requests-GETapi-v1-campaign-sources--id-"> 1310<blockquote>Example request:</blockquote> 1311 1312 1313<div class="bash-example"> 1314 <pre><code class="language-bash">curl --request GET \ 1315 --get "prolinks.pro/api/v1/campaign-sources/16" \ 1316 --header "Content-Type: application/json" \ 1317 --header "Accept: application/json" \ 1318 --data "{ 1319 \"organization_id\": 16 1320}" 1321</code></pre></div> 1322 1323 1324<div class="javascript-example"> 1325 <pre><code class="language-javascript">const url = new URL( 1326 "prolinks.pro/api/v1/campaign-sources/16" 1327); 1328 1329const headers = { 1330 "Content-Type": "application/json", 1331 "Accept": "application/json", 1332}; 1333 1334let body = { 1335 "organization_id": 16 1336}; 1337 1338fetch(url, { 1339 method: "GET", 1340 headers, 1341 body: JSON.stringify(body), 1342}).then(response => response.json());</code></pre></div> 1343 1344</span> 1345 1346<span id="example-responses-GETapi-v1-campaign-sources--id-"> 1347 <blockquote> 1348 <p>
1348Example response (401):</p> 1349 </blockquote> 1350 <details class="annotation"> 1351 <summary style="cursor: pointer;"> 1352 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 1353 </summary> 1354 <pre><code class="language-http">cache-control: no-cache, private 1355content-type: application/json 1356access-control-allow-origin: * 1357 </code></pre></details> <pre> 1358 1359<code class="language-json" style="max-height: 300px;">{ 1360 "message": "Unauthenticated." 1361}</code> 1362 </pre> 1363 </span> 1364<span id="execution-results-GETapi-v1-campaign-sources--id-" hidden> 1365 <blockquote>Received response<span 1366 id="execution-response-status-GETapi-v1-campaign-sources--id-"></span>: 1367 </blockquote> 1368 <pre class="json"><code id="execution-response-content-GETapi-v1-campaign-sources--id-" 1369 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 1370</span> 1371<span id="execution-error-GETapi-v1-campaign-sources--id-" hidden> 1372 <blockquote>Request failed with error:</blockquote> 1373 <pre><code id="execution-error-message-GETapi-v1-campaign-sources--id-"> 1374 1375Tip: Check that you're properly connected to the network. 1376If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 1377You can check the Dev Tools console for debugging information.</code></pre> 1378</span> 1379<form id="form-GETapi-v1-campaign-sources--id-" data-method="GET" 1380 data-path="api/v1/campaign-sources/{id}" 1381 data-authed="0" 1382 data-hasfiles="0" 1383 data-isarraybody="0" 1384 autocomplete="off" 1385 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-campaign-sources--id-', this);"> 1386 <h3> 1387 Request 1388 <button type="button" 1389 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1390 id="btn-tryout-GETapi-v1-campaign-sources--id-" 1391 onclick="tryItOut('GETapi-v1-campaign-sources--id-');">Try it out â¡ 1392 </button> 1393 <button type="button" 1394 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1395 id="btn-canceltryout-GETapi-v1-campaign-sources--id-" 1396 onclick="cancelTryOut('GETapi-v1-campaign-sources--id-');" hidden>Cancel ð 1397 </button> 1398 <button type="submit" 1399 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1400 id="btn-executetryout-GETapi-v1-campaign-sources--id-" 1401 data-initial-text="Send Request ð¥" 1402 data-loading-text="â± Sending..." 1403 hidden>Send Request ð¥ 1404 </button> 1405 </h3> 1406 <p> 1407 <small class="badge badge-green">GET</small> 1408 <b><code>api/v1/campaign-sources/{id}</code></b> 1409 </p> 1410 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 1411 <div style="padding-left: 28px; clear: unset;"> 1412 <b style="line-height: 2;"><code>Content-Type</code></b> 1413 1414 1415 1416 <input type="text" style="display: none" 1417 name="Content-Type" data-endpoint="GETapi-v1-campaign-sources--id-" 1418 value="application/json" 1419 data-component="header"> 1420 <br> 1421<p>Example: <code>application/json</code></p> 1422 </div> 1423 <div style="padding-left: 28px; clear: unset;"> 1424 <b style="line-height: 2;"><code>Accept</code></b> 1425 1426 1427 1428 <input type="text" style="display: none" 1429 name="Accept" data-endpoint="GETapi-v1-campaign-sources--id-" 1430 value="application/json" 1431 data-component="header"> 1432 <br> 1433<p>Example: <code>application/json</code></p> 1434 </div> 1435 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 1436 <div style="padding-left: 28px; clear: unset;"> 1437 <b style="line-height: 2;"><code>id</code></b> 1438<small>integer</small> 1439 1440 1441 <input type="number" style="display: none" 1442 step="any" name="id" data-endpoint="GETapi-v1-campaign-sources--id-" 1443 value="16" 1444 data-component="url"> 1445 <br> 1446<p>The ID of the campaign source. Example: <code>16</code></p> 1447 </div> 1448 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 1449 <div style=" padding-left: 28px; clear: unset;"> 1450 <b style="line-height: 2;"><code>organization_id</code></b> 1451<small>integer</small> 1452 1453 1454 <input type="number" style="display: none" 1455 step="any" name="organization_id" data-endpoint="GETapi-v1-campaign-sources--id-" 1456 value="16" 1457 data-component="body"> 1458 <br> 1459<p>Must match an existing stored value. Example: <code>16</code></p> 1460 </div> 1461 </form> 1462 1463 <h2 id="campaign-sources-PATCHapi-v1-campaign-sources--id-">Update the specified resource in storage.</h2> 1464 1465<p> 1466</p> 1467 1468 1469 1470<span id="example-requests-PATCHapi-v1-campaign-sources--id-"> 1471<blockquote>Example request:</blockquote> 1472 1473 1474<div class="bash-example"> 1475 <pre><code class="language-bash">curl --request PATCH \ 1476 "prolinks.pro/api/v1/campaign-sources/16" \ 1477 --header "Content-Type: application/json" \ 1478 --header "Accept: application/json" \ 1479 --data "{ 1480 \"organization_id\": 16, 1481 \"name\": \"n\" 1482}" 1483</code></pre></div> 1484 1485 1486<div class="javascript-example"> 1487 <pre><code class="language-javascript">const url = new URL( 1488 "prolinks.pro/api/v1/campaign-sources/16" 1489); 1490 1491const headers = { 1492 "Content-Type": "application/json", 1493 "Accept": "application/json", 1494}; 1495 1496let body = { 1497 "organization_id": 16, 1498 "name": "n" 1499}; 1500 1501fetch(url, { 1502 method: "PATCH", 1503 headers, 1504 body: JSON.stringify(body), 1505}).then(response => response.json());</code></pre></div> 1506 1507</span> 1508 1509<span id="example-responses-PATCHapi-v1-campaign-sources--id-"> 1510</span> 1511<span id="execution-results-PATCHapi-v1-campaign-sources--id-" hidden> 1512 <blockquote>Received response<span 1513 id="execution-response-status-PATCHapi-v1-campaign-sources--id-"></span>: 1514 </blockquote> 1515 <pre class="json"><code id="execution-response-content-PATCHapi-v1-campaign-sources--id-" 1516 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 1517</span> 1518<span id="execution-error-PATCHapi-v1-campaign-sources--id-" hidden> 1519 <blockquote>Request failed with error:</blockquote> 1520 <pre><code id="execution-error-message-PATCHapi-v1-campaign-sources--id-"> 1521 1522Tip: Check that you're properly connected to the network. 1523If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 1524You can check the Dev Tools console for debugging information.</code></pre> 1525</span> 1526<form id="form-PATCHapi-v1-campaign-sources--id-" data-method="PATCH" 1527 data-path="api/v1/campaign-sources/{id}" 1528 data-authed="0" 1529 data-hasfiles="0" 1530 data-isarraybody="0" 1531 autocomplete="off" 1532 onsubmit="event.preventDefault(); executeTryOut('PATCHapi-v1-campaign-sources--id-', this);"> 1533 <h3> 1534 Request 1535 <button type="button" 1536 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1537 id="btn-tryout-PATCHapi-v1-campaign-sources--id-" 1538 onclick="tryItOut('PATCHapi-v1-campaign-sources--id-');">Try it out â¡ 1539 </button> 1540 <button type="button" 1541 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1542 id="btn-canceltryout-PATCHapi-v1-campaign-sources--id-" 1543 onclick="cancelTryOut('PATCHapi-v1-campaign-sources--id-');" hidden>Cancel ð 1544 </button> 1545 <button type="submit" 1546 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1547 id="btn-executetryout-PATCHapi-v1-campaign-sources--id-" 1548 data-initial-text="Send Request ð¥" 1549 data-loading-text="â± Sending..." 1550 hidden>Send Request ð¥ 1551 </button> 1552 </h3> 1553 <p> 1554 <small class="badge badge-purple">PATCH</small> 1555 <b><code>api/v1/campaign-sources/{id}</code></b> 1556 </p> 1557 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 1558 <div style="padding-left: 28px; clear: unset;"> 1559 <b style="line-height: 2;"><code>Content-Type</code></b> 1560 1561 1562 1563 <input type="text" style="display: none" 1564 name="Content-Type" data-endpoint="PATCHapi-v1-campaign-sources--id-" 1565 value="application/json" 1566 data-component="header"> 1567 <br> 1568<p>Example: <code>application/json</code></p> 1569 </div> 1570 <div style="padding-left: 28px; clear: unset;"> 1571 <b style="line-height: 2;"><code>Accept</code></b> 1572 1573 1574 1575 <input type="text" style="display: none" 1576 name="Accept" data-endpoint="PATCHapi-v1-campaign-sources--id-" 1577 value="application/json" 1578 data-component="header"> 1579 <br> 1580<p>Example: <code>application/json</code></p> 1581 </div> 1582 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 1583 <div style="padding-left: 28px; clear: unset;"> 1584 <b style="line-height: 2;"><code>id</code></b> 1585<small>integer</small> 1586 1587 1588 <input type="number" style="display: none" 1589 step="any" name="id" data-endpoint="PATCHapi-v1-campaign-sources--id-" 1590 value="16" 1591 data-component="url"> 1592 <br> 1593<p>The ID of the campaign source. Example: <code>16</code></p> 1594 </div> 1595 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 1596 <div style=" padding-left: 28px; clear: unset;"> 1597 <b style="line-height: 2;"><code>organization_id</code></b> 1598<small>integer</small> 1599 1600 1601 <input type="number" style="display: none" 1602 step="any" name="organization_id" data-endpoint="PATCHapi-v1-campaign-sources--id-" 1603 value="16" 1604 data-component="body"> 1605 <br> 1606<p>Must match an existing stored value. Example: <code>16</code></p> 1607 </div> 1608 <div style=" padding-left: 28px; clear: unset;"> 1609 <b style="line-height: 2;"><code>name</code></b> 1610<small>string</small> 1611 1612 1613 <input type="text" style="display: none" 1614 name="name" data-endpoint="PATCHapi-v1-campaign-sources--id-" 1615 value="n" 1616 data-component="body"> 1617 <br> 1618<p>Must not be greater than 255 characters. Example: <code>n</code></p> 1619 </div> 1620 </form> 1621 1622 <h2 id="campaign-sources-DELETEapi-v1-campaign-sources--id-">Remove the specified resource from storage.</h2> 1623 1624<p> 1625</p> 1626 1627 1628 1629<span id="example-requests-DELETEapi-v1-campaign-sources--id-"> 1630<blockquote>Example request:</blockquote> 1631 1632 1633<div class="bash-example"> 1634 <pre><code class="language-bash">curl --request DELETE \ 1635 "prolinks.pro/api/v1/campaign-sources/16" \ 1636 --header "Content-Type: application/json" \ 1637 --header "Accept: application/json" \ 1638 --data "{ 1639 \"organization_id\": 16 1640}" 1641</code></pre></div> 1642 1643 1644<div class="javascript-example"> 1645 <pre><code class="language-javascript">const url = new URL( 1646 "prolinks.pro/api/v1/campaign-sources/16" 1647); 1648 1649const headers = { 1650 "Content-Type": "application/json", 1651 "Accept": "application/json", 1652}; 1653 1654let body = { 1655 "organization_id": 16 1656}; 1657 1658fetch(url, { 1659 method: "DELETE", 1660 headers, 1661 body: JSON.stringify(body), 1662}).then(response => response.json());</code></pre></div> 1663 1664</span> 1665 1666<span id="example-responses-DELETEapi-v1-campaign-sources--id-"> 1667</span> 1668<span id="execution-results-DELETEapi-v1-campaign-sources--id-" hidden> 1669 <blockquote>Received response<span 1670 id="execution-response-status-DELETEapi-v1-campaign-sources--id-"></span>: 1671 </blockquote> 1672 <pre class="json"><code id="execution-response-content-DELETEapi-v1-campaign-sources--id-" 1673 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 1674</span> 1675<span id="execution-error-DELETEapi-v1-campaign-sources--id-" hidden> 1676 <blockquote>Request failed with error:</blockquote> 1677 <pre><code id="execution-error-message-DELETEapi-v1-campaign-sources--id-"> 1678 1679Tip: Check that you're properly connected to the network. 1680If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 1681You can check the Dev Tools console for debugging information.</code></pre> 1682</span> 1683<form id="form-DELETEapi-v1-campaign-sources--id-" data-method="DELETE" 1684 data-path="api/v1/campaign-sources/{id}" 1685 data-authed="0" 1686 data-hasfiles="0" 1687 data-isarraybody="0" 1688 autocomplete="off" 1689 onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-campaign-sources--id-', this);"> 1690 <h3> 1691 Request 1692 <button type="button" 1693 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1694 id="btn-tryout-DELETEapi-v1-campaign-sources--id-" 1695 onclick="tryItOut('DELETEapi-v1-campaign-sources--id-');">Try it out â¡ 1696 </button> 1697 <button type="button" 1698 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1699 id="btn-canceltryout-DELETEapi-v1-campaign-sources--id-" 1700 onclick="cancelTryOut('DELETEapi-v1-campaign-sources--id-');" hidden>Cancel ð 1701 </button> 1702 <button type="submit" 1703 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1704 id="btn-executetryout-DELETEapi-v1-campaign-sources--id-" 1705 data-initial-text="Send Request ð¥" 1706 data-loading-text="â± Sending..." 1707 hidden>Send Request ð¥ 1708 </button> 1709 </h3> 1710 <p> 1711 <small class="badge badge-red">DELETE</small> 1712 <b><code>api/v1/campaign-sources/{id}</code></b> 1713 </p> 1714 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 1715 <div style="padding-left: 28px; clear: unset;"> 1716 <b style="line-height: 2;"><code>Content-Type</code></b> 1717 1718 1719 1720 <input type="text" style="display: none" 1721 name="Content-Type" data-endpoint="DELETEapi-v1-campaign-sources--id-" 1722 value="application/json" 1723 data-component="header"> 1724 <br> 1725<p>Example: <code>application/json</code></p> 1726 </div> 1727 <div style="padding-left: 28px; clear: unset;"> 1728 <b style="line-height: 2;"><code>Accept</code></b> 1729 1730 1731 1732 <input type="text" style="display: none" 1733 name="Accept" data-endpoint="DELETEapi-v1-campaign-sources--id-" 1734 value="application/json" 1735 data-component="header"> 1736 <br> 1737<p>Exa
1737mple: <code>application/json</code></p> 1738 </div> 1739 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 1740 <div style="padding-left: 28px; clear: unset;"> 1741 <b style="line-height: 2;"><code>id</code></b> 1742<small>integer</small> 1743 1744 1745 <input type="number" style="display: none" 1746 step="any" name="id" data-endpoint="DELETEapi-v1-campaign-sources--id-" 1747 value="16" 1748 data-component="url"> 1749 <br> 1750<p>The ID of the campaign source. Example: <code>16</code></p> 1751 </div> 1752 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 1753 <div style=" padding-left: 28px; clear: unset;"> 1754 <b style="line-height: 2;"><code>organization_id</code></b> 1755<small>integer</small> 1756 1757 1758 <input type="number" style="display: none" 1759 step="any" name="organization_id" data-endpoint="DELETEapi-v1-campaign-sources--id-" 1760 value="16" 1761 data-component="body"> 1762 <br> 1763<p>Must match an existing stored value. Example: <code>16</code></p> 1764 </div> 1765 </form> 1766 1767 <h1 id="domains">Domains</h1> 1768 1769 1770 1771 <h2 id="domains-GETapi-v1-domains">GET api/v1/domains</h2> 1772 1773<p> 1774</p> 1775 1776 1777 1778<span id="example-requests-GETapi-v1-domains"> 1779<blockquote>Example request:</blockquote> 1780 1781 1782<div class="bash-example"> 1783 <pre><code class="language-bash">curl --request GET \ 1784 --get "prolinks.pro/api/v1/domains" \ 1785 --header "Content-Type: application/json" \ 1786 --header "Accept: application/json" \ 1787 --data "{ 1788 \"organization_id\": 16 1789}" 1790</code></pre></div> 1791 1792 1793<div class="javascript-example"> 1794 <pre><code class="language-javascript">const url = new URL( 1795 "prolinks.pro/api/v1/domains" 1796); 1797 1798const headers = { 1799 "Content-Type": "application/json", 1800 "Accept": "application/json", 1801}; 1802 1803let body = { 1804 "organization_id": 16 1805}; 1806 1807fetch(url, { 1808 method: "GET", 1809 headers, 1810 body: JSON.stringify(body), 1811}).then(response => response.json());</code></pre></div> 1812 1813</span> 1814 1815<span id="example-responses-GETapi-v1-domains"> 1816 <blockquote> 1817 <p>Example response (401):</p> 1818 </blockquote> 1819 <details class="annotation"> 1820 <summary style="cursor: pointer;"> 1821 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 1822 </summary> 1823 <pre><code class="language-http">cache-control: no-cache, private 1824content-type: application/json 1825access-control-allow-origin: * 1826 </code></pre></details> <pre> 1827 1828<code class="language-json" style="max-height: 300px;">{ 1829 "message": "Unauthenticated." 1830}</code> 1831 </pre> 1832 </span> 1833<span id="execution-results-GETapi-v1-domains" hidden> 1834 <blockquote>Received response<span 1835 id="execution-response-status-GETapi-v1-domains"></span>: 1836 </blockquote> 1837 <pre class="json"><code id="execution-response-content-GETapi-v1-domains" 1838 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 1839</span> 1840<span id="execution-error-GETapi-v1-domains" hidden> 1841 <blockquote>Request failed with error:</blockquote> 1842 <pre><code id="execution-error-message-GETapi-v1-domains"> 1843 1844Tip: Check that you're properly connected to the network. 1845If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 1846You can check the Dev Tools console for debugging information.</code></pre> 1847</span> 1848<form id="form-GETapi-v1-domains" data-method="GET" 1849 data-path="api/v1/domains" 1850 data-authed="0" 1851 data-hasfiles="0" 1852 data-isarraybody="0" 1853 autocomplete="off" 1854 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-domains', this);"> 1855 <h3> 1856 Request 1857 <button type="button" 1858 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1859 id="btn-tryout-GETapi-v1-domains" 1860 onclick="tryItOut('GETapi-v1-domains');">Try it out â¡ 1861 </button> 1862 <button type="button" 1863 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1864 id="btn-canceltryout-GETapi-v1-domains" 1865 onclick="cancelTryOut('GETapi-v1-domains');" hidden>Cancel ð 1866 </button> 1867 <button type="submit" 1868 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1869 id="btn-executetryout-GETapi-v1-domains" 1870 data-initial-text="Send Request ð¥" 1871 data-loading-text="â± Sending..." 1872 hidden>Send Request ð¥ 1873 </button> 1874 </h3> 1875 <p> 1876 <small class="badge badge-green">GET</small> 1877 <b><code>api/v1/domains</code></b> 1878 </p> 1879 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 1880 <div style="padding-left: 28px; clear: unset;"> 1881 <b style="line-height: 2;"><code>Content-Type</code></b> 1882 1883 1884 1885 <input type="text" style="display: none" 1886 name="Content-Type" data-endpoint="GETapi-v1-domains" 1887 value="application/json" 1888 data-component="header"> 1889 <br> 1890<p>Example: <code>application/json</code></p> 1891 </div> 1892 <div style="padding-left: 28px; clear: unset;"> 1893 <b style="line-height: 2;"><code>Accept</code></b> 1894 1895 1896 1897 <input type="text" style="display: none" 1898 name="Accept" data-endpoint="GETapi-v1-domains" 1899 value="application/json" 1900 data-component="header"> 1901 <br> 1902<p>Example: <code>application/json</code></p> 1903 </div> 1904 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 1905 <div style=" padding-left: 28px; clear: unset;"> 1906 <b style="line-height: 2;"><code>organization_id</code></b> 1907<small>integer</small> 1908 1909 1910 <input type="number" style="display: none" 1911 step="any" name="organization_id" data-endpoint="GETapi-v1-domains" 1912 value="16" 1913 data-component="body"> 1914 <br> 1915<p>Must match an existing stored value. Example: <code>16</code></p> 1916 </div> 1917 </form> 1918 1919 <h2 id="domains-POSTapi-v1-domains">POST api/v1/domains</h2> 1920 1921<p> 1922</p> 1923 1924 1925 1926<span id="example-requests-POSTapi-v1-domains"> 1927<blockquote>Example request:</blockquote> 1928 1929 1930<div class="bash-example"> 1931 <pre><code class="language-bash">curl --request POST \ 1932 "prolinks.pro/api/v1/domains" \ 1933 --header "Content-Type: application/json" \ 1934 --header "Accept: application/json" \ 1935 --data "{ 1936 \"organization_id\": 16, 1937 \"name\": \"n\", 1938 \"redirect_url\": \"http:\\/\\/crooks.biz\\/et-fugiat-sunt-nihil-accusantium\" 1939}" 1940</code></pre></div> 1941 1942 1943<div class="javascript-example"> 1944 <pre><code class="language-javascript">const url = new URL( 1945 "prolinks.pro/api/v1/domains" 1946); 1947 1948const headers = { 1949 "Content-Type": "application/json", 1950 "Accept": "application/json", 1951}; 1952 1953let body = { 1954 "organization_id": 16, 1955 "name": "n", 1956 "redirect_url": "http:\/\/crooks.biz\/et-fugiat-sunt-nihil-accusantium" 1957}; 1958 1959fetch(url, { 1960 method: "POST", 1961 headers, 1962 body: JSON.stringify(body), 1963}).then(response => response.json());</code></pre></div> 1964 1965</span> 1966 1967<span id="example-responses-POSTapi-v1-domains"> 1968</span> 1969<span id="execution-results-POSTapi-v1-domains" hidden> 1970 <blockquote>Received response<span 1971 id="execution-response-status-POSTapi-v1-domains"></span>: 1972 </blockquote> 1973 <pre class="json"><code id="execution-response-content-POSTapi-v1-domains" 1974 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 1975</span> 1976<span id="execution-error-POSTapi-v1-domains" hidden> 1977 <blockquote>Request failed with error:</blockquote> 1978 <pre><code id="execution-error-message-POSTapi-v1-domains"> 1979 1980Tip: Check that you're properly connected to the network. 1981If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 1982You can check the Dev Tools console for debugging information.</code></pre> 1983</span> 1984<form id="form-POSTapi-v1-domains" data-method="POST" 1985 data-path="api/v1/domains" 1986 data-authed="0" 1987 data-hasfiles="0" 1988 data-isarraybody="0" 1989 autocomplete="off" 1990 onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-domains', this);"> 1991 <h3> 1992 Request 1993 <button type="button" 1994 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 1995 id="btn-tryout-POSTapi-v1-domains" 1996 onclick="tryItOut('POSTapi-v1-domains');">Try it out â¡ 1997 </button> 1998 <button type="button" 1999 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2000 id="btn-canceltryout-POSTapi-v1-domains" 2001 onclick="cancelTryOut('POSTapi-v1-domains');" hidden>Cancel ð 2002 </button> 2003 <button type="submit" 2004 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2005 id="btn-executetryout-POSTapi-v1-domains" 2006 data-initial-text="Send Request ð¥" 2007 data-loading-text="â± Sending..." 2008 hidden>Send Request ð¥ 2009 </button> 2010 </h3> 2011 <p> 2012 <small class="badge badge-black">POST</small> 2013 <b><code>api/v1/domains</code></b> 2014 </p> 2015 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 2016 <div style="padding-left: 28px; clear: unset;"> 2017 <b style="line-height: 2;"><code>Content-Type</code></b> 2018 2019 2020 2021 <input type="text" style="display: none" 2022 name="Content-Type" data-endpoint="POSTapi-v1-domains" 2023 value="application/json" 2024 data-component="header"> 2025 <br> 2026<p>Example: <code>application/json</code></p> 2027 </div> 2028 <div style="padding-left: 28px; clear: unset;"> 2029 <b style="line-height: 2;"><code>Accept</code></b> 2030 2031 2032 2033 <input type="text" style="display: none" 2034 name="Accept" data-endpoint="POSTapi-v1-domains" 2035 value="application/json" 2036 data-component="header"> 2037 <br> 2038<p>Example: <code>application/json</code></p> 2039 </div> 2040 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 2041 <div style=" padding-left: 28px; clear: unset;"> 2042 <b style="line-height: 2;"><code>organization_id</code></b> 2043<small>integer</small> 2044 2045 2046 <input type="number" style="display: none" 2047 step="any" name="organization_id" data-endpoint="POSTapi-v1-domains" 2048 value="16" 2049 data-component="body"> 2050 <br> 2051<p>Must match an existing stored value. Example: <code>16</code></p> 2052 </div> 2053 <div style=" padding-left: 28px; clear: unset;"> 2054 <b style="line-height: 2;"><code>name</code></b> 2055<small>string</small> 2056 2057 2058 <input type="text" style="display: none" 2059 name="name" data-endpoint="POSTapi-v1-domains" 2060 value="n" 2061 data-component="body"> 2062 <br> 2063<p>Must not be greater than 255 characters. Example: <code>n</code></p> 2064 </div> 2065 <div style=" padding-left: 28px; clear: unset;"> 2066 <b style="line-height: 2;"><code>redirect_url</code></b> 2067<small>string</small> 2068<i>optional</i> 2069 2070 <input type="text" style="display: none" 2071 name="redirect_url" data-endpoint="POSTapi-v1-domains" 2072 value="http://crooks.biz/et-fugiat-sunt-nihil-accusantium" 2073 data-component="body"> 2074 <br> 2075<p>Must be a valid URL. Must not be greater than 2048 characters. Example: <code>http://crooks.biz/et-fugiat-sunt-nihil-accusantium</code></p> 2076 </div> 2077 </form> 2078 2079 <h2 id="domains-GETapi-v1-domains--id-">GET api/v1/domains/{id}</h2> 2080 2081<p> 2082</p> 2083 2084 2085 2086<span id="example-requests-GETapi-v1-domains--id-"> 2087<blockquote>Example request:</blockquote> 2088 2089 2090<div class="bash-example"> 2091 <pre><code class="language-bash">curl --request GET \ 2092 --get "prolinks.pro/api/v1/domains/1" \ 2093 --header "Content-Type: application/json" \ 2094 --header "Accept: application/json" \ 2095 --data "{ 2096 \"organization_id\": 16 2097}" 2098</code></pre></div> 2099 2100 2101<div class="javascript-example"> 2102 <pre><code class="language-javascript">const url = new URL( 2103 "prolinks.pro/api/v1/domains/1" 2104); 2105 2106const headers = { 2107 "Content-Type": "application/json", 2108 "Accept": "application/json", 2109}; 2110 2111let body = { 2112 "organization_id": 16 2113}; 2114 2115fetch(url, { 2116 method: "GET", 2117 headers, 2118 body: JSON.stringify(body), 2119}).then(response => response.json());</code></pre></div> 2120 2121</span> 2122 2123<span id="example-responses-GETapi-v1-domains--id-"> 2124 <blockquote> 2125 <p>
2125Example response (401):</p> 2126 </blockquote> 2127 <details class="annotation"> 2128 <summary style="cursor: pointer;"> 2129 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 2130 </summary> 2131 <pre><code class="language-http">cache-control: no-cache, private 2132content-type: application/json 2133access-control-allow-origin: * 2134 </code></pre></details> <pre> 2135 2136<code class="language-json" style="max-height: 300px;">{ 2137 "message": "Unauthenticated." 2138}</code> 2139 </pre> 2140 </span> 2141<span id="execution-results-GETapi-v1-domains--id-" hidden> 2142 <blockquote>Received response<span 2143 id="execution-response-status-GETapi-v1-domains--id-"></span>: 2144 </blockquote> 2145 <pre class="json"><code id="execution-response-content-GETapi-v1-domains--id-" 2146 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 2147</span> 2148<span id="execution-error-GETapi-v1-domains--id-" hidden> 2149 <blockquote>Request failed with error:</blockquote> 2150 <pre><code id="execution-error-message-GETapi-v1-domains--id-"> 2151 2152Tip: Check that you're properly connected to the network. 2153If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 2154You can check the Dev Tools console for debugging information.</code></pre> 2155</span> 2156<form id="form-GETapi-v1-domains--id-" data-method="GET" 2157 data-path="api/v1/domains/{id}" 2158 data-authed="0" 2159 data-hasfiles="0" 2160 data-isarraybody="0" 2161 autocomplete="off" 2162 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-domains--id-', this);"> 2163 <h3> 2164 Request 2165 <button type="button" 2166 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2167 id="btn-tryout-GETapi-v1-domains--id-" 2168 onclick="tryItOut('GETapi-v1-domains--id-');">Try it out â¡ 2169 </button> 2170 <button type="button" 2171 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2172 id="btn-canceltryout-GETapi-v1-domains--id-" 2173 onclick="cancelTryOut('GETapi-v1-domains--id-');" hidden>Cancel ð 2174 </button> 2175 <button type="submit" 2176 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2177 id="btn-executetryout-GETapi-v1-domains--id-" 2178 data-initial-text="Send Request ð¥" 2179 data-loading-text="â± Sending..." 2180 hidden>Send Request ð¥ 2181 </button> 2182 </h3> 2183 <p> 2184 <small class="badge badge-green">GET</small> 2185 <b><code>api/v1/domains/{id}</code></b> 2186 </p> 2187 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 2188 <div style="padding-left: 28px; clear: unset;"> 2189 <b style="line-height: 2;"><code>Content-Type</code></b> 2190 2191 2192 2193 <input type="text" style="display: none" 2194 name="Content-Type" data-endpoint="GETapi-v1-domains--id-" 2195 value="application/json" 2196 data-component="header"> 2197 <br> 2198<p>Example: <code>application/json</code></p> 2199 </div> 2200 <div style="padding-left: 28px; clear: unset;"> 2201 <b style="line-height: 2;"><code>Accept</code></b> 2202 2203 2204 2205 <input type="text" style="display: none" 2206 name="Accept" data-endpoint="GETapi-v1-domains--id-" 2207 value="application/json" 2208 data-component="header"> 2209 <br> 2210<p>Example: <code>application/json</code></p> 2211 </div> 2212 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 2213 <div style="padding-left: 28px; clear: unset;"> 2214 <b style="line-height: 2;"><code>id</code></b> 2215<small>integer</small> 2216 2217 2218 <input type="number" style="display: none" 2219 step="any" name="id" data-endpoint="GETapi-v1-domains--id-" 2220 value="1" 2221 data-component="url"> 2222 <br> 2223<p>The ID of the domain. Example: <code>1</code></p> 2224 </div> 2225 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 2226 <div style=" padding-left: 28px; clear: unset;"> 2227 <b style="line-height: 2;"><code>organization_id</code></b> 2228<small>integer</small> 2229 2230 2231 <input type="number" style="display: none" 2232 step="any" name="organization_id" data-endpoint="GETapi-v1-domains--id-" 2233 value="16" 2234 data-component="body"> 2235 <br> 2236<p>Must match an existing stored value. Example: <code>16</code></p> 2237 </div> 2238 </form> 2239 2240 <h2 id="domains-PATCHapi-v1-domains--id-">PATCH api/v1/domains/{id}</h2> 2241 2242<p> 2243</p> 2244 2245 2246 2247<span id="example-requests-PATCHapi-v1-domains--id-"> 2248<blockquote>Example request:</blockquote> 2249 2250 2251<div class="bash-example"> 2252 <pre><code class="language-bash">curl --request PATCH \ 2253 "prolinks.pro/api/v1/domains/1" \ 2254 --header "Content-Type: application/json" \ 2255 --header "Accept: application/json" \ 2256 --data "{ 2257 \"organization_id\": 16, 2258 \"name\": \"n\", 2259 \"redirect_url\": \"http:\\/\\/crooks.biz\\/et-fugiat-sunt-nihil-accusantium\" 2260}" 2261</code></pre></div> 2262 2263 2264<div class="javascript-example"> 2265 <pre><code class="language-javascript">const url = new URL( 2266 "prolinks.pro/api/v1/domains/1" 2267); 2268 2269const headers = { 2270 "Content-Type": "application/json", 2271 "Accept": "application/json", 2272}; 2273 2274let body = { 2275 "organization_id": 16, 2276 "name": "n", 2277 "redirect_url": "http:\/\/crooks.biz\/et-fugiat-sunt-nihil-accusantium" 2278}; 2279 2280fetch(url, { 2281 method: "PATCH", 2282 headers, 2283 body: JSON.stringify(body), 2284}).then(response => response.json());</code></pre></div> 2285 2286</span> 2287 2288<span id="example-responses-PATCHapi-v1-domains--id-"> 2289</span> 2290<span id="execution-results-PATCHapi-v1-domains--id-" hidden> 2291 <blockquote>Received response<span 2292 id="execution-response-status-PATCHapi-v1-domains--id-"></span>: 2293 </blockquote> 2294 <pre class="json"><code id="execution-response-content-PATCHapi-v1-domains--id-" 2295 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 2296</span> 2297<span id="execution-error-PATCHapi-v1-domains--id-" hidden> 2298 <blockquote>Request failed with error:</blockquote> 2299 <pre><code id="execution-error-message-PATCHapi-v1-domains--id-"> 2300 2301Tip: Check that you're properly connected to the network. 2302If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 2303You can check the Dev Tools console for debugging information.</code></pre> 2304</span> 2305<form id="form-PATCHapi-v1-domains--id-" data-method="PATCH" 2306 data-path="api/v1/domains/{id}" 2307 data-authed="0" 2308 data-hasfiles="0" 2309 data-isarraybody="0" 2310 autocomplete="off" 2311 onsubmit="event.preventDefault(); executeTryOut('PATCHapi-v1-domains--id-', this);"> 2312 <h3> 2313 Request 2314 <button type="button" 2315 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2316 id="btn-tryout-PATCHapi-v1-domains--id-" 2317 onclick="tryItOut('PATCHapi-v1-domains--id-');">Try it out â¡ 2318 </button> 2319 <button type="button" 2320 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2321 id="btn-canceltryout-PATCHapi-v1-domains--id-" 2322 onclick="cancelTryOut('PATCHapi-v1-domains--id-');" hidden>Cancel ð 2323 </button> 2324 <button type="submit" 2325 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2326 id="btn-executetryout-PATCHapi-v1-domains--id-" 2327 data-initial-text="Send Request ð¥" 2328 data-loading-text="â± Sending..." 2329 hidden>Send Request ð¥ 2330 </button> 2331 </h3> 2332 <p> 2333 <small class="badge badge-purple">PATCH</small> 2334 <b><code>api/v1/domains/{id}</code></b> 2335 </p> 2336 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 2337 <div style="padding-left: 28px; clear: unset;"> 2338 <b style="line-height: 2;"><code>Content-Type</code></b> 2339 2340 2341 2342 <input type="text" style="display: none" 2343 name="Content-Type" data-endpoint="PATCHapi-v1-domains--id-" 2344 value="application/json" 2345 data-component="header"> 2346 <br> 2347<p>Example: <code>application/json</code></p> 2348 </div> 2349 <div style="padding-left: 28px; clear: unset;"> 2350 <b style="line-height: 2;"><code>Accept</code></b> 2351 2352 2353 2354 <input type="text" style="display: none" 2355 name="Accept" data-endpoint="PATCHapi-v1-domains--id-" 2356 value="application/json" 2357 data-component="header"> 2358 <br> 2359<p>Example: <code>application/json</code></p> 2360 </div> 2361 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 2362 <div style="padding-left: 28px; clear: unset;"> 2363 <b style="line-height: 2;"><code>id</code></b> 2364<small>integer</small> 2365 2366 2367 <input type="number" style="display: none" 2368 step="any" name="id" data-endpoint="PATCHapi-v1-domains--id-" 2369 value="1" 2370 data-component="url"> 2371 <br> 2372<p>The ID of the domain. Example: <code>1</code></p> 2373 </div> 2374 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 2375 <div style=" padding-left: 28px; clear: unset;"> 2376 <b style="line-height: 2;"><code>organization_id</code></b> 2377<small>integer</small> 2378 2379 2380 <input type="number" style="display: none" 2381 step="any" name="organization_id" data-endpoint="PATCHapi-v1-domains--id-" 2382 value="16" 2383 data-component="body"> 2384 <br> 2385<p>Must match an existing stored value. Example: <code>16</code></p> 2386 </div> 2387 <div style=" padding-left: 28px; clear: unset;"> 2388 <b style="line-height: 2;"><code>name</code></b> 2389<small>string</small> 2390 2391 2392 <input type="text" style="display: none" 2393 name="name" data-endpoint="PATCHapi-v1-domains--id-" 2394 value="n" 2395 data-component="body"> 2396 <br> 2397<p>Must not be greater than 255 characters. Example: <code>n</code></p> 2398 </div> 2399 <div style=" padding-left: 28px; clear: unset;"> 2400 <b style="line-height: 2;"><code>redirect_url</code></b> 2401<small>string</small> 2402<i>optional</i> 2403 2404 <input type="text" style="display: none" 2405 name="redirect_url" data-endpoint="PATCHapi-v1-domains--id-" 2406 value="http://crooks.biz/et-fugiat-sunt-nihil-accusantium" 2407 data-component="body"> 2408 <br> 2409<p>Must be a valid URL. Must not be greater than 2048 characters. Example: <code>http://crooks.biz/et-fugiat-sunt-nihil-accusantium</code></p> 2410 </div> 2411 </form> 2412 2413 <h2 id="domains-DELETEapi-v1-domains--id-">DELETE api/v1/domains/{id}</h2> 2414 2415<p> 2416</p> 2417 2418 2419 2420<span id="example-requests-DELETEapi-v1-domains--id-"> 2421<blockquote>Example request:</blockquote> 2422 2423 2424<div class="bash-example"> 2425 <pre><code class="language-bash">curl --request DELETE \ 2426 "prolinks.pro/api/v1/domains/1" \ 2427 --header "Content-Type: application/json" \ 2428 --header "Accept: application/json" \ 2429 --data "{ 2430 \"organization_id\": 16 2431}" 2432</code></pre></div> 2433 2434 2435<div class="javascript-example"> 2436 <pre><code class="language-javascript">const url = new URL( 2437 "prolinks.pro/api/v1/domains/1" 2438); 2439 2440const headers = { 2441 "Content-Type": "application/json", 2442 "Accept": "application/json", 2443}; 2444 2445let body = { 2446 "organization_id": 16 2447}; 2448 2449fetch(url, { 2450 method: "DELETE", 2451 headers, 2452 body: JSON.stringify(body), 2453}).then(response => response.json());</code></pre></div> 2454 2455</span> 2456 2457<span id="example-responses-DELETEapi-v1-domains--id-"> 2458</span> 2459<span id="execution-results-DELETEapi-v1-domains--id-" hidden> 2460 <blockquote>Received response<span 2461 id="execution-response-status-DELETEapi-v1-domains--id-"></span>: 2462 </blockquote> 2463 <pre class="json"><code id="execution-response-content-DELETEapi-v1-domains--id-" 2464 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 2465</span> 2466<span id="execution-error-DELETEapi-v1-domains--id-" hidden> 2467 <blockquote>Request failed with error:</blockquote> 2468 <pre><code id="execution-error-message-DELETEapi-v1-domains--id-"> 2469 2470Tip: Check that you're properly connected to the network. 2471If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 2472You can check the Dev Tools console for debugging information.</code></pre> 2473</span> 2474<form id="form-DELETEapi-v1-domains--id-" data-method="DELETE" 2475 data-path="api/v1/domains/{id}" 2476 data-authed="0" 2477 data-hasfiles="0" 2478 data-isarraybody="0" 2479 autocomplete="off" 2480 onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-domains--id-', this);"> 2481 <h3> 2482 Request 2483 <button type="button" 2484 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2485 id="btn-tryout-DELETEapi-v1-domains--id-" 2486 onclick="tryItOut('DELETEapi-v1-domains--id-');">Try it out â¡ 2487 </button> 2488 <button type="button" 2489 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2490 id="btn-canceltryout-DELETEapi-v1-domains--id-" 2491 onclick="cancelTryOut('DELETEapi-v1-domains--id-');" hidden>Cancel ð 2492 </button> 2493 <button type="submit" 2494 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2495 id="btn-executetryout-DELETEapi-v1-domains--id-" 2496 data-initial-text="Send Request ð¥" 2497 data-loading-text="â± Sending..." 2498 hidden>Send Request ð¥ 2499 </button> 2500 </h3> 2501 <p> 2502 <small class="badge badge-red">DELETE</small> 2503 <b><code>api/v1/domains/{id}</code></b> 2504 </p> 2505 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 2506 <div style="padding-left: 28px; clear: unset;"> 2507 <b style="line-height: 2;"><code>Content-Type</code></b> 2508 2509 2510 2511 <input type="text" style="display: none" 2512 name="Content-Type" data-endpoint="DELETEapi-v1-domains--id-" 2513 value="application/json" 2514 data-component="header"> 2515 <br> 2516<p>Example: <code>application/json</code></p> 2517 </div> 2518 <div style="padding-left: 28px; clear: unset;"> 2519 <b style="line-height: 2;"><code>Accept</code></b> 2520 2521 2522 2523 <input type="text" style="display: none" 2524 n
2524ame="Accept" data-endpoint="DELETEapi-v1-domains--id-" 2525 value="application/json" 2526 data-component="header"> 2527 <br> 2528<p>Example: <code>application/json</code></p> 2529 </div> 2530 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 2531 <div style="padding-left: 28px; clear: unset;"> 2532 <b style="line-height: 2;"><code>id</code></b> 2533<small>integer</small> 2534 2535 2536 <input type="number" style="display: none" 2537 step="any" name="id" data-endpoint="DELETEapi-v1-domains--id-" 2538 value="1" 2539 data-component="url"> 2540 <br> 2541<p>The ID of the domain. Example: <code>1</code></p> 2542 </div> 2543 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 2544 <div style=" padding-left: 28px; clear: unset;"> 2545 <b style="line-height: 2;"><code>organization_id</code></b> 2546<small>integer</small> 2547 2548 2549 <input type="number" style="display: none" 2550 step="any" name="organization_id" data-endpoint="DELETEapi-v1-domains--id-" 2551 value="16" 2552 data-component="body"> 2553 <br> 2554<p>Must match an existing stored value. Example: <code>16</code></p> 2555 </div> 2556 </form> 2557 2558 <h1 id="endpoints">Endpoints</h1> 2559 2560 2561 2562 <h2 id="endpoints-GETapi-user">GET api/user</h2> 2563 2564<p> 2565</p> 2566 2567 2568 2569<span id="example-requests-GETapi-user"> 2570<blockquote>Example request:</blockquote> 2571 2572 2573<div class="bash-example"> 2574 <pre><code class="language-bash">curl --request GET \ 2575 --get "prolinks.pro/api/user" \ 2576 --header "Content-Type: application/json" \ 2577 --header "Accept: application/json"</code></pre></div> 2578 2579 2580<div class="javascript-example"> 2581 <pre><code class="language-javascript">const url = new URL( 2582 "prolinks.pro/api/user" 2583); 2584 2585const headers = { 2586 "Content-Type": "application/json", 2587 "Accept": "application/json", 2588}; 2589 2590 2591fetch(url, { 2592 method: "GET", 2593 headers, 2594}).then(response => response.json());</code></pre></div> 2595 2596</span> 2597 2598<span id="example-responses-GETapi-user"> 2599 <blockquote> 2600 <p>Example response (401):</p> 2601 </blockquote> 2602 <details class="annotation"> 2603 <summary style="cursor: pointer;"> 2604 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 2605 </summary> 2606 <pre><code class="language-http">cache-control: no-cache, private 2607content-type: application/json 2608access-control-allow-origin: * 2609 </code></pre></details> <pre> 2610 2611<code class="language-json" style="max-height: 300px;">{ 2612 "message": "Unauthenticated." 2613}</code> 2614 </pre> 2615 </span> 2616<span id="execution-results-GETapi-user" hidden> 2617 <blockquote>Received response<span 2618 id="execution-response-status-GETapi-user"></span>: 2619 </blockquote> 2620 <pre class="json"><code id="execution-response-content-GETapi-user" 2621 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 2622</span> 2623<span id="execution-error-GETapi-user" hidden> 2624 <blockquote>Request failed with error:</blockquote> 2625 <pre><code id="execution-error-message-GETapi-user"> 2626 2627Tip: Check that you're properly connected to the network. 2628If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 2629You can check the Dev Tools console for debugging information.</code></pre> 2630</span> 2631<form id="form-GETapi-user" data-method="GET" 2632 data-path="api/user" 2633 data-authed="0" 2634 data-hasfiles="0" 2635 data-isarraybody="0" 2636 autocomplete="off" 2637 onsubmit="event.preventDefault(); executeTryOut('GETapi-user', this);"> 2638 <h3> 2639 Request 2640 <button type="button" 2641 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2642 id="btn-tryout-GETapi-user" 2643 onclick="tryItOut('GETapi-user');">Try it out â¡ 2644 </button> 2645 <button type="button" 2646 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2647 id="btn-canceltryout-GETapi-user" 2648 onclick="cancelTryOut('GETapi-user');" hidden>Cancel ð 2649 </button> 2650 <button type="submit" 2651 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2652 id="btn-executetryout-GETapi-user" 2653 data-initial-text="Send Request ð¥" 2654 data-loading-text="â± Sending..." 2655 hidden>Send Request ð¥ 2656 </button> 2657 </h3> 2658 <p> 2659 <small class="badge badge-green">GET</small> 2660 <b><code>api/user</code></b> 2661 </p> 2662 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 2663 <div style="padding-left: 28px; clear: unset;"> 2664 <b style="line-height: 2;"><code>Content-Type</code></b> 2665 2666 2667 2668 <input type="text" style="display: none" 2669 name="Content-Type" data-endpoint="GETapi-user" 2670 value="application/json" 2671 data-component="header"> 2672 <br> 2673<p>Example: <code>application/json</code></p> 2674 </div> 2675 <div style="padding-left: 28px; clear: unset;"> 2676 <b style="line-height: 2;"><code>Accept</code></b> 2677 2678 2679 2680 <input type="text" style="display: none" 2681 name="Accept" data-endpoint="GETapi-user" 2682 value="application/json" 2683 data-component="header"> 2684 <br> 2685<p>Example: <code>application/json</code></p> 2686 </div> 2687 </form> 2688 2689 <h2 id="endpoints-GETapi-v1-user">GET api/v1/user</h2> 2690 2691<p> 2692</p> 2693 2694 2695 2696<span id="example-requests-GETapi-v1-user"> 2697<blockquote>Example request:</blockquote> 2698 2699 2700<div class="bash-example"> 2701 <pre><code class="language-bash">curl --request GET \ 2702 --get "prolinks.pro/api/v1/user" \ 2703 --header "Content-Type: application/json" \ 2704 --header "Accept: application/json"</code></pre></div> 2705 2706 2707<div class="javascript-example"> 2708 <pre><code class="language-javascript">const url = new URL( 2709 "prolinks.pro/api/v1/user" 2710); 2711 2712const headers = { 2713 "Content-Type": "application/json", 2714 "Accept": "application/json", 2715}; 2716 2717 2718fetch(url, { 2719 method: "GET", 2720 headers, 2721}).then(response => response.json());</code></pre></div> 2722 2723</span> 2724 2725<span id="example-responses-GETapi-v1-user"> 2726 <blockquote> 2727 <p>
2727Example response (401):</p> 2728 </blockquote> 2729 <details class="annotation"> 2730 <summary style="cursor: pointer;"> 2731 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 2732 </summary> 2733 <pre><code class="language-http">cache-control: no-cache, private 2734content-type: application/json 2735access-control-allow-origin: * 2736 </code></pre></details> <pre> 2737 2738<code class="language-json" style="max-height: 300px;">{ 2739 "message": "Unauthenticated." 2740}</code> 2741 </pre> 2742 </span> 2743<span id="execution-results-GETapi-v1-user" hidden> 2744 <blockquote>Received response<span 2745 id="execution-response-status-GETapi-v1-user"></span>: 2746 </blockquote> 2747 <pre class="json"><code id="execution-response-content-GETapi-v1-user" 2748 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 2749</span> 2750<span id="execution-error-GETapi-v1-user" hidden> 2751 <blockquote>Request failed with error:</blockquote> 2752 <pre><code id="execution-error-message-GETapi-v1-user"> 2753 2754Tip: Check that you're properly connected to the network. 2755If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 2756You can check the Dev Tools console for debugging information.</code></pre> 2757</span> 2758<form id="form-GETapi-v1-user" data-method="GET" 2759 data-path="api/v1/user" 2760 data-authed="0" 2761 data-hasfiles="0" 2762 data-isarraybody="0" 2763 autocomplete="off" 2764 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-user', this);"> 2765 <h3> 2766 Request 2767 <button type="button" 2768 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2769 id="btn-tryout-GETapi-v1-user" 2770 onclick="tryItOut('GETapi-v1-user');">Try it out â¡ 2771 </button> 2772 <button type="button" 2773 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2774 id="btn-canceltryout-GETapi-v1-user" 2775 onclick="cancelTryOut('GETapi-v1-user');" hidden>Cancel ð 2776 </button> 2777 <button type="submit" 2778 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2779 id="btn-executetryout-GETapi-v1-user" 2780 data-initial-text="Send Request ð¥" 2781 data-loading-text="â± Sending..." 2782 hidden>Send Request ð¥ 2783 </button> 2784 </h3> 2785 <p> 2786 <small class="badge badge-green">GET</small> 2787 <b><code>api/v1/user</code></b> 2788 </p> 2789 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 2790 <div style="padding-left: 28px; clear: unset;"> 2791 <b style="line-height: 2;"><code>Content-Type</code></b> 2792 2793 2794 2795 <input type="text" style="display: none" 2796 name="Content-Type" data-endpoint="GETapi-v1-user" 2797 value="application/json" 2798 data-component="header"> 2799 <br> 2800<p>Example: <code>application/json</code></p> 2801 </div> 2802 <div style="padding-left: 28px; clear: unset;"> 2803 <b style="line-height: 2;"><code>Accept</code></b> 2804 2805 2806 2807 <input type="text" style="display: none" 2808 name="Accept" data-endpoint="GETapi-v1-user" 2809 value="application/json" 2810 data-component="header"> 2811 <br> 2812<p>Example: <code>application/json</code></p> 2813 </div> 2814 </form> 2815 2816 <h1 id="links">Links</h1> 2817 2818 2819 2820 <h2 id="links-GETapi-v1-links">GET api/v1/links</h2> 2821 2822<p> 2823</p> 2824 2825 2826 2827<span id="example-requests-GETapi-v1-links"> 2828<blockquote>Example request:</blockquote> 2829 2830 2831<div class="bash-example"> 2832 <pre><code class="language-bash">curl --request GET \ 2833 --get "prolinks.pro/api/v1/links" \ 2834 --header "Content-Type: application/json" \ 2835 --header "Accept: application/json" \ 2836 --data "{ 2837 \"organization_id\": 16, 2838 \"domain_id\": 16 2839}" 2840</code></pre></div> 2841 2842 2843<div class="javascript-example"> 2844 <pre><code class="language-javascript">const url = new URL( 2845 "prolinks.pro/api/v1/links" 2846); 2847 2848const headers = { 2849 "Content-Type": "application/json", 2850 "Accept": "application/json", 2851}; 2852 2853let body = { 2854 "organization_id": 16, 2855 "domain_id": 16 2856}; 2857 2858fetch(url, { 2859 method: "GET", 2860 headers, 2861 body: JSON.stringify(body), 2862}).then(response => response.json());</code></pre></div> 2863 2864</span> 2865 2866<span id="example-responses-GETapi-v1-links"> 2867 <blockquote> 2868 <p>
2868Example response (401):</p> 2869 </blockquote> 2870 <details class="annotation"> 2871 <summary style="cursor: pointer;"> 2872 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 2873 </summary> 2874 <pre><code class="language-http">cache-control: no-cache, private 2875content-type: application/json 2876access-control-allow-origin: * 2877 </code></pre></details> <pre> 2878 2879<code class="language-json" style="max-height: 300px;">{ 2880 "message": "Unauthenticated." 2881}</code> 2882 </pre> 2883 </span> 2884<span id="execution-results-GETapi-v1-links" hidden> 2885 <blockquote>Received response<span 2886 id="execution-response-status-GETapi-v1-links"></span>: 2887 </blockquote> 2888 <pre class="json"><code id="execution-response-content-GETapi-v1-links" 2889 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 2890</span> 2891<span id="execution-error-GETapi-v1-links" hidden> 2892 <blockquote>Request failed with error:</blockquote> 2893 <pre><code id="execution-error-message-GETapi-v1-links"> 2894 2895Tip: Check that you're properly connected to the network. 2896If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 2897You can check the Dev Tools console for debugging information.</code></pre> 2898</span> 2899<form id="form-GETapi-v1-links" data-method="GET" 2900 data-path="api/v1/links" 2901 data-authed="0" 2902 data-hasfiles="0" 2903 data-isarraybody="0" 2904 autocomplete="off" 2905 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-links', this);"> 2906 <h3> 2907 Request 2908 <button type="button" 2909 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2910 id="btn-tryout-GETapi-v1-links" 2911 onclick="tryItOut('GETapi-v1-links');">Try it out â¡ 2912 </button> 2913 <button type="button" 2914 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2915 id="btn-canceltryout-GETapi-v1-links" 2916 onclick="cancelTryOut('GETapi-v1-links');" hidden>Cancel ð 2917 </button> 2918 <button type="submit" 2919 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 2920 id="btn-executetryout-GETapi-v1-links" 2921 data-initial-text="Send Request ð¥" 2922 data-loading-text="â± Sending..." 2923 hidden>Send Request ð¥ 2924 </button> 2925 </h3> 2926 <p> 2927 <small class="badge badge-green">GET</small> 2928 <b><code>api/v1/links</code></b> 2929 </p> 2930 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 2931 <div style="padding-left: 28px; clear: unset;"> 2932 <b style="line-height: 2;"><code>Content-Type</code></b> 2933 2934 2935 2936 <input type="text" style="display: none" 2937 name="Content-Type" data-endpoint="GETapi-v1-links" 2938 value="application/json" 2939 data-component="header"> 2940 <br> 2941<p>Example: <code>application/json</code></p> 2942 </div> 2943 <div style="padding-left: 28px; clear: unset;"> 2944 <b style="line-height: 2;"><code>Accept</code></b> 2945 2946 2947 2948 <input type="text" style="display: none" 2949 name="Accept" data-endpoint="GETapi-v1-links" 2950 value="application/json" 2951 data-component="header"> 2952 <br> 2953<p>Example: <code>application/json</code></p> 2954 </div> 2955 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 2956 <div style=" padding-left: 28px; clear: unset;"> 2957 <b style="line-height: 2;"><code>organization_id</code></b> 2958<small>integer</small> 2959 2960 2961 <input type="number" style="display: none" 2962 step="any" name="organization_id" data-endpoint="GETapi-v1-links" 2963 value="16" 2964 data-component="body"> 2965 <br> 2966<p>Must match an existing stored value. Example: <code>16</code></p> 2967 </div> 2968 <div style=" padding-left: 28px; clear: unset;"> 2969 <b style="line-height: 2;"><code>domain_id</code></b> 2970<small>integer</small> 2971 2972 2973 <input type="number" style="display: none" 2974 step="any" name="domain_id" data-endpoint="GETapi-v1-links" 2975 value="16" 2976 data-component="body"> 2977 <br> 2978<p>Must match an existing stored value. Example: <code>16</code></p> 2979 </div> 2980 </form> 2981 2982 <h2 id="links-POSTapi-v1-links">POST api/v1/links</h2> 2983 2984<p> 2985</p> 2986 2987 2988 2989<span id="example-requests-POSTapi-v1-links"> 2990<blockquote>Example request:</blockquote> 2991 2992 2993<div class="bash-example"> 2994 <pre><code class="language-bash">curl --request POST \ 2995 "prolinks.pro/api/v1/links" \ 2996 --header "Content-Type: application/json" \ 2997 --header "Accept: application/json" \ 2998 --data "{ 2999 \"organization_id\": 16, 3000 \"domain_id\": 16, 3001 \"url\": \"http:\\/\\/bailey.com\\/\", 3002 \"slug\": \"architecto\", 3003 \"description\": \"Eius et animi quos velit et.\", 3004 \"tags\": [ 3005 16 3006 ], 3007 \"campaign_source_id\": 16, 3008 \"campaign_medium_id\": 16, 3009 \"campaign_id\": \"architecto\", 3010 \"campaign_name\": \"architecto\", 3011 \"campaign_term\": \"architecto\", 3012 \"campaign_content\": \"architecto\", 3013 \"schedule\": false, 3014 \"schedule_at\": \"2052-07-09\", 3015 \"schedule_url\": \"http:\\/\\/bailey.com\\/\", 3016 \"expires\": false, 3017 \"expires_at\": \"2052-07-09\", 3018 \"expires_url\": \"http:\\/\\/bailey.com\\/\", 3019 \"protect\": true, 3020 \"ios\": true, 3021 \"ios_url\": \"http:\\/\\/rempel.com\\/sunt-nihil-accusantium-harum-mollitia\", 3022 \"android\": true, 3023 \"android_url\": \"http:\\/\\/www.considine.com\\/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem\", 3024 \"windows\": true, 3025 \"windows_url\": \"http:\\/\\/www.dare.org\\/iure-odit-et-et-modi-ipsum-nostrum-omnis\", 3026 \"macos\": false, 3027 \"macos_url\": \"http:\\/\\/mclaughlin.info\\/dolores-enim-non-facere-tempora\", 3028 \"linux\": true, 3029 \"linux_url\": \"http:\\/\\/www.leffler.info\\/quis-adipisci-molestias-fugit-deleniti-distinctio-eum\" 3030}"
3031</code></pre></div> 3032 3033 3034<div class="javascript-example"> 3035 <pre><code class="language-javascript">const url = new URL( 3036 "prolinks.pro/api/v1/links" 3037); 3038 3039const headers = { 3040 "Content-Type": "application/json", 3041 "Accept": "application/json", 3042}; 3043 3044let body = { 3045 "organization_id": 16, 3046 "domain_id": 16, 3047 "url": "http:\/\/bailey.com\/", 3048 "slug": "architecto", 3049 "description": "Eius et animi quos velit et.", 3050 "tags": [ 3051 16 3052 ], 3053 "campaign_source_id": 16, 3054 "campaign_medium_id": 16, 3055 "campaign_id": "architecto", 3056 "campaign_name": "architecto", 3057 "campaign_term": "architecto", 3058 "campaign_content": "architecto", 3059 "schedule": false, 3060 "schedule_at": "2052-07-09", 3061 "schedule_url": "http:\/\/bailey.com\/", 3062 "expires": false, 3063 "expires_at": "2052-07-09", 3064 "expires_url": "http:\/\/bailey.com\/", 3065 "protect": true, 3066 "ios": true, 3067 "ios_url": "http:\/\/rempel.com\/sunt-nihil-accusantium-harum-mollitia", 3068 "android": true, 3069 "android_url": "http:\/\/www.considine.com\/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem", 3070 "windows": true, 3071 "windows_url": "http:\/\/www.dare.org\/iure-odit-et-et-modi-ipsum-nostrum-omnis", 3072 "macos": false, 3073 "macos_url": "http:\/\/mclaughlin.info\/dolores-enim-non-facere-tempora", 3074 "linux": true, 3075 "linux_url": "http:\/\/www.leffler.info\/quis-adipisci-molestias-fugit-deleniti-distinctio-eum" 3076}; 3077 3078fetch(url, { 3079 method: "POST", 3080 headers, 3081 body: JSON.stringify(body), 3082}).then(response => response.json());</code></pre></div> 3083 3084</span> 3085 3086<span id="example-responses-POSTapi-v1-links"> 3087</span> 3088<span id="execution-results-POSTapi-v1-links" hidden> 3089 <blockquote>Received response<span 3090 id="execution-response-status-POSTapi-v1-links"></span>: 3091 </blockquote> 3092 <pre class="json"><code id="execution-response-content-POSTapi-v1-links" 3093 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 3094</span> 3095<span id="execution-error-POSTapi-v1-links" hidden> 3096 <blockquote>Request failed with error:</blockquote> 3097 <pre><code id="execution-error-message-POSTapi-v1-links"> 3098 3099Tip: Check that you're properly connected to the network. 3100If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 3101You can check the Dev Tools console for debugging information.</code></pre> 3102</span> 3103<form id="form-POSTapi-v1-links" data-method="POST" 3104 data-path="api/v1/links" 3105 data-authed="0" 3106 data-hasfiles="0" 3107 data-isarraybody="0" 3108 autocomplete="off" 3109 onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-links', this);"> 3110 <h3> 3111 Request 3112 <button type="button" 3113 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 3114 id="btn-tryout-POSTapi-v1-links" 3115 onclick="tryItOut('POSTapi-v1-links');">Try it out â¡ 3116 </button> 3117 <button type="button" 3118 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 3119 id="btn-canceltryout-POSTapi-v1-links" 3120 onclick="cancelTryOut('POSTapi-v1-links');" hidden>Cancel ð 3121 </button> 3122 <button type="submit" 3123 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 3124 id="btn-executetryout-POSTapi-v1-links" 3125 data-initial-text="Send Request ð¥" 3126 data-loading-text="â± Sending..." 3127 hidden>Send Request ð¥ 3128 </button> 3129 </h3> 3130 <p> 3131 <small class="badge badge-black">POST</small> 3132 <b><code>api/v1/links</code></b> 3133 </p> 3134 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 3135 <div style="padding-left: 28px; clear: unset;"> 3136 <b style="line-height: 2;"><code>Content-Type</code></b> 3137 3138 3139 3140 <input type="text" style="display: none" 3141 name="Content-Type" data-endpoint="POSTapi-v1-links" 3142 value="application/json" 3143 data-component="header"> 3144 <br> 3145<p>Example: <code>application/json</code></p> 3146 </div> 3147 <div style="padding-left: 28px; clear: unset;"> 3148 <b style="line-height: 2;"><code>Accept</code></b> 3149 3150 3151 3152 <input type="text" style="display: none" 3153 name="Accept" data-endpoint="POSTapi-v1-links" 3154 value="application/json" 3155 data-component="header"> 3156 <br> 3157<p>Example: <code>application/json</code></p> 3158 </div> 3159 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 3160 <div style=" padding-left: 28px; clear: unset;"> 3161 <b style="line-height: 2;"><code>organization_id</code></b> 3162<small>integer</small> 3163 3164 3165 <input type="number" style="display: none" 3166 step="any" name="organization_id" data-endpoint="POSTapi-v1-links" 3167 value="16" 3168 data-component="body"> 3169 <br> 3170<p>Must match an existing stored value. Example: <code>16</code></p> 3171 </div> 3172 <div style=" padding-left: 28px; clear: unset;"> 3173 <b style="line-height: 2;"><code>domain_id</code></b> 3174<small>integer</small> 3175 3176 3177 <input type="number" style="display: none" 3178 step="any" name="domain_id" data-endpoint="POSTapi-v1-links" 3179 value="16" 3180 data-component="body"> 3181 <br> 3182<p>Must match an existing stored value. Example: <code>16</code></p> 3183 </div> 3184 <div style=" padding-left: 28px; clear: unset;"> 3185 <b style="line-height: 2;"><code>url</code></b> 3186<small>string</small> 3187 3188 3189 <input type="text" style="display: none" 3190 name="url" data-endpoint="POSTapi-v1-links" 3191 value="http://bailey.com/" 3192 data-component="body"> 3193 <br> 3194<p>Must be a valid URL. Example: <code>http://bailey.com/</code></p> 3195 </div> 3196 <div style=" padding-left: 28px; clear: unset;"> 3197 <b style="line-height: 2;"><code>slug</code></b> 3198<small>string</small> 3199<i>optional</i> 3200 3201 <input type="text" style="display: none" 3202 name="slug" data-endpoint="POSTapi-v1-links" 3203 value="architecto" 3204 data-component="body"> 3205 <br> 3206<p>Example: <code>architecto</code></p> 3207 </div> 3208 <div style=" padding-left: 28px; clear: unset;"> 3209 <b style="line-height: 2;"><code>description</code></b> 3210<small>string</small> 3211<i>optional</i> 3212 3213 <input type="text" style="display: none" 3214 name="description" data-endpoint="POSTapi-v1-links" 3215 value="Eius et animi quos velit et." 3216 data-component="body"> 3217 <br> 3218<p>Example: <code>Eius et animi quos velit et.</code></p> 3219 </div> 3220 <div style=" padding-left: 28px; clear: unset;"> 3221 <b style="line-height: 2;"><code>tags</code></b> 3222<small>integer[]</small> 3223<i>optional</i> 3224 3225 <input type="number" style="display: none" 3226 step="any" name="tags[0]" data-endpoint="POSTapi-v1-links" 3227 data-component="body"> 3228 <input type="number" style="display: none" 3229 name="tags[1]" data-endpoint="POSTapi-v1-links" 3230 data-component="body"> 3231 <br> 3232 3233 </div> 3234 <div style=" padding-left: 28px; clear: unset;"> 3235 <b style="line-height: 2;"><code>campaign_source_id</code></b> 3236<small>integer</small> 3237<i>optional</i> 3238 3239 <input type="number" style="display: none" 3240 step="any" name="campaign_source_id" data-endpoint="POSTapi-v1-links" 3241 value="16" 3242 data-component="body"> 3243 <br> 3244<p>Example: <code>16</code></p> 3245 </div> 3246 <div style=" padding-left: 28px; clear: unset;"> 3247 <b style="line-height: 2;"><code>campaign_medium_id</code></b> 3248<small>integer</small> 3249<i>optional</i> 3250 3251 <input type="number" style="display: none" 3252 step="any" name="campaign_medium_id" data-endpoint="POSTapi-v1-links" 3253 value="16" 3254 data-component="body"> 3255 <br> 3256<p>Example: <code>16</code></p> 3257 </div> 3258 <div style=" padding-left: 28px; clear: unset;"> 3259 <b style="line-height: 2;"><code>campaign_id</code></b> 3260<small>string</small> 3261<i>optional</i> 3262 3263 <input type="text" style="display: none" 3264 name="campaign_id" data-endpoint="POSTapi-v1-links" 3265 value="architecto" 3266 data-component="body"> 3267 <br> 3268<p>Example: <code>architecto</code></p> 3269 </div> 3270 <div style=" padding-left: 28px; clear: unset;"> 3271 <b style="line-height: 2;"><code>campaign_name</code></b> 3272<small>string</small> 3273<i>optional</i> 3274 3275 <input type="text" style="display: none" 3276 name="campaign_name" data-endpoint="POSTapi-v1-links" 3277 value="architecto" 3278 data-component="body"> 3279 <br> 3280<p>Example: <code>architecto</code></p> 3281 </div> 3282 <div style=" padding-left: 28px; clear: unset;"> 3283 <b style="line-height: 2;"><code>campaign_term</code></b> 3284<small>string</small> 3285<i>optional</i> 3286 3287 <input type="text" style="display: none" 3288 name="campaign_term" data-endpoint="POSTapi-v1-links" 3289 value="architecto" 3290 data-component="body"> 3291 <br> 3292<p>Example: <code>architecto</code></p> 3293 </div> 3294 <div style=" padding-left: 28px; clear: unset;"> 3295 <b style="line-height: 2;"><code>campaign_content</code></b> 3296<small>string</small> 3297<i>optional</i> 3298 3299 <input type="text" style="display: none" 3300 name="campaign_content" data-endpoint="POSTapi-v1-links" 3301 value="architecto" 3302 data-component="body"> 3303 <br> 3304<p>Example: <code>architecto</code></p> 3305 </div> 3306 <div style=" padding-left: 28px; clear: unset;"> 3307 <b style="line-height: 2;"><code>schedule</code></b> 3308<small>boolean</small> 3309<i>optional</i> 3310 3311 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3312 <input type="radio" name="schedule" 3313 value="true" 3314 data-endpoint="POSTapi-v1-links" 3315 data-component="body" > 3316 <code>true</code> 3317 </label> 3318 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3319 <input type="radio" name="schedule" 3320 value="false" 3321 data-endpoint="POSTapi-v1-links" 3322 data-component="body" > 3323 <code>false</code> 3324 </label> 3325 <br> 3326<p>Example: <code>false</code></p> 3327 </div> 3328 <div style=" padding-left: 28px; clear: unset;"> 3329 <b style="line-height: 2;"><code>schedule_at</code></b> 3330<small>string</small> 3331<i>optional</i> 3332 3333 <input type="text" style="display: none" 3334 name="schedule_at" data-endpoint="POSTapi-v1-links" 3335 value="2052-07-09" 3336 data-component="body"> 3337 <br> 3338<p>This field is required when <code>schedule</code>
3338 is present. Must be a valid date in the format <code>d/m/Y H:i</code>. Must be a date after <code>now</code>. Example: <code>2052-07-09</code></p> 3339 </div> 3340 <div style=" padding-left: 28px; clear: unset;"> 3341 <b style="line-height: 2;"><code>schedule_url</code></b> 3342<small>string</small> 3343<i>optional</i> 3344 3345 <input type="text" style="display: none" 3346 name="schedule_url" data-endpoint="POSTapi-v1-links" 3347 value="http://bailey.com/" 3348 data-component="body"> 3349 <br> 3350<p>Must be a valid URL. Example: <code>http://bailey.com/</code></p> 3351 </div> 3352 <div style=" padding-left: 28px; clear: unset;"> 3353 <b style="line-height: 2;"><code>expires</code></b> 3354<small>boolean</small> 3355<i>optional</i> 3356 3357 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3358 <input type="radio" name="expires" 3359 value="true" 3360 data-endpoint="POSTapi-v1-links" 3361 data-component="body" > 3362 <code>true</code> 3363 </label> 3364 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3365 <input type="radio" name="expires" 3366 value="false" 3367 data-endpoint="POSTapi-v1-links" 3368 data-component="body" > 3369 <code>false</code> 3370 </label> 3371 <br> 3372<p>Example: <code>false</code></p> 3373 </div> 3374 <div style=" padding-left: 28px; clear: unset;"> 3375 <b style="line-height: 2;"><code>expires_at</code></b> 3376<small>string</small> 3377<i>optional</i> 3378 3379 <input type="text" style="display: none" 3380 name="expires_at" data-endpoint="POSTapi-v1-links" 3381 value="2052-07-09" 3382 data-component="body"> 3383 <br> 3384<p>This field is required when <code>expires</code> is present. Must be a valid date in the format <code>d/m/Y H:i</code>. Must be a date after <code>now</code>. Example: <code>2052-07-09</code></p> 3385 </div> 3386 <div style=" padding-left: 28px; clear: unset;"> 3387 <b style="line-height: 2;"><code>expires_url</code></b> 3388<small>string</small> 3389<i>optional</i> 3390 3391 <input type="text" style="display: none" 3392 name="expires_url" data-endpoint="POSTapi-v1-links" 3393 value="http://bailey.com/" 3394 data-component="body"> 3395 <br> 3396<p>Must be a valid URL. Example: <code>http://bailey.com/</code></p> 3397 </div> 3398 <div style=" padding-left: 28px; clear: unset;"> 3399 <b style="line-height: 2;"><code>protect</code></b> 3400<small>boolean</small> 3401<i>optional</i> 3402 3403 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3404 <input type="radio" name="protect" 3405 value="true" 3406 data-endpoint="POSTapi-v1-links" 3407 data-component="body" > 3408 <code>true</code> 3409 </label> 3410 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3411 <input type="radio" name="protect" 3412 value="false" 3413 data-endpoint="POSTapi-v1-links" 3414 data-component="body" > 3415 <code>false</code> 3416 </label> 3417 <br> 3418<p>Example: <code>true</code></p> 3419 </div> 3420 <div style=" padding-left: 28px; clear: unset;"> 3421 <b style="line-height: 2;"><code>ios</code></b> 3422<small>boolean</small> 3423<i>optional</i> 3424 3425 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3426 <input type="radio" name="ios" 3427 value="true" 3428 data-endpoint="POSTapi-v1-links" 3429 data-component="body" > 3430 <code>true</code> 3431 </label> 3432 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3433 <input type="radio" name="ios" 3434 value="false" 3435 data-endpoint="POSTapi-v1-links" 3436 data-component="body" > 3437 <code>false</code> 3438 </label> 3439 <br> 3440<p>Example: <code>true</code></p> 3441 </div> 3442 <div style=" padding-left: 28px; clear: unset;"> 3443 <b style="line-height: 2;"><code>ios_url</code></b> 3444<small>string</small> 3445<i>optional</i> 3446 3447 <input type="text" style="display: none" 3448 name="ios_url" data-endpoint="POSTapi-v1-links" 3449 value="http://rempel.com/sunt-nihil-accusantium-harum-mollitia" 3450 data-component="body"> 3451 <br> 3452<p>This field is required when <code>ios</code>
3452 is present. Must be a valid URL. Example: <code>http://rempel.com/sunt-nihil-accusantium-harum-mollitia</code></p> 3453 </div> 3454 <div style=" padding-left: 28px; clear: unset;"> 3455 <b style="line-height: 2;"><code>android</code></b> 3456<small>boolean</small> 3457<i>optional</i> 3458 3459 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3460 <input type="radio" name="android" 3461 value="true" 3462 data-endpoint="POSTapi-v1-links" 3463 data-component="body" > 3464 <code>true</code> 3465 </label> 3466 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3467 <input type="radio" name="android" 3468 value="false" 3469 data-endpoint="POSTapi-v1-links" 3470 data-component="body" > 3471 <code>false</code> 3472 </label> 3473 <br> 3474<p>Example: <code>true</code></p> 3475 </div> 3476 <div style=" padding-left: 28px; clear: unset;"> 3477 <b style="line-height: 2;"><code>android_url</code></b> 3478<small>string</small> 3479<i>optional</i> 3480 3481 <input type="text" style="display: none" 3482 name="android_url" data-endpoint="POSTapi-v1-links" 3483 value="http://www.considine.com/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem" 3484 data-component="body"> 3485 <br> 3486<p>This field is required when <code>android</code> is present. Must be a valid URL. Example: <code>http://www.considine.com/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem</code></p> 3487 </div> 3488 <div style=" padding-left: 28px; clear: unset;"> 3489 <b style="line-height: 2;"><code>windows</code></b> 3490<small>boolean</small> 3491<i>optional</i> 3492 3493 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3494 <input type="radio" name="windows" 3495 value="true" 3496 data-endpoint="POSTapi-v1-links" 3497 data-component="body" > 3498 <code>true</code> 3499 </label> 3500 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3501 <input type="radio" name="windows" 3502 value="false" 3503 data-endpoint="POSTapi-v1-links" 3504 data-component="body" > 3505 <code>false</code> 3506 </label> 3507 <br> 3508<p>Example: <code>true</code></p> 3509 </div> 3510 <div style=" padding-left: 28px; clear: unset;"> 3511 <b style="line-height: 2;"><code>windows_url</code></b> 3512<small>string</small> 3513<i>optional</i> 3514 3515 <input type="text" style="display: none" 3516 name="windows_url" data-endpoint="POSTapi-v1-links" 3517 value="http://www.dare.org/iure-odit-et-et-modi-ipsum-nostrum-omnis" 3518 data-component="body"> 3519 <br> 3520<p>This field is required when <code>windows</code> is present. Must be a valid URL. Example: <code>http://www.dare.org/iure-odit-et-et-modi-ipsum-nostrum-omnis</code></p> 3521 </div> 3522 <div style=" padding-left: 28px; clear: unset;"> 3523 <b style="line-height: 2;"><code>macos</code></b> 3524<small>boolean</small> 3525<i>optional</i> 3526 3527 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3528 <input type="radio" name="macos" 3529 value="true" 3530 data-endpoint="POSTapi-v1-links" 3531 data-component="body" > 3532 <code>true</code> 3533 </label> 3534 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3535 <input type="radio" name="macos" 3536 value="false" 3537 data-endpoint="POSTapi-v1-links" 3538 data-component="body" > 3539 <code>false</code> 3540 </label> 3541 <br> 3542<p>Example: <code>false</code></p> 3543 </div> 3544 <div style=" padding-left: 28px; clear: unset;"> 3545 <b style="line-height: 2;"><code>macos_url</code></b> 3546<small>string</small> 3547<i>optional</i> 3548 3549 <input type="text" style="display: none" 3550 name="macos_url" data-endpoint="POSTapi-v1-links" 3551 value="http://mclaughlin.info/dolores-enim-non-facere-tempora" 3552 data-component="body"> 3553 <br> 3554<p>This field is required when <code>macos</code>
3554 is present. Must be a valid URL. Example: <code>http://mclaughlin.info/dolores-enim-non-facere-tempora</code></p> 3555 </div> 3556 <div style=" padding-left: 28px; clear: unset;"> 3557 <b style="line-height: 2;"><code>linux</code></b> 3558<small>boolean</small> 3559<i>optional</i> 3560 3561 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3562 <input type="radio" name="linux" 3563 value="true" 3564 data-endpoint="POSTapi-v1-links" 3565 data-component="body" > 3566 <code>true</code> 3567 </label> 3568 <label data-endpoint="POSTapi-v1-links" style="display: none"> 3569 <input type="radio" name="linux" 3570 value="false" 3571 data-endpoint="POSTapi-v1-links" 3572 data-component="body" > 3573 <code>false</code> 3574 </label> 3575 <br> 3576<p>Example: <code>true</code></p> 3577 </div> 3578 <div style=" padding-left: 28px; clear: unset;"> 3579 <b style="line-height: 2;"><code>linux_url</code></b> 3580<small>string</small> 3581<i>optional</i> 3582 3583 <input type="text" style="display: none" 3584 name="linux_url" data-endpoint="POSTapi-v1-links" 3585 value="http://www.leffler.info/quis-adipisci-molestias-fugit-deleniti-distinctio-eum" 3586 data-component="body"> 3587 <br> 3588<p>This field is required when <code>linux</code> is present. Must be a valid URL. Example: <code>http://www.leffler.info/quis-adipisci-molestias-fugit-deleniti-distinctio-eum</code></p> 3589 </div> 3590 </form> 3591 3592 <h2 id="links-GETapi-v1-links--id-">GET api/v1/links/{id}</h2> 3593 3594<p> 3595</p> 3596 3597 3598 3599<span id="example-requests-GETapi-v1-links--id-"> 3600<blockquote>Example request:</blockquote> 3601 3602 3603<div class="bash-example"> 3604 <pre><code class="language-bash">curl --request GET \ 3605 --get "prolinks.pro/api/v1/links/16" \ 3606 --header "Content-Type: application/json" \ 3607 --header "Accept: application/json" \ 3608 --data "{ 3609 \"organization_id\": 16, 3610 \"domain_id\": 16 3611}" 3612</code></pre></div> 3613 3614 3615<div class="javascript-example"> 3616 <pre><code class="language-javascript">const url = new URL( 3617 "prolinks.pro/api/v1/links/16" 3618); 3619 3620const headers = { 3621 "Content-Type": "application/json", 3622 "Accept": "application/json", 3623}; 3624 3625let body = { 3626 "organization_id": 16, 3627 "domain_id": 16 3628}; 3629 3630fetch(url, { 3631 method: "GET", 3632 headers, 3633 body: JSON.stringify(body), 3634}).then(response => response.json());</code></pre></div> 3635 3636</span> 3637 3638<span id="example-responses-GETapi-v1-links--id-"> 3639 <blockquote> 3640 <p>Example response (401):</p> 3641 </blockquote> 3642 <details class="annotation"> 3643 <summary style="cursor: pointer;"> 3644 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 3645 </summary> 3646 <pre><code class="language-http">cache-control: no-cache, private 3647content-type: application/json 3648access-control-allow-origin: * 3649 </code></pre></details> <pre> 3650 3651<code class="language-json" style="max-height: 300px;">{ 3652 "message": "Unauthenticated." 3653}</code> 3654 </pre> 3655 </span> 3656<span id="execution-results-GETapi-v1-links--id-" hidden> 3657 <blockquote>Received response<span 3658 id="execution-response-status-GETapi-v1-links--id-"></span>: 3659 </blockquote> 3660 <pre class="json"><code id="execution-response-content-GETapi-v1-links--id-" 3661 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 3662</span> 3663<span id="execution-error-GETapi-v1-links--id-" hidden> 3664 <blockquote>Request failed with error:</blockquote> 3665 <pre><code id="execution-error-message-GETapi-v1-links--id-"> 3666 3667Tip: Check that you're properly connected to the network. 3668If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 3669You can check the Dev Tools console for debugging information.</code></pre> 3670</span> 3671<form id="form-GETapi-v1-links--id-" data-method="GET" 3672 data-path="api/v1/links/{id}" 3673 data-authed="0" 3674 data-hasfiles="0" 3675 data-isarraybody="0" 3676 autocomplete="off" 3677 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-links--id-', this);"> 3678 <h3> 3679 Request 3680 <button type="button" 3681 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 3682 id="btn-tryout-GETapi-v1-links--id-" 3683 onclick="tryItOut('GETapi-v1-links--id-');">Try it out â¡ 3684 </button> 3685 <button type="button" 3686 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 3687 id="btn-canceltryout-GETapi-v1-links--id-" 3688 onclick="cancelTryOut('GETapi-v1-links--id-');" hidden>Cancel ð 3689 </button> 3690 <button type="submit" 3691 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 3692 id="btn-executetryout-GETapi-v1-links--id-" 3693 data-initial-text="Send Request ð¥" 3694 data-loading-text="â± Sending..." 3695 hidden>Send Request ð¥ 3696 </button> 3697 </h3> 3698 <p> 3699 <small class="badge badge-green">GET</small> 3700 <b><code>api/v1/links/{id}</code></b> 3701 </p> 3702 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 3703 <div style="padding-left: 28px; clear: unset;"> 3704 <b style="line-height: 2;"><code>Content-Type</code></b> 3705 3706 3707 3708 <input type="text" style="display: none" 3709 name="Content-Type" data-endpoint="GETapi-v1-links--id-" 3710 value="application/json" 3711 data-component="header"> 3712 <br> 3713<p>Example: <code>application/json</code></p> 3714 </div> 3715 <div style="padding-left: 28px; clear: unset;"> 3716 <b style="line-height: 2;"><code>Accept</code></b> 3717 3718 3719 3720 <input type="text" style="display: none" 3721 name="Accept" data-endpoint="GETapi-v1-links--id-" 3722 value="application/json" 3723 data-component="header"> 3724 <br> 3725<p>Example: <code>application/json</code></p> 3726 </div> 3727 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 3728 <div style="padding-left: 28px; clear: unset;"> 3729 <b style="line-height: 2;"><code>id</code></b> 3730<small>integer</small> 3731 3732 3733 <input type="number" style="display: none" 3734 step="any" name="id" data-endpoint="GETapi-v1-links--id-" 3735 value="16" 3736 data-component="url"> 3737 <br> 3738<p>
3738The ID of the link. Example: <code>16</code></p> 3739 </div> 3740 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 3741 <div style=" padding-left: 28px; clear: unset;"> 3742 <b style="line-height: 2;"><code>organization_id</code></b> 3743<small>integer</small> 3744 3745 3746 <input type="number" style="display: none" 3747 step="any" name="organization_id" data-endpoint="GETapi-v1-links--id-" 3748 value="16" 3749 data-component="body"> 3750 <br> 3751<p>Must match an existing stored value. Example: <code>16</code></p> 3752 </div> 3753 <div style=" padding-left: 28px; clear: unset;"> 3754 <b style="line-height: 2;"><code>domain_id</code></b> 3755<small>integer</small> 3756 3757 3758 <input type="number" style="display: none" 3759 step="any" name="domain_id" data-endpoint="GETapi-v1-links--id-" 3760 value="16" 3761 data-component="body"> 3762 <br> 3763<p>Must match an existing stored value. Example: <code>16</code></p> 3764 </div> 3765 </form> 3766 3767 <h2 id="links-GETapi-v1-links--link_id--qr-code">GET api/v1/links/{link_id}/qr-code</h2> 3768 3769<p> 3770</p> 3771 3772 3773 3774<span id="example-requests-GETapi-v1-links--link_id--qr-code"> 3775<blockquote>Example request:</blockquote> 3776 3777 3778<div class="bash-example"> 3779 <pre><code class="language-bash">curl --request GET \ 3780 --get "prolinks.pro/api/v1/links/16/qr-code" \ 3781 --header "Content-Type: application/json" \ 3782 --header "Accept: application/json"</code></pre></div> 3783 3784 3785<div class="javascript-example"> 3786 <pre><code class="language-javascript">const url = new URL( 3787 "prolinks.pro/api/v1/links/16/qr-code" 3788); 3789 3790const headers = { 3791 "Content-Type": "application/json", 3792 "Accept": "application/json", 3793}; 3794 3795 3796fetch(url, { 3797 method: "GET", 3798 headers, 3799}).then(response => response.json());</code></pre></div> 3800 3801</span> 3802 3803<span id="example-responses-GETapi-v1-links--link_id--qr-code"> 3804 <blockquote> 3805 <p>Example response (401):</p> 3806 </blockquote> 3807 <details class="annotation"> 3808 <summary style="cursor: pointer;"> 3809 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 3810 </summary> 3811 <pre><code class="language-http">cache-control: no-cache, private 3812content-type: application/json 3813access-control-allow-origin: * 3814 </code></pre></details> <pre> 3815 3816<code class="language-json" style="max-height: 300px;">{ 3817 "message": "Unauthenticated." 3818}</code> 3819 </pre> 3820 </span> 3821<span id="execution-results-GETapi-v1-links--link_id--qr-code" hidden> 3822 <blockquote>Received response<span 3823 id="execution-response-status-GETapi-v1-links--link_id--qr-code"></span>: 3824 </blockquote> 3825 <pre class="json"><code id="execution-response-content-GETapi-v1-links--link_id--qr-code" 3826 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 3827</span> 3828<span id="execution-error-GETapi-v1-links--link_id--qr-code" hidden> 3829 <blockquote>Request failed with error:</blockquote> 3830 <pre><code id="execution-error-message-GETapi-v1-links--link_id--qr-code"> 3831 3832Tip: Check that you're properly connected to the network. 3833If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 3834You can check the Dev Tools console for debugging information.</code></pre> 3835</span> 3836<form id="form-GETapi-v1-links--link_id--qr-code" data-method="GET" 3837 data-path="api/v1/links/{link_id}/qr-code" 3838 data-authed="0" 3839 data-hasfiles="0" 3840 data-isarraybody="0" 3841 autocomplete="off" 3842 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-links--link_id--qr-code', this);"> 3843 <h3> 3844 Request 3845 <button type="button" 3846 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 3847 id="btn-tryout-GETapi-v1-links--link_id--qr-code" 3848 onclick="tryItOut('GETapi-v1-links--link_id--qr-code');">Try it out â¡ 3849 </button> 3850 <button type="button" 3851 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 3852 id="btn-canceltryout-GETapi-v1-links--link_id--qr-code" 3853 onclick="cancelTryOut('GETapi-v1-links--link_id--qr-code');" hidden>Cancel ð 3854 </button> 3855 <button type="submit" 3856 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 3857 id="btn-executetryout-GETapi-v1-links--link_id--qr-code" 3858 data-initial-text="Send Request ð¥" 3859 data-loading-text="â± Sending..." 3860 hidden>Send Request ð¥ 3861 </button> 3862 </h3> 3863 <p> 3864 <small class="badge badge-green">GET</small> 3865 <b><code>api/v1/links/{link_id}/qr-code</code></b> 3866 </p> 3867 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 3868 <div style="padding-left: 28px; clear: unset;"> 3869 <b style="line-height: 2;"><code>Content-Type</code></b> 3870 3871 3872 3873 <input type="text" style="display: none" 3874 name="Content-Type" data-endpoint="GETapi-v1-links--link_id--qr-code" 3875 value="application/json" 3876 data-component="header"> 3877 <br> 3878<p>Example: <code>application/json</code></p> 3879 </div> 3880 <div style="padding-left: 28px; clear: unset;"> 3881 <b style="line-height: 2;"><code>Accept</code></b> 3882 3883 3884 3885 <input type="text" style="display: none" 3886 name="Accept" data-endpoint="GETapi-v1-links--link_id--qr-code" 3887 value="application/json" 3888 data-component="header"> 3889 <br> 3890<p>Example: <code>application/json</code></p> 3891 </div> 3892 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 3893 <div style="padding-left: 28px; clear: unset;"> 3894 <b style="line-height: 2;"><code>link_id</code></b> 3895<small>integer</small> 3896 3897 3898 <input type="number" style="display: none" 3899 step="any" name="link_id" data-endpoint="GETapi-v1-links--link_id--qr-code" 3900 value="16" 3901 data-component="url"> 3902 <br> 3903<p>
3903The ID of the link. Example: <code>16</code></p> 3904 </div> 3905 </form> 3906 3907 <h2 id="links-GETapi-v1-links--link_id--clicks">GET api/v1/links/{link_id}/clicks</h2> 3908 3909<p> 3910</p> 3911 3912 3913 3914<span id="example-requests-GETapi-v1-links--link_id--clicks"> 3915<blockquote>Example request:</blockquote> 3916 3917 3918<div class="bash-example"> 3919 <pre><code class="language-bash">curl --request GET \ 3920 --get "prolinks.pro/api/v1/links/16/clicks" \ 3921 --header "Content-Type: application/json" \ 3922 --header "Accept: application/json" \ 3923 --data "{ 3924 \"organization_id\": 16 3925}" 3926</code></pre></div> 3927 3928 3929<div class="javascript-example"> 3930 <pre><code class="language-javascript">const url = new URL( 3931 "prolinks.pro/api/v1/links/16/clicks" 3932); 3933 3934const headers = { 3935 "Content-Type": "application/json", 3936 "Accept": "application/json", 3937}; 3938 3939let body = { 3940 "organization_id": 16 3941}; 3942 3943fetch(url, { 3944 method: "GET", 3945 headers, 3946 body: JSON.stringify(body), 3947}).then(response => response.json());</code></pre></div> 3948 3949</span> 3950 3951<span id="example-responses-GETapi-v1-links--link_id--clicks"> 3952 <blockquote> 3953 <p>Example response (401):</p> 3954 </blockquote> 3955 <details class="annotation"> 3956 <summary style="cursor: pointer;"> 3957 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 3958 </summary> 3959 <pre><code class="language-http">cache-control: no-cache, private 3960content-type: application/json 3961access-control-allow-origin: * 3962 </code></pre></details> <pre> 3963 3964<code class="language-json" style="max-height: 300px;">{ 3965 "message": "Unauthenticated." 3966}</code> 3967 </pre> 3968 </span> 3969<span id="execution-results-GETapi-v1-links--link_id--clicks" hidden> 3970 <blockquote>Received response<span 3971 id="execution-response-status-GETapi-v1-links--link_id--clicks"></span>: 3972 </blockquote> 3973 <pre class="json"><code id="execution-response-content-GETapi-v1-links--link_id--clicks" 3974 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 3975</span> 3976<span id="execution-error-GETapi-v1-links--link_id--clicks" hidden> 3977 <blockquote>Request failed with error:</blockquote> 3978 <pre><code id="execution-error-message-GETapi-v1-links--link_id--clicks"> 3979 3980Tip: Check that you're properly connected to the network. 3981If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 3982You can check the Dev Tools console for debugging information.</code></pre> 3983</span> 3984<form id="form-GETapi-v1-links--link_id--clicks" data-method="GET" 3985 data-path="api/v1/links/{link_id}/clicks" 3986 data-authed="0" 3987 data-hasfiles="0" 3988 data-isarraybody="0" 3989 autocomplete="off" 3990 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-links--link_id--clicks', this);"> 3991 <h3> 3992 Request 3993 <button type="button" 3994 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 3995 id="btn-tryout-GETapi-v1-links--link_id--clicks" 3996 onclick="tryItOut('GETapi-v1-links--link_id--clicks');">Try it out â¡ 3997 </button> 3998 <button type="button" 3999 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4000 id="btn-canceltryout-GETapi-v1-links--link_id--clicks" 4001 onclick="cancelTryOut('GETapi-v1-links--link_id--clicks');" hidden>Cancel ð 4002 </button> 4003 <button type="submit" 4004 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4005 id="btn-executetryout-GETapi-v1-links--link_id--clicks" 4006 data-initial-text="Send Request ð¥" 4007 data-loading-text="â± Sending..." 4008 hidden>Send Request ð¥ 4009 </button> 4010 </h3> 4011 <p> 4012 <small class="badge badge-green">GET</small> 4013 <b><code>api/v1/links/{link_id}/clicks</code></b> 4014 </p> 4015 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 4016 <div style="padding-left: 28px; clear: unset;"> 4017 <b style="line-height: 2;"><code>Content-Type</code></b> 4018 4019 4020 4021 <input type="text" style="display: none" 4022 name="Content-Type" data-endpoint="GETapi-v1-links--link_id--cl
4022icks" 4023 value="application/json" 4024 data-component="header"> 4025 <br> 4026<p>Example: <code>application/json</code></p> 4027 </div> 4028 <div style="padding-left: 28px; clear: unset;"> 4029 <b style="line-height: 2;"><code>Accept</code></b> 4030 4031 4032 4033 <input type="text" style="display: none" 4034 name="Accept" data-endpoint="GETapi-v1-links--link_id--clicks" 4035 value="application/json" 4036 data-component="header"> 4037 <br> 4038<p>Example: <code>application/json</code></p> 4039 </div> 4040 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 4041 <div style="padding-left: 28px; clear: unset;"> 4042 <b style="line-height: 2;"><code>link_id</code></b> 4043<small>integer</small> 4044 4045 4046 <input type="number" style="display: none" 4047 step="any" name="link_id" data-endpoint="GETapi-v1-links--link_id--clicks" 4048 value="16" 4049 data-component="url"> 4050 <br> 4051<p>The ID of the link. Example: <code>16</code></p> 4052 </div> 4053 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 4054 <div style=" padding-left: 28px; clear: unset;"> 4055 <b style="line-height: 2;"><code>organization_id</code></b> 4056<small>integer</small> 4057 4058 4059 <input type="number" style="display: none" 4060 step="any" name="organization_id" data-endpoint="GETapi-v1-links--link_id--clicks" 4061 value="16" 4062 data-component="body"> 4063 <br> 4064<p>Must match an existing stored value. Example: <code>16</code></p> 4065 </div> 4066 </form> 4067 4068 <h2 id="links-PATCHapi-v1-links--id-">PATCH api/v1/links/{id}</h2> 4069 4070<p> 4071</p> 4072 4073 4074 4075<span id="example-requests-PATCHapi-v1-links--id-"> 4076<blockquote>Example request:</blockquote> 4077 4078 4079<div class="bash-example"> 4080 <pre><code class="language-bash">curl --request PATCH \ 4081 "prolinks.pro/api/v1/links/16" \ 4082 --header "Content-Type: application/json" \ 4083 --header "Accept: application/json" \ 4084 --data "{ 4085 \"organization_id\": 16, 4086 \"domain_id\": 16, 4087 \"url\": \"http:\\/\\/bailey.com\\/\", 4088 \"slug\": \"architecto\", 4089 \"description\": \"Eius et animi quos velit et.\", 4090 \"is_active\": false, 4091 \"tags\": [ 4092 16 4093 ], 4094 \"campaign_source_id\": 16, 4095 \"campaign_medium_id\": 16, 4096 \"campaign_id\": \"architecto\", 4097 \"campaign_name\": \"architecto\", 4098 \"campaign_term\": \"architecto\", 4099 \"campaign_content\": \"architecto\", 4100 \"schedule\": true, 4101 \"schedule_at\": \"2052-07-09\", 4102 \"schedule_url\": \"http:\\/\\/bailey.com\\/\", 4103 \"expires\": true, 4104 \"expires_at\": \"2052-07-09\", 4105 \"expires_url\": \"http:\\/\\/bailey.com\\/\", 4106 \"protect\": true, 4107 \"ios\": false, 4108 \"ios_url\": \"http:\\/\\/rempel.com\\/sunt-nihil-accusantium-harum-mollitia\", 4109 \"android\": false, 4110 \"android_url\": \"http:\\/\\/www.considine.com\\/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem\", 4111 \"windows\": false, 4112 \"windows_url\": \"http:\\/\\/www.dare.org\\/iure-odit-et-et-modi-ipsum-nostrum-omnis\", 4113 \"macos\": false, 4114 \"macos_url\": \"http:\\/\\/mclaughlin.info\\/dolores-enim-non-facere-tempora\", 4115 \"linux\": true, 4116 \"linux_url\": \"http:\\/\\/www.leffler.info\\/quis-adipisci-molestias-fugit-deleniti-distinctio-eum\" 4117}"
4118</code></pre></div> 4119 4120 4121<div class="javascript-example"> 4122 <pre><code class="language-javascript">const url = new URL( 4123 "prolinks.pro/api/v1/links/16" 4124); 4125 4126const headers = { 4127 "Content-Type": "application/json", 4128 "Accept": "application/json", 4129}; 4130 4131let body = { 4132 "organization_id": 16, 4133 "domain_id": 16, 4134 "url": "http:\/\/bailey.com\/", 4135 "slug": "architecto", 4136 "description": "Eius et animi quos velit et.", 4137 "is_active": false, 4138 "tags": [ 4139 16 4140 ], 4141 "campaign_source_id": 16, 4142 "campaign_medium_id": 16, 4143 "campaign_id": "architecto", 4144 "campaign_name": "architecto", 4145 "campaign_term": "architecto", 4146 "campaign_content": "architecto", 4147 "schedule": true, 4148 "schedule_at": "2052-07-09", 4149 "schedule_url": "http:\/\/bailey.com\/", 4150 "expires": true, 4151 "expires_at": "2052-07-09", 4152 "expires_url": "http:\/\/bailey.com\/", 4153 "protect": true, 4154 "ios": false, 4155 "ios_url": "http:\/\/rempel.com\/sunt-nihil-accusantium-harum-mollitia", 4156 "android": false, 4157 "android_url": "http:\/\/www.considine.com\/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem", 4158 "windows": false, 4159 "windows_url": "http:\/\/www.dare.org\/iure-odit-et-et-modi-ipsum-nostrum-omnis", 4160 "macos": false, 4161 "macos_url": "http:\/\/mclaughlin.info\/dolores-enim-non-facere-tempora", 4162 "linux": true, 4163 "linux_url": "http:\/\/www.leffler.info\/quis-adipisci-molestias-fugit-deleniti-distinctio-eum" 4164}; 4165 4166fetch(url, { 4167 method: "PATCH", 4168 headers, 4169 body: JSON.stringify(body), 4170}).then(response => response.json());</code></pre></div> 4171 4172</span> 4173 4174<span id="example-responses-PATCHapi-v1-links--id-"> 4175</span> 4176<span id="execution-results-PATCHapi-v1-links--id-" hidden> 4177 <blockquote>Received response<span 4178 id="execution-response-status-PATCHapi-v1-links--id-"></span>: 4179 </blockquote> 4180 <pre class="json"><code id="execution-response-content-PATCHapi-v1-links--id-" 4181 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 4182</span> 4183<span id="execution-error-PATCHapi-v1-links--id-" hidden> 4184 <blockquote>Request failed with error:</blockquote> 4185 <pre><code id="execution-error-message-PATCHapi-v1-links--id-"> 4186 4187Tip: Check that you're properly connected to the network. 4188If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 4189You can check the Dev Tools console for debugging information.</code></pre> 4190</span> 4191<form id="form-PATCHapi-v1-links--id-" data-method="PATCH" 4192 data-path="api/v1/links/{id}" 4193 data-authed="0" 4194 data-hasfiles="0" 4195 data-isarraybody="0" 4196 autocomplete="off" 4197 onsubmit="event.preventDefault(); executeTryOut('PATCHapi-v1-links--id-', this);"> 4198 <h3> 4199 Request 4200 <button type="button" 4201 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4202 id="btn-tryout-PATCHapi-v1-links--id-" 4203 onclick="tryItOut('PATCHapi-v1-links--id-');">Try it out â¡ 4204 </button> 4205 <button type="button" 4206 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4207 id="btn-canceltryout-PATCHapi-v1-links--id-" 4208 onclick="cancelTryOut('PATCHapi-v1-links--id-');" hidden>Cancel ð 4209 </button> 4210 <button type="submit" 4211 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4212 id="btn-executetryout-PATCHapi-v1-links--id-" 4213 data-initial-text="Send Request ð¥" 4214 data-loading-text="â± Sending..." 4215 hidden>Send Request ð¥ 4216 </button> 4217 </h3> 4218 <p> 4219 <small class="badge badge-purple">PATCH</small> 4220 <b><code>api/v1/links/{id}</code></b> 4221 </p> 4222 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 4223 <div style="padding-left: 28px; clear: unset;"> 4224 <b style="line-height: 2;"><code>Content-Type</code></b> 4225 4226 4227 4228 <input type="text" style="display: none" 4229 name="Content-Type" data-endpoint="PATCHapi-v1-links--id-" 4230 value="application/json" 4231 data-component="header"> 4232 <br> 4233<p>Example: <code>application/json</code></p> 4234 </div> 4235 <div style="padding-left: 28px; clear: unset;"> 4236 <b style="line-height: 2;"><code>Accept</code></b> 4237 4238 4239 4240 <input type="text" style="display: none" 4241 name="Accept" data-endpoint="PATCHapi-v1-links--id-" 4242 value="application/json" 4243 data-component="header"> 4244 <br> 4245<p>Example: <code>application/json</code></p> 4246 </div> 4247 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 4248 <div style="padding-left: 28px; clear: unset;"> 4249 <b style="line-height: 2;"><code>id</code></b> 4250<small>integer</small> 4251 4252 4253 <input type="number" style="display: none" 4254 step="any" name="id" data-endpoint="PATCHapi-v1-links--id-" 4255 value="16" 4256 data-component="url"> 4257 <br> 4258<p>
4258The ID of the link. Example: <code>16</code></p> 4259 </div> 4260 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 4261 <div style=" padding-left: 28px; clear: unset;"> 4262 <b style="line-height: 2;"><code>organization_id</code></b> 4263<small>integer</small> 4264 4265 4266 <input type="number" style="display: none" 4267 step="any" name="organization_id" data-endpoint="PATCHapi-v1-links--id-" 4268 value="16" 4269 data-component="body"> 4270 <br> 4271<p>Must match an existing stored value. Example: <code>16</code></p> 4272 </div> 4273 <div style=" padding-left: 28px; clear: unset;"> 4274 <b style="line-height: 2;"><code>domain_id</code></b> 4275<small>integer</small> 4276 4277 4278 <input type="number" style="display: none" 4279 step="any" name="domain_id" data-endpoint="PATCHapi-v1-links--id-" 4280 value="16" 4281 data-component="body"> 4282 <br> 4283<p>Must match an existing stored value. Example: <code>16</code></p> 4284 </div> 4285 <div style=" padding-left: 28px; clear: unset;"> 4286 <b style="line-height: 2;"><code>url</code></b> 4287<small>string</small> 4288<i>optional</i> 4289 4290 <input type="text" style="display: none" 4291 name="url" data-endpoint="PATCHapi-v1-links--id-" 4292 value="http://bailey.com/" 4293 data-component="body"> 4294 <br> 4295<p>Must be a valid URL. Example: <code>http://bailey.com/</code></p> 4296 </div> 4297 <div style=" padding-left: 28px; clear: unset;"> 4298 <b style="line-height: 2;"><code>slug</code></b> 4299<small>string</small> 4300<i>optional</i> 4301 4302 <input type="text" style="display: none" 4303 name="slug" data-endpoint="PATCHapi-v1-links--id-" 4304 value="architecto" 4305 data-component="body"> 4306 <br> 4307<p>Example: <code>architecto</code></p> 4308 </div> 4309 <div style=" padding-left: 28px; clear: unset;"> 4310 <b style="line-height: 2;"><code>description</code></b> 4311<small>string</small> 4312<i>optional</i> 4313 4314 <input type="text" style="display: none" 4315 name="description" data-endpoint="PATCHapi-v1-links--id-" 4316 value="Eius et animi quos velit et." 4317 data-component="body"> 4318 <br> 4319<p>Example: <code>Eius et animi quos velit et.</code></p> 4320 </div> 4321 <div style=" padding-left: 28px; clear: unset;"> 4322 <b style="line-height: 2;"><code>is_active</code></b> 4323<small>boolean</small> 4324<i>optional</i> 4325 4326 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4327 <input type="radio" name="is_active" 4328 value="true" 4329 data-endpoint="PATCHapi-v1-links--id-" 4330 data-component="body" > 4331 <code>true</code> 4332 </label> 4333 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4334 <input type="radio" name="is_active" 4335 value="false" 4336 data-endpoint="PATCHapi-v1-links--id-" 4337 data-component="body" > 4338 <code>false</code> 4339 </label> 4340 <br> 4341<p>Example: <code>false</code></p> 4342 </div> 4343 <div style=" padding-left: 28px; clear: unset;"> 4344 <b style="line-height: 2;"><code>tags</code></b> 4345<small>integer[]</small> 4346<i>optional</i> 4347 4348 <input type="number" style="display: none" 4349 step="any" name="tags[0]" data-endpoint="PATCHapi-v1-links--id-" 4350 data-component="body"> 4351 <input type="number" style="display: none" 4352 name="tags[1]" data-endpoint="PATCHapi-v1-links--id-" 4353 data-component="body"> 4354 <br> 4355 4356 </div> 4357 <div style=" padding-left: 28px; clear: unset;"> 4358 <b style="line-height: 2;"><code>campaign_source_id</code></b> 4359<small>integer</small> 4360<i>optional</i> 4361 4362 <input type="number" style="display: none" 4363 step="any" name="campaign_source_id" data-endpoint="PATCHapi-v1-links--id-" 4364 value="16" 4365 data-component="body"> 4366 <br> 4367<p>Example: <code>16</code></p> 4368 </div> 4369 <div style=" padding-left: 28px; clear: unset;"> 4370 <b style="line-height: 2;"><code>campaign_medium_id</code></b> 4371<small>integer</small> 4372<i>optional</i> 4373 4374 <input type="number" style="display: none" 4375 step="any" name="campaign_medium_id" data-endpoint="PATCHapi-v1-links--id-" 4376 value="16" 4377 data-component="body"> 4378 <br> 4379<p>Example: <code>16</code></p> 4380 </div> 4381 <div style=" padding-left: 28px; clear: unset;"> 4382 <b style="line-height: 2;"><code>campaign_id</code></b> 4383<small>string</small> 4384<i>optional</i> 4385 4386 <input type="text" style="display: none" 4387 name="campaign_id" data-endpoint="PATCHapi-v1-links--id-" 4388 value="architecto" 4389 data-component="body"> 4390 <br> 4391<p>Example: <code>architecto</code></p> 4392 </div> 4393 <div style=" padding-left: 28px; clear: unset;"> 4394 <b style="line-height: 2;"><code>campaign_name</code></b> 4395<small>string</small> 4396<i>optional</i> 4397 4398 <input type="text" style="display: none" 4399 name="campaign_name" data-endpoint="PATCHapi-v1-links--id-" 4400 value="architecto" 4401 data-component="body"> 4402 <br> 4403<p>Example: <code>architecto</code></p> 4404 </div> 4405 <div style=" padding-left: 28px; clear: unset;"> 4406 <b style="line-height: 2;"><code>campaign_term</code></b> 4407<small>string</small> 4408<i>optional</i> 4409 4410 <input type="text" style="display: none" 4411 name="campaign_term" data-endpoint="PATCHapi-v1-links--id-" 4412 value="architecto" 4413 data-component="body"> 4414 <br> 4415<p>Example: <code>architecto</code></p> 4416 </div> 4417 <div style=" padding-left: 28px; clear: unset;"> 4418 <b style="line-height: 2;"><code>campaign_content</code></b> 4419<small>string</small> 4420<i>optional</i> 4421 4422 <input type="text" style="display: none" 4423 name="campaign_content" data-endpoint="PATCHapi-v1-links--id-" 4424 value="architecto" 4425 data-component="body"> 4426 <br> 4427<p>Example: <code>architecto</code></p> 4428 </div> 4429 <div style=" padding-left: 28px; clear: unset;"> 4430 <b style="line-height: 2;"><code>schedule</code></b> 4431<small>boolean</small> 4432<i>optional</i> 4433 4434 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4435 <input type="radio" name="schedule" 4436 value="true" 4437 data-endpoint="PATCHapi-v1-links--id-" 4438 data-component="body" > 4439 <code>true</code> 4440 </label> 4441 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4442 <input type="radio" name="schedule" 4443 value="false" 4444 data-endpoint="PATCHapi-v1-links--id-" 4445 data-component="body" > 4446 <code>false</code> 4447 </label> 4448 <br> 4449<p>Example: <code>true</code></p> 4450 </div> 4451 <div style=" padding-left: 28px; clear: unset;"> 4452 <b style="line-height: 2;"><code>schedule_at</code></b> 4453<small>string</small> 4454<i>optional</i> 4455 4456 <input type="text" style="display: none" 4457 name="schedule_at" data-endpoint="PATCHapi-v1-links--id-" 4458 value="2052-07-09" 4459 data-component="body"> 4460 <br> 4461<p>This field is required when <code>schedule</code> is <code>true</code>. Must be a valid date in the format <code>d/m/Y H:i</code>. Must be a date after <code>now</code>. Example: <code>2052-07-09</code></p> 4462 </div> 4463 <div style=" padding-left: 28px; clear: unset;"> 4464 <b style="line-height: 2;"><code>schedule_url</code></b> 4465<small>string</small> 4466<i>optional</i> 4467 4468 <input type="text" style="display: none" 4469 name="schedule_url" data-endpoint="PATCHapi-v1-links--id-" 4470 value="http://bailey.com/" 4471 data-component="body"> 4472 <br> 4473<p>Must be a valid URL. Example: <code>http://bailey.com/</code></p> 4474 </div> 4475 <div style=" padding-left: 28px; clear: unset;"> 4476 <b style="line-height: 2;"><code>expires</code></b> 4477<small>boolean</small> 4478<i>optional</i> 4479 4480 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4481 <input type="radio" name="expires" 4482 value="true" 4483 data-endpoint="PATCHapi-v1-links--id-" 4484 data-component="body" > 4485 <code>true</code> 4486 </label> 4487 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4488 <input type="radio" name="expires" 4489 value="false" 4490 data-endpoint="PATCHapi-v1-links--id-" 4491 data-component="body" > 4492 <code>false</code> 4493 </label> 4494 <br> 4495<p>Example: <code>true</code></p> 4496 </div> 4497 <div style=" padding-left: 28px; clear: unset;"> 4498 <b style="line-height: 2;"><code>expires_at</code></b> 4499<small>string</small> 4500<i>optional</i> 4501 4502 <input type="text" style="display: none" 4503 name="expires_at" data-endpoint="PATCHapi-v1-links--id-" 4504 value="2052-07-09" 4505 data-component="body"> 4506 <br> 4507<p>This field is required when <code>expires</code> is <code>true</code>. Must be a valid date in the format <code>d/m/Y H:i</code>. Must be a date after <code>now</code>. Example: <code>2052-07-09</code></p> 4508 </div> 4509 <div style=" padding-left: 28px; clear: unset;"> 4510 <b style="line-height: 2;"><code>expires_url</code></b> 4511<small>string</small> 4512<i>optional</i> 4513 4514 <input type="text" style="display: none" 4515 name="expires_url" data-endpoint="PATCHapi-v1-links--id-" 4516 value="http://bailey.com/" 4517 data-component="body"> 4518 <br> 4519<p>Must be a valid URL. Example: <code>http://bailey.com/</code></p> 4520 </div> 4521 <div style=" padding-left: 28px; clear: unset;"> 4522 <b style="line-height: 2;"><code>protect</code></b> 4523<small>boolean</small> 4524<i>optional</i> 4525 4526 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4527 <input type="radio" name="protect" 4528 value="true" 4529 data-endpoint="PATCHapi-v1-links--id-" 4530 data-component="body" > 4531 <code>true</code> 4532 </label> 4533 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4534 <input type="radio" name="protect" 4535 value="false" 4536 data-endpoint="PATCHapi-v1-links--id-" 4537 data-component="body" > 4538 <code>false</code> 4539 </label> 4540 <br> 4541<p>Example: <code>true</code></p> 4542 </div> 4543 <div style=" padding-left: 28px; clear: unset;"> 4544 <b style="line-height: 2;"><code>ios</code></b> 4545<small>boolean</small> 4546<i>optional</i> 4547 4548 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4549 <input type="radio" name="ios" 4550 value="true" 4551 data-endpoint="PATCHapi-v1-links--id-" 4552 data-component="body" > 4553 <code>true</code> 4554 </label> 4555 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4556 <input type="radio" name="ios" 4557 value="false" 4558 data-endpoint="PATCHapi-v1-links--id-" 4559 data-component="body" > 4560 <code>false</code> 4561 </label> 4562 <br> 4563<p>Example: <code>false</code></p> 4564 </div> 4565 <div style=" padding-left: 28px; clear: unset;"> 4566 <b style="line-height: 2;"><code>ios_url</code></b> 4567<small>string</small> 4568<i>optional</i> 4569 4570 <input type="text" style="display: none" 4571 name="ios_url" data-endpoint="PATCHapi-v1-links--id-" 4572 value="http://rempel.com/sunt-nihil-accusantium-harum-mollitia" 4573 data-component="body"> 4574 <br> 4575<p>This field is required when <code>ios</code> is <code>true</code>. Must be a valid URL. Example: <code>http://rempel.com/sunt-nihil-accusantium-harum-mollitia</code></p> 4576 </div> 4577 <div style=" padding-left: 28px; clear: unset;"> 4578 <b style="line-height: 2;"><code>android</code></b> 4579<small>boolean</small> 4580<i>optional</i> 4581 4582 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4583 <input type="radio" name="android" 4584 value="true" 4585 data-endpoint="PATCHapi-v1-links--id-" 4586 data-component="body" > 4587 <code>true</code> 4588 </label> 4589 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4590 <input type="radio" name="android" 4591 value="false" 4592 data-endpoint="PATCHapi-v1-links--id-" 4593 data-component="body" > 4594 <code>false</code> 4595 </label> 4596 <br> 4597<p>Example: <code>false</code></p> 4598 </div> 4599 <div style=" padding-left: 28px; clear: unset;"> 4600 <b style="line-height: 2;"><code>android_url</code></b> 4601<small>string</small> 4602<i>optional</i> 4603 4604 <input type="text" style="display: none" 4605 name="android_url" data-endpoint="PATCHapi-v1-links--id-" 4606 value="http://www.considine.com/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem" 4607 data-component="body"> 4608 <br> 4609<p>This field is required when <code>android</code> is <code>true</code>. Must be a valid URL. Example: <code>http://www.considine.com/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem</code></p> 4610 </div> 4611 <div style=" padding-left: 28px; clear: unset;"> 4612 <b style="line-height: 2;"><code>windows</code></b> 4613<small>boolean</small> 4614<i>optional</i> 4615 4616 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4617 <input type="radio" name="windows" 4618 value="true" 4619 data-endpoint="PATCHapi-v1-links--id-" 4620 data-component="body" > 4621 <code>true</code> 4622 </label> 4623 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4624 <input type="radio" name="windows" 4625 value="false" 4626 data-endpoint="PATCHapi-v1-links--id-" 4627
4627 data-component="body" > 4628 <code>false</code> 4629 </label> 4630 <br> 4631<p>Example: <code>false</code></p> 4632 </div> 4633 <div style=" padding-left: 28px; clear: unset;"> 4634 <b style="line-height: 2;"><code>windows_url</code></b> 4635<small>string</small> 4636<i>optional</i> 4637 4638 <input type="text" style="display: none" 4639 name="windows_url" data-endpoint="PATCHapi-v1-links--id-" 4640 value="http://www.dare.org/iure-odit-et-et-modi-ipsum-nostrum-omnis" 4641 data-component="body"> 4642 <br> 4643<p>This field is required when <code>windows</code> is <code>true</code>. Must be a valid URL. Example: <code>http://www.dare.org/iure-odit-et-et-modi-ipsum-nostrum-omnis</code></p> 4644 </div> 4645 <div style=" padding-left: 28px; clear: unset;"> 4646 <b style="line-height: 2;"><code>macos</code></b> 4647<small>boolean</small> 4648<i>optional</i> 4649 4650 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4651 <input type="radio" name="macos" 4652 value="true" 4653 data-endpoint="PATCHapi-v1-links--id-" 4654 data-component="body" > 4655 <code>true</code> 4656 </label> 4657 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4658 <input type="radio" name="macos" 4659 value="false" 4660 data-endpoint="PATCHapi-v1-links--id-" 4661 data-component="body" > 4662 <code>false</code> 4663 </label> 4664 <br> 4665<p>Example: <code>false</code></p> 4666 </div> 4667 <div style=" padding-left: 28px; clear: unset;"> 4668 <b style="line-height: 2;"><code>macos_url</code></b> 4669<small>string</small> 4670<i>optional</i> 4671 4672 <input type="text" style="display: none" 4673 name="macos_url" data-endpoint="PATCHapi-v1-links--id-" 4674 value="http://mclaughlin.info/dolores-enim-non-facere-tempora" 4675 data-component="body"> 4676 <br> 4677<p>This field is required when <code>macos</code> is <code>true</code>. Must be a valid URL. Example: <code>http://mclaughlin.info/dolores-enim-non-facere-tempora</code></p> 4678 </div> 4679 <div style=" padding-left: 28px; clear: unset;"> 4680 <b style="line-height: 2;"><code>linux</code></b> 4681<small>boolean</small> 4682<i>optional</i> 4683 4684 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4685 <input type="radio" name="linux" 4686 value="true" 4687 data-endpoint="PATCHapi-v1-links--id-" 4688 data-component="body" > 4689 <code>true</code> 4690 </label> 4691 <label data-endpoint="PATCHapi-v1-links--id-" style="display: none"> 4692 <input type="radio" name="linux" 4693 value="false" 4694 data-endpoint="PATCHapi-v1-links--id-" 4695 data-component="body" > 4696 <code>false</code> 4697 </label> 4698 <br> 4699<p>Example: <code>true</code></p> 4700 </div> 4701 <div style=" padding-left: 28px; clear: unset;"> 4702 <b style="line-height: 2;"><code>linux_url</code></b> 4703<small>string</small> 4704<i>optional</i> 4705 4706 <input type="text" style="display: none" 4707 name="linux_url" data-endpoint="PATCHapi-v1-links--id-" 4708 value="http://www.leffler.info/quis-adipisci-molestias-fugit-deleniti-distinctio-eum" 4709 data-component="body"> 4710 <br> 4711<p>This field is required when <code>linux</code> is <code>true</code>. Must be a valid URL. Example: <code>http://www.leffler.info/quis-adipisci-molestias-fugit-deleniti-distinctio-eum</code></p> 4712 </div> 4713 </form> 4714 4715 <h2 id="links-DELETEapi-v1-links--id-">DELETE api/v1/links/{id}</h2> 4716 4717<p> 4718</p> 4719 4720 4721 4722<span id="example-requests-DELETEapi-v1-links--id-"> 4723<blockquote>Example request:</blockquote> 4724 4725 4726<div class="bash-example"> 4727 <pre><code class="language-bash">curl --request DELETE \ 4728 "prolinks.pro/api/v1/links/16" \ 4729 --header "Content-Type: application/json" \ 4730 --header "Accept: application/json" \ 4731 --data "{ 4732 \"organization_id\": 16, 4733 \"domain_id\": 16 4734}" 4735</code></pre></div> 4736 4737 4738<div class="javascript-example"> 4739 <pre><code class="language-javascript">const url = new URL( 4740 "prolinks.pro/api/v1/links/16" 4741); 4742 4743const headers = { 4744 "Content-Type": "application/json", 4745 "Accept": "application/json", 4746}; 4747 4748let body = { 4749 "organization_id": 16, 4750 "domain_id": 16 4751}; 4752 4753fetch(url, { 4754 method: "DELETE", 4755 headers, 4756 body: JSON.stringify(body), 4757}).then(response => response.json());</code></pre></div> 4758 4759</span> 4760 4761<span id="example-responses-DELETEapi-v1-links--id-"> 4762</span> 4763<span id="execution-results-DELETEapi-v1-links--id-" hidden> 4764 <blockquote>Received response<span 4765 id="execution-response-status-DELETEapi-v1-links--id-"></span>: 4766 </blockquote> 4767 <pre class="json"><code id="execution-response-content-DELETEapi-v1-links--id-" 4768 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 4769</span> 4770<span id="execution-error-DELETEapi-v1-links--id-" hidden> 4771 <blockquote>Request failed with error:</blockquote> 4772 <pre><code id="execution-error-message-DELETEapi-v1-links--id-"> 4773 4774Tip: Check that you're properly connected to the network. 4775If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 4776You can check the Dev Tools console for debugging information.</code></pre> 4777</span> 4778<form id="form-DELETEapi-v1-links--id-" data-method="DELETE" 4779 data-path="api/v1/links/{id}" 4780 data-authed="0" 4781 data-hasfiles="0" 4782 data-isarraybody="0" 4783 autocomplete="off" 4784 onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-links--id-', this);"> 4785 <h3> 4786 Request 4787 <button type="button" 4788 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4789 id="btn-tryout-DELETEapi-v1-links--id-" 4790 onclick="tryItOut('DELETEapi-v1-links--id-');">Try it out â¡ 4791 </button> 4792 <button type="button" 4793 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4794 id="btn-canceltryout-DELETEapi-v1-links--id-" 4795 onclick="cancelTryOut('DELETEapi-v1-links--id-');" hidden>Cancel ð 4796 </button> 4797 <button type="submit" 4798 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4799 id="btn-executetryout-DELETEapi-v1-links--id-" 4800 data-initial-text="Send Request ð¥" 4801 data-loading-text="â± Sending..." 4802 hidden>Send Request ð¥ 4803 </button> 4804 </h3> 4805 <p> 4806 <small class="badge badge-red">DELETE</small> 4807 <b><code>api/v1/links/{id}</code></b> 4808 </p> 4809 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 4810 <div style="padding-left: 28px; clear: unset;"> 4811 <b style="line-height: 2;"><code>Content-Type</code></b> 4812 4813 4814 4815 <input type="text" style="display: none" 4816 name="Content-Type" data-endpoint="DELETEapi-v1-links--id-" 4817 value="application/json" 4818 data-component="header"> 4819 <br> 4820<p>Example: <code>application/json</code></p> 4821 </div> 4822 <div style="padding-left: 28px; clear: unset;"> 4823 <b style="line-height: 2;"><code>Accept</code></b> 4824 4825 4826 4827 <input type="text" style="display: none" 4828 name="Accept" data-endpoint="DELETEapi-v1-links--id-" 4829 value="application/json" 4830 data-component="header"> 4831 <br> 4832<p>Example: <code>application/json</code></p> 4833 </div> 4834 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 4835 <div style="padding-left: 28px; clear: unset;"> 4836 <b style="line-height: 2;"><code>id</code></b> 4837<small>integer</small> 4838 4839 4840 <input type="number" style="display: none" 4841 step="any" name="id" data-endpoint="DELETEapi-v1-links--id-" 4842 value="16" 4843 data-component="url"> 4844 <br> 4845<p>
4845The ID of the link. Example: <code>16</code></p> 4846 </div> 4847 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 4848 <div style=" padding-left: 28px; clear: unset;"> 4849 <b style="line-height: 2;"><code>organization_id</code></b> 4850<small>integer</small> 4851 4852 4853 <input type="number" style="display: none" 4854 step="any" name="organization_id" data-endpoint="DELETEapi-v1-links--id-" 4855 value="16" 4856 data-component="body"> 4857 <br> 4858<p>Must match an existing stored value. Example: <code>16</code></p> 4859 </div> 4860 <div style=" padding-left: 28px; clear: unset;"> 4861 <b style="line-height: 2;"><code>domain_id</code></b> 4862<small>integer</small> 4863 4864 4865 <input type="number" style="display: none" 4866 step="any" name="domain_id" data-endpoint="DELETEapi-v1-links--id-" 4867 value="16" 4868 data-component="body"> 4869 <br> 4870<p>Must match an existing stored value. Example: <code>16</code></p> 4871 </div> 4872 </form> 4873 4874 <h1 id="organizations">Organizations</h1> 4875 4876 4877 4878 <h2 id="organizations-GETapi-v1-organizations">GET api/v1/organizations</h2> 4879 4880<p> 4881</p> 4882 4883 4884 4885<span id="example-requests-GETapi-v1-organizations"> 4886<blockquote>Example request:</blockquote> 4887 4888 4889<div class="bash-example"> 4890 <pre><code class="language-bash">curl --request GET \ 4891 --get "prolinks.pro/api/v1/organizations" \ 4892 --header "Content-Type: application/json" \ 4893 --header "Accept: application/json"</code></pre></div> 4894 4895 4896<div class="javascript-example"> 4897 <pre><code class="language-javascript">const url = new URL( 4898 "prolinks.pro/api/v1/organizations" 4899); 4900 4901const headers = { 4902 "Content-Type": "application/json", 4903 "Accept": "application/json", 4904}; 4905 4906 4907fetch(url, { 4908 method: "GET", 4909 headers, 4910}).then(response => response.json());</code></pre></div> 4911 4912</span> 4913 4914<span id="example-responses-GETapi-v1-organizations"> 4915 <blockquote> 4916 <p>Example response (401):</p> 4917 </blockquote> 4918 <details class="annotation"> 4919 <summary style="cursor: pointer;"> 4920 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 4921 </summary> 4922 <pre><code class="language-http">cache-control: no-cache, private 4923content-type: application/json 4924access-control-allow-origin: * 4925 </code></pre></details> <pre> 4926 4927<code class="language-json" style="max-height: 300px;">{ 4928 "message": "Unauthenticated." 4929}</code> 4930 </pre> 4931 </span> 4932<span id="execution-results-GETapi-v1-organizations" hidden> 4933 <blockquote>Received response<span 4934 id="execution-response-status-GETapi-v1-organizations"></span>: 4935 </blockquote> 4936 <pre class="json"><code id="execution-response-content-GETapi-v1-organizations" 4937 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 4938</span> 4939<span id="execution-error-GETapi-v1-organizations" hidden> 4940 <blockquote>Request failed with error:</blockquote> 4941 <pre><code id="execution-error-message-GETapi-v1-organizations"> 4942 4943Tip: Check that you're properly connected to the network. 4944If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 4945You can check the Dev Tools console for debugging information.</code></pre> 4946</span> 4947<form id="form-GETapi-v1-organizations" data-method="GET" 4948 data-path="api/v1/organizations" 4949 data-authed="0" 4950 data-hasfiles="0" 4951 data-isarraybody="0" 4952 autocomplete="off" 4953 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-organizations', this);"> 4954 <h3> 4955 Request 4956 <button type="button" 4957 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4958 id="btn-tryout-GETapi-v1-organizations" 4959 onclick="tryItOut('GETapi-v1-organizations');">Try it out â¡ 4960 </button> 4961 <button type="button" 4962 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4963 id="btn-canceltryout-GETapi-v1-organizations" 4964 onclick="cancelTryOut('GETapi-v1-organizations');" hidden>Cancel ð 4965 </button> 4966 <button type="submit" 4967 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 4968 id="btn-executetryout-GETapi-v1-organizations" 4969 data-initial-text="Send Request ð¥" 4970 data-loading-text="â± Sending..." 4971 hidden>Send Request ð¥ 4972 </button> 4973 </h3> 4974 <p> 4975 <small class="badge badge-green">GET</small> 4976 <b><code>api/v1/organizations</code></b> 4977 </p> 4978 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 4979 <div style="padding-left: 28px; clear: unset;"> 4980 <b style="line-height: 2;"><code>Content-Type</code></b> 4981 4982 4983 4984 <input type="text" style="display: none" 4985 name="Content-Type" data-endpoint="GETapi-v1-organizations" 4986 value="application/json" 4987 data-component="header"> 4988 <br> 4989<p>Example: <code>application/json</code></p> 4990 </div> 4991 <div style="padding-left: 28px; clear: unset;"> 4992 <b style="line-height: 2;"><code>Accept</code></b> 4993 4994 4995 4996 <input type="text" style="display: none" 4997 name="Accept" data-endpoint="GETapi-v1-organizations" 4998 value="application/json" 4999 data-component="header"> 5000 <br> 5001<p>Example: <code>application/json</code></p> 5002 </div> 5003 </form> 5004 5005 <h2 id="organizations-GETapi-v1-organizations--id-">GET api/v1/organizations/{id}</h2> 5006 5007<p> 5008</p> 5009 5010 5011 5012<span id="example-requests-GETapi-v1-organizations--id-"> 5013<blockquote>Example request:</blockquote> 5014 5015 5016<div class="bash-example"> 5017 <pre><code class="language-bash">curl --request GET \ 5018 --get "prolinks.pro/api/v1/organizations/1" \ 5019 --header "Content-Type: application/json" \ 5020 --header "Accept: application/json"</code></pre></div> 5021 5022 5023<div class="javascript-example"> 5024 <pre><code class="language-javascript">const url = new URL( 5025 "prolinks.pro/api/v1/organizations/1" 5026); 5027 5028const headers = { 5029 "Content-Type": "application/json", 5030 "Accept": "application/json", 5031}; 5032 5033 5034fetch(url, { 5035 method: "GET", 5036 headers, 5037}).then(response => response.json());</code></pre></div> 5038 5039</span> 5040 5041<span id="example-responses-GETapi-v1-organizations--id-"> 5042 <blockquote> 5043 <p>
5043Example response (401):</p> 5044 </blockquote> 5045 <details class="annotation"> 5046 <summary style="cursor: pointer;"> 5047 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 5048 </summary> 5049 <pre><code class="language-http">cache-control: no-cache, private 5050content-type: application/json 5051access-control-allow-origin: * 5052 </code></pre></details> <pre> 5053 5054<code class="language-json" style="max-height: 300px;">{ 5055 "message": "Unauthenticated." 5056}</code> 5057 </pre> 5058 </span> 5059<span id="execution-results-GETapi-v1-organizations--id-" hidden> 5060 <blockquote>Received response<span 5061 id="execution-response-status-GETapi-v1-organizations--id-"></span>: 5062 </blockquote> 5063 <pre class="json"><code id="execution-response-content-GETapi-v1-organizations--id-" 5064 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 5065</span> 5066<span id="execution-error-GETapi-v1-organizations--id-" hidden> 5067 <blockquote>Request failed with error:</blockquote> 5068 <pre><code id="execution-error-message-GETapi-v1-organizations--id-"> 5069 5070Tip: Check that you're properly connected to the network. 5071If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 5072You can check the Dev Tools console for debugging information.</code></pre> 5073</span> 5074<form id="form-GETapi-v1-organizations--id-" data-method="GET" 5075 data-path="api/v1/organizations/{id}" 5076 data-authed="0" 5077 data-hasfiles="0" 5078 data-isarraybody="0" 5079 autocomplete="off" 5080 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-organizations--id-', this);"> 5081 <h3> 5082 Request 5083 <button type="button" 5084 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5085 id="btn-tryout-GETapi-v1-organizations--id-" 5086 onclick="tryItOut('GETapi-v1-organizations--id-');">Try it out â¡ 5087 </button> 5088 <button type="button" 5089 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5090 id="btn-canceltryout-GETapi-v1-organizations--id-" 5091 onclick="cancelTryOut('GETapi-v1-organizations--id-');" hidden>Cancel ð 5092 </button> 5093 <button type="submit" 5094 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5095 id="btn-executetryout-GETapi-v1-organizations--id-" 5096 data-initial-text="Send Request ð¥" 5097 data-loading-text="â± Sending..." 5098 hidden>Send Request ð¥ 5099 </button> 5100 </h3> 5101 <p> 5102 <small class="badge badge-green">GET</small> 5103 <b><code>api/v1/organizations/{id}</code></b> 5104 </p> 5105 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 5106 <div style="padding-left: 28px; clear: unset;"> 5107 <b style="line-height: 2;"><code>Content-Type</code></b> 5108 5109 5110 5111 <input type="text" style="display: none" 5112 name="Content-Type" data-endpoint="GETapi-v1-organizations--id-" 5113 value="application/json" 5114 data-component="header"> 5115 <br> 5116<p>Example: <code>application/json</code></p> 5117 </div> 5118 <div style="padding-left: 28px; clear: unset;"> 5119 <b style="line-height: 2;"><code>Accept</code></b> 5120 5121 5122 5123 <input type="text" style="display: none" 5124 name="Accept" data-endpoint="GETapi-v1-organizations--id-" 5125 value="application/json" 5126 data-component="header"> 5127 <br> 5128<p>Example: <code>application/json</code></p> 5129 </div> 5130 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 5131 <div style="padding-left: 28px; clear: unset;"> 5132 <b style="line-height: 2;"><code>id</code></b> 5133<small>integer</small> 5134 5135 5136 <input type="number" style="display: none" 5137 step="any" name="id" data-endpoint="GETapi-v1-organizations--id-" 5138 value="1" 5139 data-component="url"> 5140 <br> 5141<p>The ID of the organization. Example: <code>1</code></p> 5142 </div> 5143 </form> 5144 5145 <h1 id="tags">Tags</h1> 5146 5147 5148 5149 <h2 id="tags-GETapi-v1-tags">GET api/v1/tags</h2> 5150 5151<p> 5152</p> 5153 5154 5155 5156<span id="example-requests-GETapi-v1-tags"> 5157<blockquote>Example request:</blockquote> 5158 5159 5160<div class="bash-example"> 5161 <pre><code class="language-bash">curl --request GET \ 5162 --get "prolinks.pro/api/v1/tags" \ 5163 --header "Content-Type: application/json" \ 5164 --header "Accept: application/json" \ 5165 --data "{ 5166 \"organization_id\": 16 5167}" 5168</code></pre></div> 5169 5170 5171<div class="javascript-example"> 5172 <pre><code class="language-javascript">const url = new URL( 5173 "prolinks.pro/api/v1/tags" 5174); 5175 5176const headers = { 5177 "Content-Type": "application/json", 5178 "Accept": "application/json", 5179}; 5180 5181let body = { 5182 "organization_id": 16 5183}; 5184 5185fetch(url, { 5186 method: "GET", 5187 headers, 5188 body: JSON.stringify(body), 5189}).then(response => response.json());</code></pre></div> 5190 5191</span> 5192 5193<span id="example-responses-GETapi-v1-tags"> 5194 <blockquote> 5195 <p>
5195Example response (401):</p> 5196 </blockquote> 5197 <details class="annotation"> 5198 <summary style="cursor: pointer;"> 5199 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 5200 </summary> 5201 <pre><code class="language-http">cache-control: no-cache, private 5202content-type: application/json 5203access-control-allow-origin: * 5204 </code></pre></details> <pre> 5205 5206<code class="language-json" style="max-height: 300px;">{ 5207 "message": "Unauthenticated." 5208}</code> 5209 </pre> 5210 </span> 5211<span id="execution-results-GETapi-v1-tags" hidden> 5212 <blockquote>Received response<span 5213 id="execution-response-status-GETapi-v1-tags"></span>: 5214 </blockquote> 5215 <pre class="json"><code id="execution-response-content-GETapi-v1-tags" 5216 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 5217</span> 5218<span id="execution-error-GETapi-v1-tags" hidden> 5219 <blockquote>Request failed with error:</blockquote> 5220 <pre><code id="execution-error-message-GETapi-v1-tags"> 5221 5222Tip: Check that you're properly connected to the network. 5223If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 5224You can check the Dev Tools console for debugging information.</code></pre> 5225</span> 5226<form id="form-GETapi-v1-tags" data-method="GET" 5227 data-path="api/v1/tags" 5228 data-authed="0" 5229 data-hasfiles="0" 5230 data-isarraybody="0" 5231 autocomplete="off" 5232 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-tags', this);"> 5233 <h3> 5234 Request 5235 <button type="button" 5236 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5237 id="btn-tryout-GETapi-v1-tags" 5238 onclick="tryItOut('GETapi-v1-tags');">Try it out â¡ 5239 </button> 5240 <button type="button" 5241 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5242 id="btn-canceltryout-GETapi-v1-tags" 5243 onclick="cancelTryOut('GETapi-v1-tags');" hidden>Cancel ð 5244 </button> 5245 <button type="submit" 5246 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5247 id="btn-executetryout-GETapi-v1-tags" 5248 data-initial-text="Send Request ð¥" 5249 data-loading-text="â± Sending..." 5250 hidden>Send Request ð¥ 5251 </button> 5252 </h3> 5253 <p> 5254 <small class="badge badge-green">GET</small> 5255 <b><code>api/v1/tags</code></b> 5256 </p> 5257 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 5258 <div style="padding-left: 28px; clear: unset;"> 5259 <b style="line-height: 2;"><code>Content-Type</code></b> 5260 5261 5262 5263 <input type="text" style="display: none" 5264 name="Content-Type" data-endpoint="GETapi-v1-tags" 5265 value="application/json" 5266 data-component="header"> 5267 <br> 5268<p>Example: <code>application/json</code></p> 5269 </div> 5270 <div style="padding-left: 28px; clear: unset;"> 5271 <b style="line-height: 2;"><code>Accept</code></b> 5272 5273 5274 5275 <input type="text" style="display: none" 5276 name="Accept" data-endpoint="GETapi-v1-tags" 5277 value="application/json" 5278 data-component="header"> 5279 <br> 5280<p>Example: <code>application/json</code></p> 5281 </div> 5282 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 5283 <div style=" padding-left: 28px; clear: unset;"> 5284 <b style="line-height: 2;"><code>organization_id</code></b> 5285<small>integer</small> 5286 5287 5288 <input type="number" style="display: none" 5289 step="any" name="organization_id" data-endpoint="GETapi-v1-tags" 5290 value="16" 5291 data-component="body"> 5292 <br> 5293<p>Must match an existing stored value. Example: <code>16</code></p> 5294 </div> 5295 </form> 5296 5297 <h2 id="tags-POSTapi-v1-tags">POST api/v1/tags</h2> 5298 5299<p> 5300</p> 5301 5302 5303 5304<span id="example-requests-POSTapi-v1-tags"> 5305<blockquote>Example request:</blockquote> 5306 5307 5308<div class="bash-example"> 5309 <pre><code class="language-bash">curl --request POST \ 5310 "prolinks.pro/api/v1/tags" \ 5311 --header "Content-Type: application/json" \ 5312 --header "Accept: application/json" \ 5313 --data "{ 5314 \"organization_id\": 16, 5315 \"name\": \"n\", 5316 \"color\": \"zinc\" 5317}" 5318</code></pre></div> 5319 5320 5321<div class="javascript-example"> 5322 <pre><code class="language-javascript">const url = new URL( 5323 "prolinks.pro/api/v1/tags" 5324); 5325 5326const headers = { 5327 "Content-Type": "application/json", 5328 "Accept": "application/json", 5329}; 5330 5331let body = { 5332 "organization_id": 16, 5333 "name": "n", 5334 "color": "zinc" 5335}; 5336 5337fetch(url, { 5338 method: "POST", 5339 headers, 5340 body: JSON.stringify(body), 5341}).then(response => response.json());</code></pre></div> 5342 5343</span> 5344 5345<span id="example-responses-POSTapi-v1-tags"> 5346</span> 5347<span id="execution-results-POSTapi-v1-tags" hidden> 5348 <blockquote>Received response<span 5349 id="execution-response-status-POSTapi-v1-tags"></span>: 5350 </blockquote> 5351 <pre class="json"><code id="execution-response-content-POSTapi-v1-tags" 5352 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 5353</span> 5354<span id="execution-error-POSTapi-v1-tags" hidden> 5355 <blockquote>Request failed with error:</blockquote> 5356 <pre><code id="execution-error-message-POSTapi-v1-tags"> 5357 5358Tip: Check that you're properly connected to the network. 5359If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 5360You can check the Dev Tools console for debugging information.</code></pre> 5361</span> 5362<form id="form-POSTapi-v1-tags" data-method="POST" 5363 data-path="api/v1/tags" 5364 data-authed="0" 5365 data-hasfiles="0" 5366 data-isarraybody="0" 5367 autocomplete="off" 5368 onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-tags', this);"> 5369 <h3> 5370 Request 5371 <button type="button" 5372 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5373 id="btn-tryout-POSTapi-v1-tags" 5374 onclick="tryItOut('POSTapi-v1-tags');">Try it out â¡ 5375 </button> 5376 <button type="button" 5377 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5378 id="btn-canceltryout-POSTapi-v1-tags" 5379 onclick="cancelTryOut('POSTapi-v1-tags');" hidden>Cancel ð 5380 </button> 5381 <button type="submit" 5382 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5383 id="btn-executetryout-POSTapi-v1-tags" 5384 data-initial-text="Send Request ð¥" 5385 data-loading-text="â± Sending..." 5386 hidden>Send Request ð¥ 5387 </button> 5388 </h3> 5389 <p> 5390 <small class="badge badge-black">POST</small> 5391 <b><code>api/v1/tags</code></b> 5392 </p> 5393 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 5394 <div style="padding-left: 28px; clear: unset;"> 5395 <b style="line-height: 2;"><code>Content-Type</code></b> 5396 5397 5398 5399 <input type="text" style="display: none" 5400 name="Content-Type" data-endpoint="POSTapi-v1-tags" 5401 value="application/json" 5402 data-component="header"> 5403 <br> 5404<p>Example: <code>application/json</code></p> 5405 </div> 5406 <div style="padding-left: 28px; clear: unset;"> 5407 <b style="line-height: 2;"><code>Accept</code></b> 5408 5409 5410 5411 <input type="text" style="display: none" 5412 name="Accept" data-endpoint="POSTapi-v1-tags" 5413 value="application/json" 5414 data-component="header"> 5415 <br> 5416<p>Example: <code>application/json</code></p> 5417 </div> 5418 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 5419 <div style=" padding-left: 28px; clear: unset;"> 5420 <b style="line-height: 2;"><code>organization_id</code></b> 5421<small>integer</small> 5422 5423 5424 <input type="number" style="display: none" 5425 step="any" name="organization_id" data-endpoint="POSTapi-v1-tags" 5426 value="16" 5427 data-component="body"> 5428 <br> 5429<p>Must match an existing stored value. Example: <code>16</code></p> 5430 </div> 5431 <div style=" padding-left: 28px; clear: unset;"> 5432 <b style="line-height: 2;"><code>name</code></b> 5433<small>string</small> 5434 5435 5436 <input type="text" style="display: none" 5437 name="name" data-endpoint="POSTapi-v1-tags" 5438 value="n" 5439 data-component="body"> 5440 <br> 5441<p>Must not be greater than 255 characters. Example: <code>n</code></p> 5442 </div> 5443 <div style=" padding-left: 28px; clear: unset;"> 5444 <b style="line-height: 2;"><code>color</code></b> 5445<small>string</small> 5446<i>optional</i> 5447 5448 <input type="text" style="display: none" 5449 name="color" data-endpoint="POSTapi-v1-tags" 5450 value="zinc" 5451 data-component="body"> 5452 <br> 5453<p>Example: <code>zinc</code></p> 5454Must be one of: 5455<ul style="list-style-type: square;"><li><code>red</code></li> <li><code>orange</code></li> <li><code>yellow</code></li> <li><code>green</code></li> <li><code>cyan</code></li> <li><code>teal</code></li> <li><code>blue</code></li> <li><code>indigo</code></li> <li><code>purple</code></li> <li><code>fuchsia</code></li> <li><code>pink</code></li> <li><code>zinc</code></li></ul> 5456 </div> 5457 </form> 5458 5459 <h2 id="tags-GETapi-v1-tags--id-">GET api/v1/tags/{id}</h2> 5460 5461<p> 5462</p> 5463 5464 5465 5466<span id="example-requests-GETapi-v1-tags--id-"> 5467<blockquote>Example request:</blockquote> 5468 5469 5470<div class="bash-example"> 5471 <pre><code class="language-bash">curl --request GET \ 5472 --get "prolinks.pro/api/v1/tags/16" \ 5473 --header "Content-Type: application/json" \ 5474 --header "Accept: application/json" \ 5475 --data "{ 5476 \"organization_id\": 16 5477}" 5478</code></pre></div> 5479 5480 5481<div class="javascript-example"> 5482 <pre><code class="language-javascript">const url = new URL( 5483 "prolinks.pro/api/v1/tags/16" 5484); 5485 5486const headers = { 5487 "Content-Type": "application/json", 5488 "Accept": "application/json", 5489}; 5490 5491let body = { 5492 "organization_id": 16 5493}; 5494 5495fetch(url, { 5496 method: "GET", 5497 headers, 5498 body: JSON.stringify(body), 5499}).then(response => response.json());</code></pre></div> 5500 5501</span> 5502 5503<span id="example-responses-GETapi-v1-tags--id-"> 5504 <blockquote> 5505 <p>
5505Example response (401):</p> 5506 </blockquote> 5507 <details class="annotation"> 5508 <summary style="cursor: pointer;"> 5509 <small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small> 5510 </summary> 5511 <pre><code class="language-http">cache-control: no-cache, private 5512content-type: application/json 5513access-control-allow-origin: * 5514 </code></pre></details> <pre> 5515 5516<code class="language-json" style="max-height: 300px;">{ 5517 "message": "Unauthenticated." 5518}</code> 5519 </pre> 5520 </span> 5521<span id="execution-results-GETapi-v1-tags--id-" hidden> 5522 <blockquote>Received response<span 5523 id="execution-response-status-GETapi-v1-tags--id-"></span>: 5524 </blockquote> 5525 <pre class="json"><code id="execution-response-content-GETapi-v1-tags--id-" 5526 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 5527</span> 5528<span id="execution-error-GETapi-v1-tags--id-" hidden> 5529 <blockquote>Request failed with error:</blockquote> 5530 <pre><code id="execution-error-message-GETapi-v1-tags--id-"> 5531 5532Tip: Check that you're properly connected to the network. 5533If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 5534You can check the Dev Tools console for debugging information.</code></pre> 5535</span> 5536<form id="form-GETapi-v1-tags--id-" data-method="GET" 5537 data-path="api/v1/tags/{id}" 5538 data-authed="0" 5539 data-hasfiles="0" 5540 data-isarraybody="0" 5541 autocomplete="off" 5542 onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-tags--id-', this);"> 5543 <h3> 5544 Request 5545 <button type="button" 5546 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5547 id="btn-tryout-GETapi-v1-tags--id-" 5548 onclick="tryItOut('GETapi-v1-tags--id-');">Try it out â¡ 5549 </button> 5550 <button type="button" 5551 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5552 id="btn-canceltryout-GETapi-v1-tags--id-" 5553 onclick="cancelTryOut('GETapi-v1-tags--id-');" hidden>Cancel ð 5554 </button> 5555 <button type="submit" 5556 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5557 id="btn-executetryout-GETapi-v1-tags--id-" 5558 data-initial-text="Send Request ð¥" 5559 data-loading-text="â± Sending..." 5560 hidden>Send Request ð¥ 5561 </button> 5562 </h3> 5563 <p> 5564 <small class="badge badge-green">GET</small> 5565 <b><code>api/v1/tags/{id}</code></b> 5566 </p> 5567 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 5568 <div style="padding-left: 28px; clear: unset;"> 5569 <b style="line-height: 2;"><code>Content-Type</code></b> 5570 5571 5572 5573 <input type="text" style="display: none" 5574 name="Content-Type" data-endpoint="GETapi-v1-tags--id-" 5575 value="application/json" 5576 data-component="header"> 5577 <br> 5578<p>Example: <code>application/json</code></p> 5579 </div> 5580 <div style="padding-left: 28px; clear: unset;"> 5581 <b style="line-height: 2;"><code>Accept</code></b> 5582 5583 5584 5585 <input type="text" style="display: none" 5586 name="Accept" data-endpoint="GETapi-v1-tags--id-" 5587 value="application/json" 5588 data-component="header"> 5589 <br> 5590<p>Example: <code>application/json</code></p> 5591 </div> 5592 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 5593 <div style="padding-left: 28px; clear: unset;"> 5594 <b style="line-height: 2;"><code>id</code></b> 5595<small>integer</small> 5596 5597 5598 <input type="number" style="display: none" 5599 step="any" name="id" data-endpoint="GETapi-v1-tags--id-" 5600 value="16" 5601 data-component="url"> 5602 <br> 5603<p>The ID of the tag. Example: <code>16</code></p> 5604 </div> 5605 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 5606 <div style=" padding-left: 28px; clear: unset;"> 5607 <b style="line-height: 2;"><code>organization_id</code></b> 5608<small>integer</small> 5609 5610 5611 <input type="number" style="display: none" 5612 step="any" name="organization_id" data-endpoint="GETapi-v1-tags--id-" 5613 value="16" 5614 data-component="body"> 5615 <br> 5616<p>Must match an existing stored value. Example: <code>16</code></p> 5617 </div> 5618 </form> 5619 5620 <h2 id="tags-PATCHapi-v1-tags--id-">PATCH api/v1/tags/{id}</h2> 5621 5622<p> 5623</p> 5624 5625 5626 5627<span id="example-requests-PATCHapi-v1-tags--id-"> 5628<blockquote>Example request:</blockquote> 5629 5630 5631<div class="bash-example"> 5632 <pre><code class="language-bash">curl --request PATCH \ 5633 "prolinks.pro/api/v1/tags/16" \ 5634 --header "Content-Type: application/json" \ 5635 --header "Accept: application/json" \ 5636 --data "{ 5637 \"organization_id\": 16, 5638 \"name\": \"n\", 5639 \"color\": \"pink\" 5640}" 5641</code></pre></div> 5642 5643 5644<div class="javascript-example"> 5645 <pre><code class="language-javascript">const url = new URL( 5646 "prolinks.pro/api/v1/tags/16" 5647); 5648 5649const headers = { 5650 "Content-Type": "application/json", 5651 "Accept": "application/json", 5652}; 5653 5654let body = { 5655 "organization_id": 16, 5656 "name": "n", 5657 "color": "pink" 5658}; 5659 5660fetch(url, { 5661 method: "PATCH", 5662 headers, 5663 body: JSON.stringify(body), 5664}).then(response => response.json());</code></pre></div> 5665 5666</span> 5667 5668<span id="example-responses-PATCHapi-v1-tags--id-"> 5669</span> 5670<span id="execution-results-PATCHapi-v1-tags--id-" hidden> 5671 <blockquote>Received response<span 5672 id="execution-response-status-PATCHapi-v1-tags--id-"></span>: 5673 </blockquote> 5674 <pre class="json"><code id="execution-response-content-PATCHapi-v1-tags--id-" 5675 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 5676</span> 5677<span id="execution-error-PATCHapi-v1-tags--id-" hidden> 5678 <blockquote>Request failed with error:</blockquote> 5679 <pre><code id="execution-error-message-PATCHapi-v1-tags--id-"> 5680 5681Tip: Check that you're properly connected to the network. 5682If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 5683You can check the Dev Tools console for debugging information.</code></pre> 5684</span> 5685<form id="form-PATCHapi-v1-tags--id-" data-method="PATCH" 5686 data-path="api/v1/tags/{id}" 5687 data-authed="0" 5688 data-hasfiles="0" 5689 data-isarraybody="0" 5690 autocomplete="off" 5691 onsubmit="event.preventDefault(); executeTryOut('PATCHapi-v1-tags--id-', this);"> 5692 <h3> 5693 Request 5694 <button type="button" 5695 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5696 id="btn-tryout-PATCHapi-v1-tags--id-" 5697 onclick="tryItOut('PATCHapi-v1-tags--id-');">Try it out â¡ 5698 </button> 5699 <button type="button" 5700 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5701 id="btn-canceltryout-PATCHapi-v1-tags--id-" 5702 onclick="cancelTryOut('PATCHapi-v1-tags--id-');" hidden>Cancel ð 5703 </button> 5704 <button type="submit" 5705 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5706 id="btn-executetryout-PATCHapi-v1-tags--id-" 5707 data-initial-text="Send Request ð¥" 5708 data-loading-text="â± Sending..." 5709 hidden>Send Request ð¥ 5710 </button> 5711 </h3> 5712 <p> 5713 <small class="badge badge-purple">PATCH</small> 5714 <b><code>api/v1/tags/{id}</code></b> 5715 </p> 5716 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 5717 <div style="padding-left: 28px; clear: unset;"> 5718 <b style="line-height: 2;"><code>Content-Type</code></b> 5719 5720 5721 5722 <input type="text" style="display: none" 5723 name="Content-Type" data-endpoint="PATCHapi-v1-tags--id-" 5724 value="application/json" 5725 data-component="header"> 5726 <br> 5727<p>Example: <code>application/json</code></p> 5728 </div> 5729 <div style="padding-left: 28px; clear: unset;"> 5730 <b style="line-height: 2;"><code>Accept</code></b> 5731 5732 5733 5734 <input type="text" style="display: none" 5735 name="Accept" data-endpoint="PATCHapi-v1-tags--id-" 5736 value="application/json" 5737 data-component="header"> 5738 <br> 5739<p>Example: <code>application/json</code></p> 5740 </div> 5741 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 5742 <div style="padding-left: 28px; clear: unset;"> 5743 <b style="line-height: 2;"><code>id</code></b> 5744<small>integer</small> 5745 5746 5747 <input type="number" style="display: none" 5748 step="any" name="id" data-endpoint="PATCHapi-v1-tags--id-" 5749 value="16" 5750 data-component="url"> 5751 <br> 5752<p>The ID of the tag. Example: <code>16</code></p> 5753 </div> 5754 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 5755 <div style=" padding-left: 28px; clear: unset;"> 5756 <b style="line-height: 2;"><code>organization_id</code></b> 5757<small>integer</small> 5758 5759 5760 <input type="number" style="display: none" 5761 step="any" name="organization_id" data-endpoint="PATCHapi-v1-tags--id-" 5762 value="16" 5763 data-component="body"> 5764 <br> 5765<p>Must match an existing stored value. Example: <code>16</code></p> 5766 </div> 5767 <div style=" padding-left: 28px; clear: unset;"> 5768 <b style="line-height: 2;"><code>name</code></b> 5769<small>string</small> 5770 5771 5772 <input type="text" style="display: none" 5773 name="name" data-endpoint="PATCHapi-v1-tags--id-" 5774 value="n" 5775 data-component="body"> 5776 <br> 5777<p>Must not be greater than 255 characters. Example: <code>n</code></p> 5778 </div> 5779 <div style=" padding-left: 28px; clear: unset;"> 5780 <b style="line-height: 2;"><code>color</code></b> 5781<small>string</small> 5782<i>optional</i> 5783 5784 <input type="text" style="display: none" 5785 name="color" data-endpoint="PATCHapi-v1-tags--id-" 5786 value="pink" 5787 data-component="body"> 5788 <br> 5789<p>Example: <code>pink</code></p> 5790Must be one of: 5791<ul style="list-style-type: square;"><li><code>red</code></li> <li><code>orange</code></li> <li><code>yellow</code></li> <li><code>green</code></li> <li><code>cyan</code></li> <li><code>teal</code></li> <li><code>blue</code></li> <li><code>indigo</code></li> <li><code>purple</code></li> <li><code>fuchsia</code></li> <li><code>pink</code></li> <li><code>zinc</code></li></ul> 5792 </div> 5793 </form> 5794 5795 <h2 id="tags-DELETEapi-v1-tags--id-">DELETE api/v1/tags/{id}</h2> 5796 5797<p> 5798</p> 5799 5800 5801 5802<span id="example-requests-DELETEapi-v1-tags--id-"> 5803<blockquote>Example request:</blockquote> 5804 5805 5806<div class="bash-example"> 5807 <pre><code class="language-bash">curl --request DELETE \ 5808 "prolinks.pro/api/v1/tags/16" \ 5809 --header "Content-Type: application/json" \ 5810 --header "Accept: application/json" \ 5811 --data "{ 5812 \"organization_id\": 16 5813}" 5814</code></pre></div> 5815 5816 5817<div class="javascript-example"> 5818 <pre><code class="language-javascript">const url = new URL( 5819 "prolinks.pro/api/v1/tags/16" 5820); 5821 5822const headers = { 5823 "Content-Type": "application/json", 5824 "Accept": "application/json", 5825}; 5826 5827let body = { 5828 "organization_id": 16 5829}; 5830 5831fetch(url, { 5832 method: "DELETE", 5833 headers, 5834 body: JSON.stringify(body), 5835}).then(response => response.json());</code></pre></div> 5836 5837</span> 5838 5839<span id="example-responses-DELETEapi-v1-tags--id-"> 5840</span> 5841<span id="execution-results-DELETEapi-v1-tags--id-" hidden> 5842 <blockquote>Received response<span 5843 id="execution-response-status-DELETEapi-v1-tags--id-"></span>: 5844 </blockquote> 5845 <pre class="json"><code id="execution-response-content-DELETEapi-v1-tags--id-" 5846 data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre> 5847</span> 5848<span id="execution-error-DELETEapi-v1-tags--id-" hidden> 5849 <blockquote>Request failed with error:</blockquote> 5850 <pre><code id="execution-error-message-DELETEapi-v1-tags--id-"> 5851 5852Tip: Check that you're properly connected to the network. 5853If you're a maintainer of ths API, verify that your API is running and you've enabled CORS. 5854You can check the Dev Tools console for debugging information.</code></pre> 5855</span> 5856<form id="form-DELETEapi-v1-tags--id-" data-method="DELETE" 5857 data-path="api/v1/tags/{id}" 5858 data-authed="0" 5859 data-hasfiles="0" 5860 data-isarraybody="0" 5861 autocomplete="off" 5862 onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-tags--id-', this);"> 5863 <h3> 5864 Request 5865 <button type="button" 5866 style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5867 id="btn-tryout-DELETEapi-v1-tags--id-" 5868 onclick="tryItOut('DELETEapi-v1-tags--id-');">Try it out â¡ 5869 </button> 5870 <button type="button" 5871 style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5872 id="btn-canceltryout-DELETEapi-v1-tags--id-" 5873 onclick="cancelTryOut('DELETEapi-v1-tags--id-');" hidden>Cancel ð 5874 </button> 5875 <button type="submit" 5876 style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;" 5877 id="btn-executetryout-DELETEapi-v1-tags--id-" 5878 data-initial-text="Send Request ð¥" 5879 data-loading-text="â± Sending..." 5880 hidden>Send Request ð¥ 5881 </button> 5882 </h3> 5883 <p> 5884 <small class="badge badge-red">DELETE</small> 5885 <b><code>api/v1/tags/{id}</code></b> 5886 </p> 5887 <h4 class="fancy-heading-panel"><b>Headers</b></h4> 5888 <div style="padding-left: 28px; clear: unset;"> 5889 <b style="line-height: 2;"><code>Content-Type</code></b> 5890 5891 5892 5893 <input type="text" style="display: none" 5894 name="Content-Type" data-endpoint="DELETEapi-v1-tags--id-" 5895 value="application/json" 5896 data-component="header"> 5897 <br> 5898<p>Example: <code>application/json</code></p> 5899 </div> 5900 <div style="padding-left: 28px; clear: unset;"> 5901 <b style="line-height: 2;"><code>Accept</code></b> 5902 5903 5904 5905 <input type="text" style="display: none" 5906 name="Accept" data-endpoint="DELETEapi-v1-tags--id-" 5907 value="a
5907pplication/json" 5908 data-component="header"> 5909 <br> 5910<p>Example: <code>application/json</code></p> 5911 </div> 5912 <h4 class="fancy-heading-panel"><b>URL Parameters</b></h4> 5913 <div style="padding-left: 28px; clear: unset;"> 5914 <b style="line-height: 2;"><code>id</code></b> 5915<small>integer</small> 5916 5917 5918 <input type="number" style="display: none" 5919 step="any" name="id" data-endpoint="DELETEapi-v1-tags--id-" 5920 value="16" 5921 data-component="url"> 5922 <br> 5923<p>The ID of the tag. Example: <code>16</code></p> 5924 </div> 5925 <h4 class="fancy-heading-panel"><b>Body Parameters</b></h4> 5926 <div style=" padding-left: 28px; clear: unset;"> 5927 <b style="line-height: 2;"><code>organization_id</code></b> 5928<small>integer</small> 5929 5930 5931 <input type="number" style="display: none" 5932 step="any" name="organization_id" data-endpoint="DELETEapi-v1-tags--id-" 5933 value="16" 5934 data-component="body"> 5935 <br> 5936<p>Must match an existing stored value. Example: <code>16</code></p> 5937 </div> 5938 </form> 5939 5940 5941 5942 5943 </div> 5944 <div class="dark-box"> 5945 <div class="lang-selector"> 5946 <button type="button" class="lang-button" data-language-name="bash">bash</button> 5947 <button type="button" class="lang-button" data-language-name="javascript">javascript</button> 5948 </div> 5949 </div> 5950</div>
5951<script type="module" src="https://static.cloudflareinsights.com/beacon.min.js/v31edd6df95cf4e85bb4c19e7a9bdbcba1788362987495" integrity="sha512-iIg7k2xntmwu6/uSb5tpc/hySgZc4eoL31yB29W6tJFo2akwjPWcEqnCEdJvGexCL0KEQwVYv5BlowfhVz26hg==" data-cf-beacon='{"version":"2024.11.0","token":"a16c8972260340aca117272fff155f72","r":1,"spa":2}' crossorigin="anonymous"></script>
5951 5952</body> 5953</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.