-
Notifications
You must be signed in to change notification settings - Fork 17
/
api-endpoints.json
1812 lines (1812 loc) · 73.1 KB
/
api-endpoints.json
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
{
"api": {
"test": {
"url": "https://slack.com/api/api.test",
"description": "Checks API calling code. Any arguments passed into this method are returned.",
"help": "https://api.slack.com/methods/api.test",
"arguments": {
"error": {
"required": false,
"description": "Error response to return"
}
},
"errors": {}
}
},
"auth": {
"test": {
"url": "https://slack.com/api/auth.test",
"description": "This method checks authentication and tells you who you are.",
"help": "https://api.slack.com/methods/auth.test",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: identify)"
}
},
"errors": {
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
}
},
"channels": {
"archive": {
"url": "https://slack.com/api/channels.archive",
"description": "This method archives a channel.",
"help": "https://api.slack.com/methods/channels.archive",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Channel to archive"
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"already_archived'": "Channel has already been archived.",
"cant_archive_general'": "You cannot archive the general channel.",
"last_ra_channel'": "You cannot archive the last channel for a restricted account",
"restricted_action'": "A team preference prevents the authenticated user from archiving.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_restricted'": "This method cannot be called by a restricted user or single channel guest."
}
},
"create": {
"url": "https://slack.com/api/channels.create",
"description": "This method is used to create a channel.",
"help": "https://api.slack.com/methods/channels.create",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"
},
"name": {
"required": true,
"description": "Name of channel to create"
}
},
"errors": {
"name_taken'": "A channel cannot be created with the given name.",
"restricted_action'": "A team preference prevents the authenticated user from creating channels.",
"no_channel'": "Value passed for name was empty.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_restricted'": "This method cannot be called by a restricted user or single channel guest."
}
},
"history": {
"url": "https://slack.com/api/channels.history",
"description": "This method returns a portion of messages/events from the specified channel. To read the entire history for a channel, call the method with no latest or oldest arguments, and then continue paging using the instructions below.",
"help": "https://api.slack.com/methods/channels.history",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"
},
"channel": {
"required": true,
"description": "Channel to fetch history for."
},
"latest": {
"required": false,
"description": "Latest message timestamp to include in results."
},
"oldest": {
"required": false,
"description": "Oldest message timestamp to include in results."
},
"count": {
"required": false,
"description": "Number of messages to return, between 1 and 1000."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"invalid_ts_latest'": "Value passed for latest was invalid",
"invalid_ts_oldest'": "Value passed for oldest was invalid",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
},
"info": {
"url": "https://slack.com/api/channels.info",
"description": "This method returns information about a team channel.",
"help": "https://api.slack.com/methods/channels.info",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"
},
"channel": {
"required": true,
"description": "Channel to get info on"
}
},
"error": {
"channel_not_found'": "Value passed for channel was invalid.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
},
"invite": {
"url": "https://slack.com/api/channels.invite",
"description": "This method is used to invite a user to a channel. The calling user must be a member of the channel.",
"help": "https://api.slack.com/methods/channels.invite",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Channel to invite user to."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"user_not_found'": "Value passed for user was invalid.",
"cant_invite_self'": "Authenticated user cannot invite themselves to a channel.",
"not_in_channel'": "Authenticated user is not in the channel.",
"already_in_channel'": "Invited user is already in the channel.",
"is_archived'": "Channel has been archived.",
"cant_invite'": "User cannot be invited to this channel.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_ultra_restricted'": "This method cannot be called by a single channel guest."
}
},
"join": {
"url": "https://slack.com/api/channels.join",
"description": "This method is used to join a channel. If the channel does not exist, it is created.",
"help": "https://api.slack.com/methods/channels.join",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"name": {
"required": true,
"description": "Name of channel to join"
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"name_taken'": "A channel cannot be created with the given name.",
"restricted_action'": "A team preference prevents the authenticated user from creating channels.",
"no_channel'": "Value passed for name was empty.",
"is_archived'": "Channel has been archived.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_restricted'": "This method cannot be called by a restricted user or single channel guest."
}
},
"kick": {
"url": "https://slack.com/api/channels.kick",
"description": "This method allows a user to remove another member from a team channel.",
"help": "https://api.slack.com/methods/channels.kick",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Channel to remove user from."
},
"user": {
"required": true,
"description": "User to remove from channel."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"user_not_found'": "Value passed for user was invalid.",
"cant_kick_self'": "Authenticated user can't kick themselves from a channel.",
"not_in_channel'": "User was not in the channel.",
"cant_kick_from_general'": "User cannot be removed from #general.",
"cant_kick_from_last_channel'": "User cannot be removed from the last channel they're in.",
"restricted_action'": "A team preference prevents the authenticated user from kicking.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_restricted'": "This method cannot be called by a restricted user or single channel guest."
}
},
"leave": {
"url": "https://slack.com/api/channels.leave",
"description": "This method is used to leave a channel.",
"help": "https://api.slack.com/methods/channels.leave",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Channel to leave"
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"is_archived'": "Channel has been archived.",
"cant_leave_general'": "Authenticated user cannot leave the general channel.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_restricted'": "This method cannot be called by a restricted user or single channel guest."
}
},
"list": {
"url": "https://slack.com/api/channels.list",
"description": "This method returns a list of all channels in the team. This includes channels the caller is in, channels they are not currently in, and archived channels. The number of (non-deactivated) members in each channel is also returned.",
"help": "https://api.slack.com/methods/channels.list",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"
},
"exclude_archived": {
"required": false,
"description": "Don't return archived channels."
}
},
"errors": {
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
},
"mark": {
"url": "https://slack.com/api/channels.mark",
"description": "This method moves the read cursor in a channel.",
"help": "https://api.slack.com/methods/channels.mark",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Channel to set reading cursor in."
},
"ts": {
"required": true,
"description": "Timestamp of the most recently seen message."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"not_in_channel'": "Caller is not a member of the channel.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
},
"rename": {
"url": "https://slack.com/api/channels.rename",
"description": "This method renames a team channel.\nThe only people who can rename a channel are team admins, or the person that originally created the channel. Others will recieve a `not_authorized` error.",
"help": "https://api.slack.com/methods/channels.rename",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Channel to rename"
},
"name": {
"required": true,
"description": "New name for channel."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"not_in_channel'": "Caller is not a member of the channel.",
"not_authorized'": "Caller cannot rename this channel",
"invalid_name'": "New name is invalid",
"name_taken'": "New channel name is taken",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_restricted'": "This method cannot be called by a restricted user or single channel guest."
}
},
"setPurpose": {
"url": "https://slack.com/api/channels.setPurpose",
"description": "This method is used to change the purpose of a channel. The calling user must be a member of the channel.",
"help": "https://api.slack.com/methods/channels.setPurpose",
"arguments": {
"token": {
"required": true,
"desciption": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Channel to set the purpose of"
},
"purpose": {
"required": true,
"description": "The new purpose"
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"not_in_channel'": "Authenticated user is not in the channel.",
"is_archived'": "Channel has been archived.",
"too_long'": "Purpose was longer than 250 characters.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_restricted'": "This method cannot be called by a restricted user or single channel guest."
}
},
"setTopic": {
"url": "https://slack.com/api/channels.setTopic",
"description": "This method is used to change the topic of a channel. The calling user must be a member of the channel.",
"help": "https://api.slack.com/methods/channels.setTopic",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Channel to set the topic of"
},
"topic": {
"required": true,
"description": "The new topic"
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"not_in_channel'": "Authenticated user is not in the channel.",
"is_archived'": "Channel has been archived.",
"too_long'": "Topic was longer than 250 characters.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_restricted'": "This method cannot be called by a restricted user or single channel guest."
}
},
"unarchive": {
"url": "https://slack.com/api/channels.unarchive",
"description": "This method unarchives a channel. The calling user is added to the channel.",
"help": "https://api.slack.com/methods/channels.unarchive",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Channel to unarchive"
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"not_archived'": "Channel is not archived.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_restricted'": "This method cannot be called by a restricted user or single channel guest."
}
}
},
"chat": {
"delete": {
"url": "https://slack.com/api/chat.delete",
"description": "This method deletes a message from a channel.",
"help": "https://api.slack.com/methods/chat.delete",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"ts": {
"required": true,
"description": "Timestamp of the message to be deleted."
},
"channel": {
"required": true,
"description": "Channel to unarchive"
}
},
"errors": {
"message_not_found'": "No message exists with the requested timestamp.",
"channel_not_found'": "Value passed for channel was invalid.",
"cant_delete_message'": "Authenticated user does not have permission to delete this message.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
},
"postMessage": {
"url": "https://slack.com/api/chat.postMessage",
"description": "Sends a message to a channel.",
"help": "https://api.slack.com/methods/chat.postMessage",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name."
},
"text": {
"required": true,
"description": "Text of the message to send. See below for an explanation of formatting."
},
"username": {
"required": false,
"description": "Name of bot."
},
"parse": {
"required": false,
"description": "Change how messages are treated."
},
"link_names": {
"required": false,
"description": "Find and link channel names and usernames."
},
"attachments": {
"required": false,
"description": "Structured message attachments."
},
"unfurl_links": {
"required": false,
"description": "Pass true to enable unfurling of primarily text-based content."
},
"unfurl_media": {
"required": false,
"description": "Pass false to disable unfurling of media content."
},
"icon_url": {
"required": false,
"description": "URL to an image to use as the icon for this message"
},
"icon_emoji": {
"required": false,
"description": "emoji to use as the icon for this message. Overrides icon_url."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"is_archived'": "Channel has been archived.",
"msg_too_long'": "Message text is too long",
"no_text'": "No message text provided",
"rate_limited'": "Application has posted too many messages, read the Rate Limit documentation for more information",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user."
}
},
"update": {
"url": "https://slack.com/api/chat.update",
"description": "This method updates a message in a channel.",
"help": "https://api.slack.com/methods/chat.update",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"ts": {
"required": true,
"description": "Timestamp of the message to be updated."
},
"channel": {
"required": true,
"description": "Channel containing the message to be updated."
},
"text": {
"required": true,
"description": "New text for the message, using the default formatting rules."
}
},
"errors": {
"message_not_found'": "No message exists with the requested timestamp.",
"cant_update_message'": "Authenticated user does not have permission to update this message.",
"channel_not_found'": "Value passed for channel was invalid.",
"edit_window_closed'": "The message cannot be edited due to the team message edit settings",
"msg_too_long'": "Message text is too long",
"no_text'": "No message text provided",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
}
},
"emoji": {
"list": {
"url": "https://slack.com/api/emoji.list",
"description": "This method lists the custom emoji for a team.",
"help": "https://api.slack.com/methods/emoji.list",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"
}
},
"errors": {
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
}
},
"files": {
"info": {
"url": "https://slack.com/api/files.info",
"description": "This method returns information about a file in your team.",
"help": "https://api.slack.com/methods/files.info",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"
},
"file": {
"required": true,
"description": "File to fetch info for"
},
"count": {
"required": false,
"description": "Number of items to return per page."
},
"page": {
"required": false,
"description": "Page number of results to return."
}
},
"errors": {
"file_not_found'": "Value passed for file was invalid",
"file_deleted'": "The requested file has been deleted",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user."
}
},
"delete": {
"url": "https://slack.com/api/files.delete",
"description": "This method deletes a file in your team.",
"help": "https://api.slack.com/methods/files.delete",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"file": {
"required": true,
"description": "ID of file to delete."
}
},
"errors": {
"file_not_found'": "The file does not exist, or is not visible to the calling user.",
"file_deleted": "The file has already been deleted.",
"cant_delete_file": "Authenticated user does not have permission to delete this file.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive": "Authentication token is for a deleted user or team.",
"user_is_bot": "This method cannot be called by a bot user."
}
},
"list": {
"url": "https://slack.com/api/files.list",
"description": "Lists & filters team files.",
"help": "https://api.slack.com/methods/files.list",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"
},
"user": {
"required": false,
"description": "Filter files created by a single user."
},
"ts_from": {
"required": false,
"description": "Filter files created after this timestamp (inclusive)."
},
"ts_to": {
"required": false,
"description": "Filter files created before this timestamp (inclusive)."
},
"types": {
"required": false,
"description": "Filter files by type:\n\nall - All files\nposts - Posts\nsnippets - Snippets\nimages - Image files\ngdocs - Google docs\nzips - Zip files\npdfs - PDF files\n\nYou can pass multiple values in the types argument, like types=posts,snippets.The default value is all, which does not filter the list."
},
"count": {
"required": false,
"description": "Number of items to return per page."
},
"page": {
"required": false,
"description": "Page number of results to return."
}
},
"errors": {
"user_not_found'": "Value passed for user was invalid",
"unknown_type'": "Value passed for types was invalid",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user."
}
},
"upload": {
"url": "https://slack.com/api/files.upload",
"description": "This method allows you to create or upload an existing file.",
"help": "https://api.slack.com/methods/files.upload",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"file": {
"required": false,
"description": "File contents via multipart/form-data."
},
"content": {
"required": false,
"description": "File contents via a POST var."
},
"filetype": {
"required": false,
"description": "Slack-internal file type identifier."
},
"title": {
"required": false,
"description": "Title of file."
},
"initial_comment": {
"required": false,
"description": "Initial comment to add to file."
},
"channels": {
"required": false,
"description": "Comma separated list of channels to share the file into."
}
},
"errors": {
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user."
}
}
},
"groups": {
"archive": {
"url": "https://slack.com/api/groups.archive",
"description": "This method archives a private group.",
"help": "https://api.slack.com/methods/groups.archive",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Private group to archive"
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"already_archived'": "Group has already been archived.",
"group_contains_others'": "Restricted accounts cannot archive groups containing others.",
"last_ra_channel'": "You cannot archive the last channel for a restricted account.",
"restricted_action'": "A team preference prevents the authenticated user from archiving.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_ultra_restricted'": "This method cannot be called by a single channel guest."
}
},
"close": {
"url": "https://slack.com/api/groups.close",
"description": "This method closes a private group.",
"help": "https://api.slack.com/methods/groups.close",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Private group to close"
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
},
"create": {
"url": "https://slack.com/api/groups.create",
"description": "This method creates a private group.",
"help": "https://api.slack.com/methods/groups.create",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"name": {
"required": true,
"description": "Name of group to create"
}
},
"errors": {
"no_channel'": "No group name was passed.",
"restricted_action'": "A team preference prevents the authenticated user from creating groups.",
"name_taken'": "A group cannot be created with the given name.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_ultra_restricted'": "This method cannot be called by a single channel guest."
}
},
"createChild": {
"url": "https://slack.com/api/groups.createChild",
"description": "This method takes an existing private group and performs the following steps:\n\nRenames the existing group (from `example` to `example-archived`).\nArchives the existing group.\nCreates a new group with the name of the existing group.\nAdds all members of the existing group to the new group.\nThis is useful when inviting a new member to an existing group while hiding all previous chat history from them. In this scenario you can call groups.createChild followed by groups.invite.\n\nThe new group will have a special parent_group property pointing to the original archived group. This will only be returned for members of both groups, so will not be visible to any newly invited members.",
"help": "https://api.slack.com/methods/groups.createChild",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Group to clone and archive."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"already_archived'": "An archived group cannot be cloned",
"restricted_action'": "A team preference prevents the authenticated user from creating groups.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_ultra_restricted'": "This method cannot be called by a single channel guest."
}
},
"history": {
"url": "https://slack.com/api/groups.history",
"description": "This method returns a portion of messages/events from the specified private group. To read the entire history for a group, call the method with no latest or oldest arguments, and then continue paging using the instructions below.",
"help": "https://api.slack.com/methods/groups.history",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"
},
"channel": {
"required": true,
"description": "Group to fetch history for."
},
"latest": {
"required": false,
"description": "Latest message timestamp to include in results."
},
"oldest": {
"required": false,
"description": "Oldest message timestamp to include in results."
},
"count": {
"required": false,
"description": "Number of messages to return, between 1 and 1000."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"invalid_ts_latest'": "Value passed for latest was invalid",
"invalid_ts_oldest'": "Value passed for oldest was invalid",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
},
"info": {
"url": "https://slack.com/api/groups.info",
"description": "This method returns information about a private channel.",
"help": "https://api.slack.com/methods/groups.info",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"
},
"channel": {
"required": true,
"description": "Private channel to get info on"
}
},
"error": {
"channel_not_found'": "Value passed for channel was invalid.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
},
"invite": {
"url": "https://slack.com/api/groups.invite",
"description": "This method is used to invite a user to a private group. The calling user must be a member of the group.\n\nTo invite a new member to a group without giving them access to the archives of the group call the groups.createChild method before inviting.",
"help": "https://api.slack.com/methods/groups.invite",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Private group to invite user to."
},
"user": {
"required": true,
"description": "User to invite."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"user_not_found'": "Value passed for user was invalid.",
"cant_invite_self'": "Authenticated user cannot invite themselves to a group.",
"is_archived'": "Group has been archived.",
"cant_invite'": "User cannot be invited to this group.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_ultra_restricted'": "This method cannot be called by a single channel guest."
}
},
"kick": {
"url": "https://slack.com/api/groups.kick",
"description": "This method allows a user to remove another member from a private group.",
"help": "https://api.slack.com/methods/groups.kick",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Group to remove user from."
},
"user": {
"required": true,
"description": "User to remove from group."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"user_not_found'": "Value passed for user was invalid.",
"cant_kick_self'": "You can't remove yourself from a group",
"not_in_group'": "User or caller were are not in the group",
"restricted_action'": "A team preference prevents the authenticated user from kicking.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_restricted'": "This method cannot be called by a restricted user or single channel guest."
}
},
"leave": {
"url": "https://slack.com/api/groups.leave",
"description": "This method is used to leave a private group.",
"help": "https://api.slack.com/methods/groups.leave",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Group to leave."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"is_archived'": "Group has been archived.",
"cant_leave_last_channel'": "Authenticated user cannot leave the last channel they are in",
"last_member'": "Authenticated user is the last member of a group and cannot leave it",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user.",
"user_is_ultra_restricted'": "This method cannot be called by a single channel guest."
}
},
"list": {
"url": "https://slack.com/api/groups.list",
"description": "This method returns a list of groups in the team that the caller is in and archived groups that the caller was in. The list of (non-deactivated) members in each group is also returned.",
"help": "https://api.slack.com/methods/groups.list",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"
},
"exclude_archived": {
"required": false,
"description": "Don't return archived groups."
}
},
"errors": {
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team.",
"user_is_bot'": "This method cannot be called by a bot user."
}
},
"mark": {
"url": "https://slack.com/api/groups.mark",
"description": "This method moves the read cursor in a private group.",
"help": "https://api.slack.com/methods/groups.mark",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: post)"
},
"channel": {
"required": true,
"description": "Group to set reading cursor in."
},
"ts": {
"required": true,
"description": "Timestamp of the most recently seen message."
}
},
"errors": {
"channel_not_found'": "Value passed for channel was invalid.",
"not_in_channel'": "Caller is not a member of the channel.",
"not_authed'": "No authentication token provided.",
"invalid_auth'": "Invalid authentication token.",
"account_inactive'": "Authentication token is for a deleted user or team."
}
},
"open": {
"url": "https://slack.com/api/groups.open",
"description": "This method opens a private group.",
"help": "https://api.slack.com/methods/groups.open",
"arguments": {
"token": {
"required": true,
"description": "Authentication token (Requires scope: read)"