-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.json
More file actions
5979 lines (5979 loc) · 206 KB
/
Copy pathopenapi.json
File metadata and controls
5979 lines (5979 loc) · 206 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
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.1.0",
"info": {
"title": "BulkPublish API",
"version": "1.0.0",
"description": "Publish to 15 social media platforms from a single API.\n\n## Using this API from an AI agent\n\nEverything below is also available as an [MCP](https://modelcontextprotocol.io) server, so Claude, ChatGPT, Cursor and other agents can drive BulkPublish directly.\n\n**Hosted (web-based hosts):** add `https://mcp.bulkpublish.com/mcp` as a custom connector. It supports OAuth 2.1 — you paste your API key once on the consent screen — or a key in the URL (`?key=bp_...`) for hosts without OAuth.\n\n**Local (Claude Code, Cursor, Codex, Windsurf):** `npx -y @bulkpublish/mcp-server`, with `BULKPUBLISH_API_KEY` in the environment.\n\nPer-client config and the full tool list: [BulkPublish AI Toolkit](https://github.com/azeemkafridi/bulkpublish-ai-toolkit). Get an API key at [/developer](https://app.bulkpublish.com/developer)."
},
"servers": [
{
"url": "https://app.bulkpublish.com",
"description": "Production"
}
],
"security": [
{
"apiKey": []
}
],
"components": {
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "API key from Settings > API Keys. Pass as `Bearer bp_your_key_here`"
},
"oauth2": {
"type": "oauth2",
"description": "**Beta.** For products that embed BulkPublish and do not want their users pasting an API key. The user approves your app on BulkPublish and you receive a scoped token bound to the workspace they chose. PKCE (S256) is required for every client, `scope` is required (there is no implicit default), authorization codes are single-use, and refresh tokens rotate. Pass the token as `Bearer bpat_...`.\n\nOAuth tokens reach posts, schedules, labels, media, analytics, quota usage and read-only channel data — and nothing else. Account administration (team, organizations, billing and credit purchases, API keys, OAuth app management) returns 403 for **any** OAuth token, including `full`, because those actions would outlive the user disconnecting the app. Use an API key (`Bearer bp_...`) for those; keys are unaffected by this and remain the default for server-to-server use.",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://app.bulkpublish.com/oauth/authorize",
"tokenUrl": "https://app.bulkpublish.com/api/oauth/token",
"refreshUrl": "https://app.bulkpublish.com/api/oauth/token",
"scopes": {
"posts:read": "View posts and their status",
"posts:write": "Create, update, schedule and publish posts",
"media:read": "View uploaded media",
"media:write": "Upload and delete media",
"analytics:read": "View analytics and post metrics",
"channels:read": "See which social accounts are connected",
"full": "Everything an app may do: read and write posts, schedules, labels and media, and read analytics and channels"
}
}
}
}
},
"schemas": {
"Post": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"content": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"publishing",
"published",
"processing",
"failed",
"partial"
]
},
"scheduledAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"timezone": {
"type": "string"
},
"postFormat": {
"type": "string",
"enum": [
"post",
"video",
"reel",
"story",
"carousel",
"thread"
]
},
"postTypeOverrides": {
"type": "object",
"description": "Per-platform post type override. E.g. { \"instagram\": \"reel\", \"facebook\": \"story\" }. A type the platform does not offer is rejected with 400 VALIDATION_ERROR (previously it silently fell back to the platform default). Instagram: feed_photo, feed_video, reel, story, carousel. Facebook: post, reel, story. TikTok: video, photo_slideshow. YouTube: video, short. LinkedIn: post, multi_image. Pinterest: pin, video_pin, carousel. GMB: standard, event, offer. Snapchat: story, saved_story, spotlight."
},
"platformSpecific": {
"type": "object",
"description": "Per-platform options. Keys are platform names. Facebook: { shareToStory }. Instagram: { collaborators, shareToStory, trialReel, graduationStrategy ('manual'|'auto' — any other value is rejected with 400 VALIDATION_ERROR), thumbnailTimestamp (seconds) }. TikTok: { privacyLevel ('PUBLIC_TO_EVERYONE'|'MUTUAL_FOLLOW_FRIENDS'|'FOLLOWER_OF_CREATOR'|'SELF_ONLY'|'SEND_TO_USER_INBOX' — any other value is rejected with 400 VALIDATION_ERROR), disableDuet, disableStitch, disableComment, isAigc, brandContentToggle, brandOrganicToggle, thumbnailTimestamp }. YouTube: { title, privacyStatus ('public'|'unlisted'|'private' — any other value is rejected with 400 VALIDATION_ERROR), categoryId, madeForKids, playlistId, thumbnailUrl }. Pinterest: { title, description, link, [channelId]: { boardId } }. GMB: { ctaType ('BOOK'|'ORDER'|'SHOP'|'LEARN_MORE'|'SIGN_UP'|'CALL' — any other value is rejected with 400 VALIDATION_ERROR), ctaUrl, eventTitle, startDate, startTime, endDate, endTime, couponCode, redeemOnlineUrl, termsConditions }. X: { replySettings ('everyone'|'following'|'verified'|'subscribers'|'mentionedUsers' — any other value is rejected with 400 VALIDATION_ERROR) }. Threads: { quotePostId }. Snapchat: { [channelId]: { title (Saved Story title, max 45 chars — defaults to the caption's first line), locale (Spotlight locale, default 'en_US'), saveToProfile (Spotlight only, default true) } }. Use _firstComment (string) for auto-posted reply after publish."
},
"platformContent": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Per-platform content overrides mapping platform name to a plain string, e.g. { \"x\": \"Short version\" }. Values must be strings — nested objects are rejected with 400 VALIDATION_ERROR."
},
"deleteMediaAfterPublish": {
"type": "boolean",
"default": false,
"description": "Whether uploaded media is deleted right after publishing. Defaults to false — media is kept and reclaimed by the 3-month retention sweep. Always false for recurring-schedule posts and bulk-created posts."
},
"autoPlugEnabled": {
"type": "boolean"
},
"autoPlugText": {
"type": [
"string",
"null"
]
},
"autoPlugThreshold": {
"type": "integer"
},
"autoPlugFired": {
"type": "boolean"
},
"autoRepostEnabled": {
"type": "boolean"
},
"autoRepostThreshold": {
"type": "integer"
},
"autoRepostFired": {
"type": "boolean"
},
"recurringScheduleId": {
"type": [
"integer",
"null"
]
},
"recurringSchedule": {
"type": [
"object",
"null"
],
"description": "Full recurring schedule details when linked"
},
"mediaFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaFile"
}
},
"postPlatforms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostPlatform"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Label"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"publishedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"approvalStatus": {
"type": "string",
"enum": [
"none",
"pending",
"approved",
"rejected"
],
"default": "none",
"description": "Team approval state, orthogonal to status. 'pending' and 'rejected' posts are skipped by the scheduler even when scheduled and overdue; approving via POST /api/posts/{id}/approve releases them (an overdue post publishes immediately on approval). Members whose role lacks post:publish (contributors) always get 'pending' when scheduling; others can opt in with requestApproval."
},
"approvedBy": {
"type": [
"string",
"null"
],
"description": "User ID of the approver (set when approvalStatus is 'approved')."
},
"approvedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"rejectionReason": {
"type": [
"string",
"null"
],
"description": "Reviewer's reason when approvalStatus is 'rejected'."
}
}
},
"PostPlatform": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"channelId": {
"type": "integer"
},
"platform": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"pending",
"publishing",
"published",
"failed",
"processing",
"unconfirmed"
],
"description": "Per-platform publish state. 'unconfirmed' is terminal: the publish request may have reached the platform but its response was lost, or the platform was still processing the upload when we stopped polling (video processing can outlast the check window) — check the account, then retry with republish: true if the post is not live."
},
"platformPostId": {
"type": [
"string",
"null"
]
},
"platformUrl": {
"type": [
"string",
"null"
]
},
"errorMessage": {
"type": [
"string",
"null"
]
},
"retryCount": {
"type": "integer"
}
}
},
"Channel": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"x",
"tiktok",
"youtube",
"threads",
"bluesky",
"pinterest",
"gmb",
"linkedin",
"mastodon",
"reddit",
"discord",
"telegram",
"tumblr",
"snapchat"
]
},
"accountName": {
"type": "string"
},
"accountId": {
"type": "string"
},
"accountType": {
"type": "string"
},
"profileImage": {
"type": [
"string",
"null"
]
},
"isActive": {
"type": "boolean"
},
"tokenStatus": {
"type": "string",
"enum": [
"valid",
"expiring_soon",
"expired"
]
},
"tokenExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"metadata": {
"type": "object"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"platformAvailable": {
"type": "boolean",
"description": "Whether this channel can publish right now. `false` means it is switched off server-side — the channel itself is healthy, but its scheduled posts are being held.\n\nResolved for THIS channel: the `PLATFORM_<NAME>` flag narrowed by any variant flag matching its `accountType`. LinkedIn company pages (`accountType: \"organization\"`) are gated separately from personal profiles, so two LinkedIn channels in the same response can differ here."
},
"platformState": {
"type": "string",
"enum": [
"on",
"connect_off",
"off"
],
"description": "Current availability of the platform, controlled by the `PLATFORM_<NAME>` environment flag on the server.\n\n- `on` — fully available.\n- `connect_off` — new channels cannot be connected, but channels already connected keep publishing normally (used while a platform app review is pending).\n- `off` — kill switch: the platform is unavailable, and posts targeting it are **held**, not failed. They publish automatically once the platform is switched back on.\n\nResolved for THIS channel: the `PLATFORM_<NAME>` flag narrowed by any variant flag matching its `accountType`. LinkedIn company pages (`accountType: \"organization\"`) are gated separately from personal profiles, so two LinkedIn channels in the same response can differ here."
},
"platformMessage": {
"type": [
"string",
"null"
],
"description": "User-facing explanation when the platform is not fully available; `null` otherwise. When a variant rather than the whole platform is what is switched off, this names the variant (e.g. \"LinkedIn Company Pages\")."
}
}
},
"MediaFile": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"fileName": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"sizeBytes": {
"type": "integer"
},
"width": {
"type": [
"integer",
"null"
]
},
"height": {
"type": [
"integer",
"null"
]
},
"duration": {
"type": [
"number",
"null"
]
},
"originalUrl": {
"type": "string"
},
"thumbnailUrl": {
"type": [
"string",
"null"
],
"description": "160x160 square crop (webp). For videos this is generated from an extracted poster frame; null until the derivative job has run."
},
"previewUrl": {
"type": [
"string",
"null"
],
"description": "400px-wide derivative (webp) for grids. For videos, generated from the poster frame."
},
"largeUrl": {
"type": [
"string",
"null"
],
"description": "1200px-wide derivative (webp) for lightboxes and large preview panes. For videos, generated from the poster frame. Null on media uploaded before this derivative existed until the backfill runs."
}
}
},
"Label": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"post",
"media"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"Schedule": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"frequency": {
"type": "string",
"enum": [
"daily",
"weekly",
"biweekly",
"monthly"
]
},
"dayOfWeek": {
"type": [
"integer",
"null"
]
},
"dayOfMonth": {
"type": [
"integer",
"null"
]
},
"timeOfDay": {
"type": "string"
},
"timezone": {
"type": "string"
},
"channelIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"contentTemplate": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"nextRunAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"requireApproval": {
"type": "boolean",
"default": false,
"description": "Optional. Hold every occurrence this schedule generates for team approval — each generated post lands with approvalStatus 'pending' and the scheduler skips it until an approver releases it via POST /api/posts/{id}/approve. Default false."
}
}
},
"Notification": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"isRead": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"Error": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"code": {
"type": "string"
}
}
}
}
},
"PlatformSpecific": {
"type": "object",
"description": "Per-platform options. Keys are platform names. Facebook: { shareToStory }. Instagram: { collaborators, shareToStory, trialReel, graduationStrategy ('manual'|'auto' — any other value is rejected with 400 VALIDATION_ERROR), thumbnailTimestamp (seconds) }. TikTok: { privacyLevel ('PUBLIC_TO_EVERYONE'|'MUTUAL_FOLLOW_FRIENDS'|'FOLLOWER_OF_CREATOR'|'SELF_ONLY'|'SEND_TO_USER_INBOX' — any other value is rejected with 400 VALIDATION_ERROR), disableDuet, disableStitch, disableComment, isAigc, brandContentToggle, brandOrganicToggle, thumbnailTimestamp }. YouTube: { title, privacyStatus ('public'|'unlisted'|'private' — any other value is rejected with 400 VALIDATION_ERROR), categoryId, madeForKids, playlistId, thumbnailUrl }. Pinterest: { title, description, link, [channelId]: { boardId } }. GMB: { ctaType ('BOOK'|'ORDER'|'SHOP'|'LEARN_MORE'|'SIGN_UP'|'CALL' — any other value is rejected with 400 VALIDATION_ERROR), ctaUrl, eventTitle, startDate, startTime, endDate, endTime, couponCode, redeemOnlineUrl, termsConditions }. X: { replySettings ('everyone'|'following'|'verified'|'subscribers'|'mentionedUsers' — any other value is rejected with 400 VALIDATION_ERROR) }. Threads: { quotePostId }. Reddit: { [channelId]: { subreddit (required), title, type, url, flairId, thumbnailUrl } }; subreddit falls back to the one stored on the channel, and title falls back to the first line of content truncated to 300 chars. thumbnailUrl is optional on video posts — when omitted the server falls back to the video's auto-extracted poster frame, and the publish fails only if neither exists. Unlike Pinterest's coverImageUrl there is no attached-image fallback, because a Reddit media post accepts exactly one file. Discord: { [channelId]: { channelId } } — the outer key is the BulkPublish channel id, the inner channelId is the target Discord text channel. Telegram: no options — the destination chat is fixed when the channel is connected. Tumblr: { [channelId]: { blogName, title, tags (array of strings, no leading '#'), link, sourceUrl } }; blogName defaults to the blog the channel was connected as. Snapchat: { [channelId]: { title (Saved Story title, max 45 chars — defaults to the caption's first line), locale (Spotlight locale, default 'en_US'), saveToProfile (Spotlight only — false sends skip_save_to_profile) } }; post types are story (default; caption not sent to Snapchat), saved_story and spotlight (video only, caption becomes the 160-char description); every Snapchat post requires exactly one image or video. Reddit, Discord, Tumblr and Snapchat also accept a flat (non channel-id-keyed) object that applies to every channel of that platform on the post. Use _firstComment (string), at the TOP level of platformSpecific rather than inside a platform key, for an auto-posted reply after publish. Supported on x, instagram, facebook, linkedin, youtube, threads, bluesky, mastodon, reddit and telegram; NOT supported on discord, pinterest, tiktok, gmb or tumblr, where the main post still publishes and the comment is recorded as failed. Snapchat does not support first comments either.",
"properties": {
"facebook": {
"type": "object",
"properties": {
"shareToStory": {
"type": "boolean",
"description": "Also share to Facebook Story"
}
}
},
"x": {
"type": "object",
"properties": {
"replySettings": {
"type": "string",
"enum": [
"everyone",
"following",
"verified",
"subscribers",
"mentionedUsers"
],
"description": "Who can reply to this tweet"
}
}
},
"tiktok": {
"type": "object",
"properties": {
"privacyLevel": {
"type": "string",
"enum": [
"PUBLIC_TO_EVERYONE",
"MUTUAL_FOLLOW_FRIENDS",
"FOLLOWER_OF_CREATOR",
"SELF_ONLY",
"SEND_TO_USER_INBOX"
]
},
"disableDuet": {
"type": "boolean"
},
"disableStitch": {
"type": "boolean"
},
"disableComment": {
"type": "boolean"
},
"isAigc": {
"type": "boolean",
"description": "AI-generated content disclosure"
},
"brandContentToggle": {
"type": "boolean",
"description": "Paid partnership"
},
"brandOrganicToggle": {
"type": "boolean",
"description": "Brand promotional content"
},
"thumbnailTimestamp": {
"type": "number",
"description": "Thumbnail timestamp in seconds"
}
}
},
"youtube": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"privacyStatus": {
"type": "string",
"enum": [
"public",
"unlisted",
"private"
]
},
"categoryId": {
"type": "string"
},
"madeForKids": {
"type": "boolean"
},
"playlistId": {
"type": "string"
},
"thumbnailUrl": {
"type": "string",
"description": "URL of custom thumbnail image"
}
}
},
"pinterest": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"link": {
"type": "string",
"description": "Destination URL"
},
"dominantColor": {
"type": "string",
"description": "Hex color e.g. #FF5733"
},
"coverImageUrl": {
"type": "string",
"description": "Cover image URL for video pins. Optional — when omitted, an image attached alongside the video is used, otherwise the auto-extracted poster frame of the video. Publishing fails only if none of the three is available."
}
}
},
"gmb": {
"type": "object",
"properties": {
"ctaType": {
"type": "string",
"enum": [
"LEARN_MORE",
"BOOK",
"ORDER",
"SHOP",
"SIGN_UP",
"CALL"
]
},
"ctaUrl": {
"type": "string"
},
"eventTitle": {
"type": "string"
},
"startDate": {
"type": "string",
"description": "YYYY-MM-DD"
},
"startTime": {
"type": "string",
"description": "HH:MM"
},
"endDate": {
"type": "string"
},
"endTime": {
"type": "string"
},
"couponCode": {
"type": "string"
},
"redeemOnlineUrl": {
"type": "string"
},
"termsConditions": {
"type": "string"
}
}
},
"instagram": {
"type": "object",
"properties": {
"collaborators": {
"type": "string",
"description": "Comma-separated usernames without @"
},
"shareToStory": {
"type": "boolean",
"description": "Also share to Instagram Story"
},
"trialReel": {
"type": "boolean",
"description": "Post as trial reel"
},
"graduationStrategy": {
"type": "string",
"enum": [
"manual",
"auto"
],
"description": "Trial reel graduation strategy"
},
"thumbnailTimestamp": {
"type": "number",
"description": "Thumbnail timestamp in seconds"
}
}
},
"threads": {
"type": "object",
"properties": {
"quotePostId": {
"type": "string",
"description": "Threads post ID to quote"
}
}
},
"reddit": {
"type": "object",
"description": "Keyed by BulkPublish channel id (e.g. \"12\"), or flat to apply to every Reddit channel on the post. The fields below are those of the inner object.",
"properties": {
"subreddit": {
"type": "string",
"description": "Required. Target subreddit. Accepts 'webdev', 'r/webdev' or '/r/webdev' — normalized to a bare lowercase name. Falls back to the subreddit stored on the channel."
},
"title": {
"type": "string",
"description": "Post title. Defaults to the first line of content, truncated to 300 characters."
},
"type": {
"type": "string",
"description": "Set to 'link' to force a link submission. The submission kind is otherwise resolved from the attached media: image file -> image, video file -> video, url set -> link, else self."
},
"url": {
"type": "string",
"description": "Destination URL for a link post. Supplying it implies type 'link'."
},
"flairId": {
"type": "string",
"description": "Link-flair id. List a subreddit's flairs via GET /api/channels/{id}/options."
},
"thumbnailUrl": {
"type": "string",
"description": "Poster image URL for video posts. Optional — when omitted the server falls back to the video's auto-extracted poster frame, and publishing fails only when neither is available. Unlike Pinterest's coverImageUrl there is no attached-image fallback: a Reddit media post accepts exactly one file, so a video post cannot also carry a cover image."
}
}
},
"discord": {
"type": "object",
"description": "Keyed by BulkPublish channel id (e.g. \"12\"), or flat to apply to every Discord channel on the post. The fields below are those of the inner object.",
"properties": {
"channelId": {
"type": "string",
"description": "Required. The target Discord text channel id (a snowflake) within the connected server. Note this is a Discord channel id, not the BulkPublish channel id used as the outer key. List postable channels via GET /api/channels/{id}/options."
}
}
},
"telegram": {
"type": "object",
"description": "Telegram accepts no platform-specific options — the destination chat is fixed when the channel is connected. Content is sent as plain text (no parse mode). Text longer than the 1024-character caption limit is posted as a second message alongside captionless media.",
"properties": {}
},
"tumblr": {
"type": "object",
"description": "Keyed by BulkPublish channel id (e.g. \"12\"), or flat to apply to every Tumblr channel on the post. The fields below are those of the inner object.",
"properties": {
"blogName": {
"type": "string",
"description": "Which blog to publish to. Defaults to the blog the channel was connected as (the account's primary blog). List the account's blogs via GET /api/channels/{id}/options."
},
"title": {
"type": "string",
"description": "Rendered as a heading block above the post body."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tumblr tags, without the leading '#'."
},
"link": {
"type": "string",
"description": "Appended to the post as a link block."
},
"sourceUrl": {
"type": "string",
"description": "Attribution URL stored as the post's source."
}
}
},
"snapchat": {
"type": "object",
"description": "Keyed by BulkPublish channel id (e.g. \"12\"), or flat to apply to every Snapchat channel on the post. Post types: story (default), saved_story, spotlight. Every Snapchat post requires exactly one image or video; spotlight is video-only (6–60s). The caption is used only for Spotlight (160-char description) and as the Saved Story title fallback — plain stories carry no text.",
"properties": {
"title": {
"type": "string",
"maxLength": 45,
"description": "Saved Story title (max 45 chars). Defaults to the first line of the caption, truncated."
},
"locale": {
"type": "string",
"description": "Spotlight locale, e.g. 'en_US'. Defaults to 'en_US' when omitted."
},
"saveToProfile": {
"type": "boolean",
"description": "Spotlight only. Default true; false sends skip_save_to_profile to Snap."
}
}
}
}
},
"PlatformAvailability": {
"type": "object",
"description": "Availability of one social platform. Disabled platforms are always included in responses with `enabled: false` — never omitted — so clients can tell \"switched off right now\" apart from \"not supported\".",
"properties": {
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"x",
"tiktok",
"youtube",
"threads",
"bluesky",
"pinterest",
"gmb",
"linkedin",
"mastodon",
"reddit",
"discord",
"telegram",
"tumblr",
"snapchat"
]
},
"displayName": {
"type": "string",
"example": "LinkedIn"
},
"color": {
"type": [
"string",
"null"
],
"description": "Brand colour hex, for UI rendering.",
"example": "#0A66C2"
},
"enabled": {
"type": "boolean",
"description": "Convenience flag; equivalent to `state == \"on\"`."
},
"state": {
"type": "string",
"enum": [
"on",
"connect_off",
"off"
],
"description": "Current availability of the platform, controlled by the `PLATFORM_<NAME>` environment flag on the server.\n\n- `on` — fully available.\n- `connect_off` — new channels cannot be connected, but channels already connected keep publishing normally (used while a platform app review is pending).\n- `off` — kill switch: the platform is unavailable, and posts targeting it are **held**, not failed. They publish automatically once the platform is switched back on."
},
"reason": {
"type": "string",
"enum": [
"enabled",
"flag_connect_off",
"flag_off",
"unconfigured"
],
"description": "Why the platform is in this state. `unconfigured` means the server has no OAuth app credentials for it yet."
},
"canConnect": {
"type": "boolean",
"description": "Whether a NEW channel can be connected right now."
},
"canPublish": {
"type": "boolean",
"description": "Whether already-connected channels can publish right now."
},
"message": {
"type": [
"string",
"null"
],
"description": "User-facing explanation. `null` when the platform is fully enabled."
},
"envVar": {
"type": "string",
"description": "The server env var controlling this platform. Only returned to organization owners and admins.",
"example": "PLATFORM_LINKEDIN"
},
"variants": {
"type": "object",
"description": "Sub-platforms gated independently of their parent, keyed by the channel `accountType` they cover. Present only for platforms that have one. Today: `linkedin.organization` — LinkedIn company pages, which run on a separate LinkedIn app (Community Management API) reviewed separately from personal profiles, so pages can be paused while personal-profile posting stays fully live. A variant is never more permissive than its parent: `state: \"off\"` on the platform means every variant is off too.",
"additionalProperties": {
"type": "object",
"properties": {
"label": {
"type": "string",
"example": "LinkedIn Company Pages"
},
"enabled": {
"type": "boolean",
"description": "Convenience flag; equivalent to `state == \"on\"`."
},
"state": {
"type": "string",
"enum": [
"on",
"connect_off",
"off"
],
"description": "Same semantics as the platform-level `state`, resolved for this variant."
},
"reason": {
"type": "string",
"enum": [
"enabled",
"flag_connect_off",
"flag_off",
"unconfigured"
]
},
"canConnect": {
"type": "boolean",
"description": "Whether a NEW channel of this account type can be connected right now."
},
"canPublish": {
"type": "boolean",
"description": "Whether already-connected channels of this account type can publish right now."
},
"message": {
"type": [
"string",
"null"
],
"description": "User-facing explanation. `null` when the variant is fully enabled."
},
"envVar": {
"type": "string",
"description": "The server env var controlling this variant. Only returned to organization owners and admins.",
"example": "PLATFORM_LINKEDIN_PAGES"
}
}
}
}
}
}
}
},
"tags": [
{
"name": "Posts",
"description": "Create, schedule, publish, and manage posts across platforms"
},
{
"name": "Channels",
"description": "Connect and manage social media accounts"
},
{
"name": "Channel Sets",
"description": "Saved channel groups for one-click targeting"
},
{
"name": "RSS Autopost",
"description": "Turn RSS/Atom feed items into posts automatically"
},
{
"name": "Media",
"description": "Upload and manage images and videos"
},
{
"name": "Analytics",
"description": "View engagement metrics and performance data"
},
{
"name": "Labels",
"description": "Organize posts and media with labels"
},
{