-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathds_api_account.html
More file actions
885 lines (381 loc) · 23.5 KB
/
ds_api_account.html
File metadata and controls
885 lines (381 loc) · 23.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
<!DOCTYPE html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="The Account API provides methods for managing settings for the account authorized in this API call.">
<meta name="keywords" content="configuration, account">
<title>Account APIs | Weebly Cloud for Designers Documentation</title>
<link rel="shortcut icon" href="images/favicon.ico">
<!-- Third-Party CSS -->
<link rel="stylesheet" href="css/syntax.css">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<!-- Custom CSS -->
<link rel="stylesheet" media="screen" href="css/orbit-external.css">
<link rel="stylesheet" media="screen" href="css/orbit.css">
<link rel="stylesheet" media="screen" href="css/theme-weebly.css">
<!-- Third-Party JS -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
<script src="js/jquery.navgoco.min.js"></script>
<script src="js/jekyll-search.js" type="text/javascript"></script>
<script src="js/toc.js"></script>
<!-- Custom JS -->
<script src="js/customscripts.js"></script>
</head>
<body>
<!-- Navigation -->
<div class="top-nav">
<div class="top-nav-item">
<a href="home.html">
<img src="images/weebly_cloud_designers_logo.png" alt="Weebly Cloud" class="cloud-logo" role="button" tabindex="0" alt="menu"/>
</a>
</div>
<div class="top-nav-item">
<img class="mobile-nav-btn" src="images/icons/mobile-menu.svg" alt="Mobile menu">
</div>
<nav class="top-nav-item">
<div class="nav-group">
<ul class="NavList nav-group-list horizontal">
<!-- entries without drop-downs appear here -->
<li class="NavLinkLi">
<a href="home.html" class="NavLink nav-group-list-link">Get Started</a>
</li>
<li class="NavLinkLi">
<a href="ds_apps_gs.html" class="NavLink nav-group-list-link">Apps</a>
</li>
<li class="NavLinkLi">
<a href="ds_themes_start.html" class="NavLink nav-group-list-link">Themes</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_about.html" class="NavLink nav-group-list-link">APIs</a>
</li>
<li class="NavLinkLi">
<a href="ds_tags_about.html" class="NavLink nav-group-list-link">Tags</a>
</li>
<li class="NavLinkLi">
<a href="ds_mg_about.html" class="NavLink nav-group-list-link">Migrated Designer?</a>
</li>
<!-- entries with drop-downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
<!--
<li class="NavLinkLi">
<a class="email NavLink nav-group-list-link" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:rwhitmore@weebly.com?subject=Weebly Cloud for Designers Docs feedback&body=I have some feedback about the Account APIs page: ' + window.location.href;">Feedback</a>
</li>
-->
<li class="NavLinkLi">
<a href="https://weeblycloud.com/admin" target="_blank" class="NavLink nav-group-list-link"><strong>Cloud Admin</strong></a>
</li>
<li>
<!--start search-->
<div id="search-demo-container">
<input type="text" id="search-input" placeholder="Search...">
<ul id="results-container"></ul>
</div>
<!--end search-->
</li>
</ul>
</div>
</nav>
</div>
<div class="page has-sidebar">
<div class="col-sidebar">
<ul id="mysidebar" class="nav NavList">
<li class="NavLinkLi">
<a href="#" class="NavLink isSecondary">Use the REST APIs</a>
<ul class="NavList Children">
<li class="NavLinkLi">
<a href="ds_api_about.html" class="NavLink isSecondary">How to Use the REST APIs</a>
</li>
<li class="active isActive NavLinkLi">
<a href="ds_api_account.html" class="NavLink isSecondary">Account API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_blog.html" class="NavLink isSecondary">Blog API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_blog_post.html" class="NavLink isSecondary">Blog Post API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_category.html" class="NavLink isSecondary">Category API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_category_image.html" class="NavLink isSecondary">Category Image API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_client.html" class="NavLink isSecondary">Client API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_client_site.html" class="NavLink isSecondary">Client Site API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_coupon.html" class="NavLink isSecondary">Coupon API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_form.html" class="NavLink isSecondary">Form API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_form_entry.html" class="NavLink isSecondary">Form Entry API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_group.html" class="NavLink isSecondary">Group API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_member.html" class="NavLink isSecondary">Member API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_order.html" class="NavLink isSecondary">Order API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_order_billing.html" class="NavLink isSecondary">Order Billing API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_order_billing_transaction.html" class="NavLink isSecondary">Order Billing Transaction API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_order_item.html" class="NavLink isSecondary">Order Item API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_order_shipment.html" class="NavLink isSecondary">Order Shipment API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_order_shipment_transaction.html" class="NavLink isSecondary">Order Shipment Transaction API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_page.html" class="NavLink isSecondary">Page API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_plan.html" class="NavLink isSecondary">Plan API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_product.html" class="NavLink isSecondary">Product API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_product_image.html" class="NavLink isSecondary">Product Image API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_product_option.html" class="NavLink isSecondary">Product Option API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_product_sku.html" class="NavLink isSecondary">Product SKU API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_product_sku_option_choice.html" class="NavLink isSecondary">Product SKU Option Choice API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_site.html" class="NavLink isSecondary">Site API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_store.html" class="NavLink isSecondary">Store API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_team_member.html" class="NavLink isSecondary">Team Member API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_themes_cloud.html" class="NavLink isSecondary">Themes (Custom Cloud) API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_themes_user.html" class="NavLink isSecondary">Themes (User) API</a>
</li>
<li class="NavLinkLi">
<a href="ds_api_user.html" class="NavLink isSecondary">User API</a>
</li>
</ul>
</li>
<li class="NavLinkLi">
<a href="#" class="NavLink isSecondary">Webhooks</a>
<ul class="NavList Children">
<li class="NavLinkLi">
<a href="ds_wh_webhooks.html" class="NavLink isSecondary">How to Use Webhooks</a>
</li>
<li class="NavLinkLi">
<a href="ds_wh_app.html" class="NavLink isSecondary">App Webhooks</a>
</li>
<li class="NavLinkLi">
<a href="ds_wh_blog.html" class="NavLink isSecondary">Blog Webhooks</a>
</li>
<li class="NavLinkLi">
<a href="ds_wh_form.html" class="NavLink isSecondary">Form Webhooks</a>
</li>
<li class="NavLinkLi">
<a href="ds_wh_member.html" class="NavLink isSecondary">Member Webhooks</a>
</li>
<li class="NavLinkLi">
<a href="ds_wh_site.html" class="NavLink isSecondary">Site Webhooks</a>
</li>
<li class="NavLinkLi">
<a href="ds_wh_store.html" class="NavLink isSecondary">Store Webhooks</a>
</li>
<li class="NavLinkLi">
<a href="ds_wh_user.html" class="NavLink isSecondary">User Webhooks</a>
</li>
</ul>
</li>
<li class="NavLinkLi">
<a href="#" class="NavLink isSecondary">API Terms of Use</a>
<ul class="NavList Children">
<li class="NavLinkLi">
<a href="ds_api_terms.html" class="NavLink isSecondary">API Terms of Use</a>
</li>
</ul>
</li>
</ul>
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>
$("li.active").parents('li').toggleClass("active");
</script>
</div>
<div class="col-content">
<div>
<div class="post-header">
<h1 class="post-title-main display-1">Account APIs</h1>
</div>
<div class="page-type"> reference </div>
</div>
<div class="post-content">
<div class="summary">The Account API provides methods for managing settings for the account authorized in this API call.</div>
<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
<script>
$( document ).ready(function() {
$('#toc').toc({
minimumHeaders: 2, // Don't show ToC if there is only one header
listType: 'ul',
showSpeed: 0,
headers: 'h2'
});
/* this offset helps account for the space taken up by the floating toolbar. */
$('#toc').on('click', 'a', function() {
var target = $(this.getAttribute('href'))
, scroll_target = target.offset().top
$(window).scrollTop(scroll_target - 50);
return false
})
});
</script>
<div id="toc" class="toc"></div>
<h2 id="fields">Fields</h2>
<p>The following table shows all fields that exist for this API, those that are returned when you retrieve a list, those that are required for <code class="highlighter-rouge">PUT</code>, and those that are changeable using <code class="highlighter-rouge">PATCH</code>. All fields are returned when you retrieve a single item.</p>
<table>
<tbody>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
<th>List</th>
<th>Required</th>
<th>Changeable</th>
</tr>
<tr>
<td><code>brand_name</code><br />
</td>
<td>Your <a href="ds_gs_configure.html#brand-your-sites-and-the-cloud-admin">brand</a> name. Displays in the footer of any free sites.
You may override this setting at the site level.</td>
<td>string</td>
<td>X</td>
<td>X</td>
<td>X</td>
</tr>
<tr>
<td><code>publish_upsell_url</code></td>
<td>Full url to your <a href="ds_gs_market.html">publish</a> promotion page. This url will be loaded
in an iframe (640px W by 200px H) upon site publish and can be used to
advertise other services. You may override this setting at the site
level (using this <a href="ds_api_site.html#patchupdate-a-site">Site API </a>call).
</td>
<td>string</td>
<td>X</td>
<td>X</td>
<td>X</td>
</tr>
</tbody>
</table>
<div class="Notice type_info" role="alert">
<b>Note:</b> Any fields returned that are not documented are currently unsupported and can be safely ignored.
</div>
<h2>
<div class="Tag type_info">GET</div>
Retrieve Account Details</h2>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell">GET /account</code></pre></figure>
<p>Returns details for the account authorized in this API call
<p class="codeTitle">Example CURL request returning details:</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell">curl https://api.weeblycloud.com/account <span class="se">\</span>
-H <span class="s2">"X-Public-Key: YOURAPIKEY"</span> <span class="se">\</span>
-H <span class="s2">"X-Signed-Request-Hash: YOURSECRETHASH"</span></code></pre></figure>
<p class="codeTitle">Example response:</p>
<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w">
</span><span class="nt">"account"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"brand_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"My Brand"</span><span class="p">,</span><span class="w">
</span><span class="nt">"publish_upsell_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http:\/\/www.mybrand.com\/upsell.html"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span></code></pre></figure>
<h2>
<div class="Tag type_warning">PUT</div>
Update the Given Fields for an Account</h2>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell">PUT /account</code></pre></figure>
<p>Updates the given account. All fields are required.
<p class="codeTitle">Example CURL request:</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell">curl https://api.weeblycloud.com/account <span class="se">\</span>
-X PUT <span class="se">\</span>
-d <span class="s1">'{
"brand_name": "My New Brand",
"publish_upsell_url": "http:\/\/www.mynewbrand.com\/upsell.html"
}'</span> <span class="se">\</span>
-H <span class="s2">"Content-type: application/json"</span> <span class="se">\</span>
-H <span class="s2">"X-Public-Key: YOURAPIKEY"</span> <span class="se">\</span>
-H <span class="s2">"X-Signed-Request-Hash: YOURSECRETHASH"</span></code></pre></figure>
<p class="codeTitle">Example response:</p>
<p>See Fields table. All fields for the account are returned.</p>
<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w">
</span><span class="nt">"account"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"brand_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"My Brand"</span><span class="p">,</span><span class="w">
</span><span class="nt">"publish_upsell_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http:\/\/www.mynewbrand.com\/upsell.html"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span></code></pre></figure>
<h2>
<div class="Tag type_warning">PATCH</div>
Update an Account</h2>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell">PATCH /account</code></pre></figure>
<p>Updates the given account. All fields are updateable.
<p class="codeTitle">Example CURL request:</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell">curl https://api.weeblycloud.com/account <span class="se">\</span>
-X PATCH <span class="se">\</span>
-d <span class="s1">'{
"brand_name": "My Brand",
"publish_upsell_url": "http:\/\/www.mynewbrand.com\/upsell.html"
}'</span> <span class="se">\</span>
-H <span class="s2">"Content-type: application/json"</span> <span class="se">\</span>
-H <span class="s2">"X-Public-Key: YOURAPIKEY"</span> <span class="se">\</span>
-H <span class="s2">"X-Signed-Request-Hash: YOURSECRETHASH"</span></code></pre></figure>
<p class="codeTitle">Example response:</p>
<p>See Fields table. All fields for the account are returned.</p>
<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w">
</span><span class="nt">"account"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"brand_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"My Brand"</span><span class="p">,</span><span class="w">
</span><span class="nt">"publish_upsell_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http:\/\/www.mynewbrand.com\/upsell.html"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span></code></pre></figure>
</p></p></p>
<div class="tags">
Tags:<br/>
<a href="tag_configuration.html" class="btn btn-default navbar-btn cursorNorm tags-link" role="button">configuration</a>
</div>
</div>
<hr class="shaded"/>
<footer class="footer">
<div class="row">
<div class="col-lg-12">
<div class="footer__fineprint">
©2018 Weebly. All rights reserved. <br />
Site last generated: Jan 31, 2018
</div>
<div class="footer__logo">
<img src="images/weebly_logo.svg" alt="Weebly logo"/>
</div>
</div>
</div>
</footer>
</div>
</div>
</body>
</html>