Created
June 5, 2020 09:30
-
-
Save wing328/61225b4ad2d838447340a70494e09333 to your computer and use it in GitHub Desktop.
slack_web.json with "additonalProperties: false" replaced with empty string
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "basePath": "/api", | |
| "definitions": { | |
| "blocks": { | |
| "description": "This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.", | |
| "items": { | |
| "additionalProperties": true, | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "type" | |
| ], | |
| "type": "object" | |
| }, | |
| "title": "Block Kit blocks", | |
| "type": "array" | |
| }, | |
| "defs_app_id": { | |
| "pattern": "^A[A-Z0-9]{1,}$", | |
| "title": "App ID", | |
| "type": "string" | |
| }, | |
| "defs_bot_id": { | |
| "pattern": "^B[A-Z0-9]{8,}$", | |
| "title": "Bot User ID", | |
| "type": "string" | |
| }, | |
| "defs_channel": { | |
| "pattern": "^[CGD][A-Z0-9]{8,}$", | |
| "title": "Channel-like conversation ID", | |
| "type": "string" | |
| }, | |
| "defs_channel_id": { | |
| "pattern": "^[C][A-Z0-9]{2,}$", | |
| "title": "Channel ID", | |
| "type": "string" | |
| }, | |
| "defs_channel_name": { | |
| "title": "Name of a channel", | |
| "type": "string" | |
| }, | |
| "defs_comment_id": { | |
| "pattern": "^Fc[A-Z0-9]{8,}$", | |
| "title": "File Comment ID", | |
| "type": "string" | |
| }, | |
| "defs_dm_id": { | |
| "pattern": "^[D][A-Z0-9]{8,}$", | |
| "title": "Direct Message Channel ID", | |
| "type": "string" | |
| }, | |
| "defs_enterprise_id": { | |
| "pattern": "^[E][A-Z0-9]{8,}$", | |
| "title": "Enterprise ID", | |
| "type": "string" | |
| }, | |
| "defs_enterprise_name": { | |
| "title": "Name of the enterprise org", | |
| "type": "string" | |
| }, | |
| "defs_enterprise_user_id": { | |
| "pattern": "^[W][A-Z0-9]{8,}$", | |
| "title": "Enterprise User ID", | |
| "type": "string" | |
| }, | |
| "defs_file_id": { | |
| "pattern": "^[F][A-Z0-9]{8,}$", | |
| "title": "File ID", | |
| "type": "string" | |
| }, | |
| "defs_group_id": { | |
| "pattern": "^[G][A-Z0-9]{8,}$", | |
| "title": "Private Channel ID", | |
| "type": "string" | |
| }, | |
| "defs_ok_false": { | |
| "enum": [ | |
| false | |
| ], | |
| "title": "default failure response", | |
| "type": "boolean" | |
| }, | |
| "defs_ok_true": { | |
| "enum": [ | |
| true | |
| ], | |
| "title": "default success response", | |
| "type": "boolean" | |
| }, | |
| "defs_pinned_info": { | |
| "title": "Info for a pinned item", | |
| "type": "object" | |
| }, | |
| "defs_reminder_id": { | |
| "pattern": "^Rm[A-Z0-9]{8,}$", | |
| "title": "Reminder ID", | |
| "type": "string" | |
| }, | |
| "defs_subteam_id": { | |
| "pattern": "^S[A-Z0-9]{2,}$", | |
| "title": "Subteam ID", | |
| "type": "string" | |
| }, | |
| "defs_team": { | |
| "pattern": "^[T][A-Z0-9]{2,}$", | |
| "title": "Team ID", | |
| "type": "string" | |
| }, | |
| "defs_topic_purpose_creator": { | |
| "pattern": "^[UW][A-Z0-9]{8,}$|^$", | |
| "title": "User ID or empty string, used for topic and purpose creation", | |
| "type": "string" | |
| }, | |
| "defs_ts": { | |
| "pattern": "^\\d{10}\\.\\d{6}$", | |
| "title": "Timestamp in format 0123456789.012345", | |
| "type": "string" | |
| }, | |
| "defs_user_id": { | |
| "pattern": "^[UW][A-Z0-9]{2,}$", | |
| "title": "User ID", | |
| "type": "string" | |
| }, | |
| "defs_workspace_id": { | |
| "pattern": "^[TE][A-Z0-9]{8,}$", | |
| "title": "Team or Enterprise ID", | |
| "type": "string" | |
| }, | |
| "objs_bot_profile": { | |
| "properties": { | |
| "app_id": { | |
| "$ref": "#/definitions/defs_app_id" | |
| }, | |
| "deleted": { | |
| "type": "boolean" | |
| }, | |
| "icons": { | |
| "properties": { | |
| "image_36": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_48": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_72": { | |
| "format": "uri", | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "image_36", | |
| "image_48", | |
| "image_72" | |
| ], | |
| "type": "object" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_bot_id" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "team_id": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "updated": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "deleted", | |
| "name", | |
| "updated", | |
| "app_id", | |
| "icons", | |
| "team_id" | |
| ], | |
| "title": "Bot Profile Object", | |
| "type": "object" | |
| }, | |
| "objs_channel": { | |
| "properties": { | |
| "accepted_user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "created": { | |
| "type": "integer" | |
| }, | |
| "creator": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_channel_id" | |
| }, | |
| "is_archived": { | |
| "type": "boolean" | |
| }, | |
| "is_channel": { | |
| "type": "boolean" | |
| }, | |
| "is_frozen": { | |
| "type": "boolean" | |
| }, | |
| "is_general": { | |
| "type": "boolean" | |
| }, | |
| "is_member": { | |
| "type": "boolean" | |
| }, | |
| "is_moved": { | |
| "type": "integer" | |
| }, | |
| "is_mpim": { | |
| "type": "boolean" | |
| }, | |
| "is_non_threadable": { | |
| "type": "boolean" | |
| }, | |
| "is_org_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_pending_ext_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_private": { | |
| "type": "boolean" | |
| }, | |
| "is_read_only": { | |
| "type": "boolean" | |
| }, | |
| "is_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_thread_only": { | |
| "type": "boolean" | |
| }, | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "members": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "name_normalized": { | |
| "type": "string" | |
| }, | |
| "num_members": { | |
| "type": "integer" | |
| }, | |
| "pending_shared": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "previous_names": { | |
| "items": { | |
| "$ref": "#/definitions/defs_channel_name" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "priority": { | |
| "type": "number" | |
| }, | |
| "purpose": { | |
| "properties": { | |
| "creator": { | |
| "$ref": "#/definitions/defs_topic_purpose_creator" | |
| }, | |
| "last_set": { | |
| "type": "integer" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "value", | |
| "creator", | |
| "last_set" | |
| ], | |
| "type": "object" | |
| }, | |
| "topic": { | |
| "properties": { | |
| "creator": { | |
| "$ref": "#/definitions/defs_topic_purpose_creator" | |
| }, | |
| "last_set": { | |
| "type": "integer" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "value", | |
| "creator", | |
| "last_set" | |
| ], | |
| "type": "object" | |
| }, | |
| "unlinked": { | |
| "title": "Field to determine whether a channel has ever been shared/disconnected in the past", | |
| "type": "integer" | |
| }, | |
| "unread_count": { | |
| "type": "integer" | |
| }, | |
| "unread_count_display": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "name", | |
| "created", | |
| "creator", | |
| "is_channel", | |
| "is_org_shared", | |
| "is_private", | |
| "is_mpim", | |
| "is_shared", | |
| "name_normalized", | |
| "members", | |
| "topic", | |
| "purpose" | |
| ], | |
| "title": "Channel Object", | |
| "type": "object" | |
| }, | |
| "objs_comment": { | |
| "properties": { | |
| "comment": { | |
| "type": "string" | |
| }, | |
| "created": { | |
| "type": "integer" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_comment_id" | |
| }, | |
| "is_intro": { | |
| "type": "boolean" | |
| }, | |
| "is_starred": { | |
| "type": "boolean" | |
| }, | |
| "num_stars": { | |
| "type": "integer" | |
| }, | |
| "pinned_info": { | |
| "$ref": "#/definitions/defs_pinned_info" | |
| }, | |
| "pinned_to": { | |
| "items": { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| "type": "array" | |
| }, | |
| "reactions": { | |
| "items": { | |
| "$ref": "#/definitions/objs_reaction" | |
| }, | |
| "type": "array" | |
| }, | |
| "timestamp": { | |
| "type": "integer" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "created", | |
| "timestamp", | |
| "user", | |
| "is_intro", | |
| "comment" | |
| ], | |
| "title": "File Comment Object", | |
| "type": "object" | |
| }, | |
| "objs_comments": { | |
| "items": {}, | |
| "title": "file comments object", | |
| "type": "array" | |
| }, | |
| "objs_conversation": { | |
| "items": [ | |
| { | |
| "properties": { | |
| "accepted_user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "connected_team_ids": { | |
| "items": { | |
| "$ref": "#/definitions/defs_workspace_id" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "conversation_host_id": { | |
| "$ref": "#/definitions/defs_workspace_id" | |
| }, | |
| "created": { | |
| "type": "integer" | |
| }, | |
| "creator": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "display_counts": { | |
| "properties": { | |
| "display_counts": { | |
| "type": "integer" | |
| }, | |
| "guest_counts": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "display_counts", | |
| "guest_counts" | |
| ], | |
| "type": "object" | |
| }, | |
| "enterprise_id": { | |
| "$ref": "#/definitions/defs_enterprise_id" | |
| }, | |
| "external_connections": { | |
| "type": "object" | |
| }, | |
| "has_pins": { | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| "internal_team_ids": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "is_archived": { | |
| "type": "boolean" | |
| }, | |
| "is_channel": { | |
| "type": "boolean" | |
| }, | |
| "is_ext_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_frozen": { | |
| "type": "boolean" | |
| }, | |
| "is_general": { | |
| "type": "boolean" | |
| }, | |
| "is_global_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_group": { | |
| "type": "boolean" | |
| }, | |
| "is_im": { | |
| "type": "boolean" | |
| }, | |
| "is_member": { | |
| "type": "boolean" | |
| }, | |
| "is_moved": { | |
| "type": "integer" | |
| }, | |
| "is_mpim": { | |
| "enum": [ | |
| false | |
| ], | |
| "type": "boolean" | |
| }, | |
| "is_non_threadable": { | |
| "type": "boolean" | |
| }, | |
| "is_open": { | |
| "type": "boolean" | |
| }, | |
| "is_org_default": { | |
| "type": "boolean" | |
| }, | |
| "is_org_mandatory": { | |
| "type": "boolean" | |
| }, | |
| "is_org_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_pending_ext_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_private": { | |
| "type": "boolean" | |
| }, | |
| "is_read_only": { | |
| "type": "boolean" | |
| }, | |
| "is_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_starred": { | |
| "type": "boolean" | |
| }, | |
| "is_thread_only": { | |
| "type": "boolean" | |
| }, | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "members": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "name_normalized": { | |
| "type": "string" | |
| }, | |
| "num_members": { | |
| "type": "integer" | |
| }, | |
| "parent_conversation": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "pending_connected_team_ids": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "pending_shared": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "pin_count": { | |
| "type": "integer" | |
| }, | |
| "previous_names": { | |
| "items": { | |
| "$ref": "#/definitions/defs_channel_name" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "priority": { | |
| "type": "number" | |
| }, | |
| "purpose": { | |
| "properties": { | |
| "creator": { | |
| "$ref": "#/definitions/defs_topic_purpose_creator" | |
| }, | |
| "last_set": { | |
| "type": "integer" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "value", | |
| "creator", | |
| "last_set" | |
| ], | |
| "type": "object" | |
| }, | |
| "shared_team_ids": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "shares": { | |
| "items": { | |
| "properties": { | |
| "accepted_user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "is_active": { | |
| "type": "boolean" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/objs_team" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| }, | |
| "required": [ | |
| "team", | |
| "user", | |
| "is_active" | |
| ], | |
| "type": "object" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "timezone_count": { | |
| "type": "integer" | |
| }, | |
| "topic": { | |
| "properties": { | |
| "creator": { | |
| "$ref": "#/definitions/defs_topic_purpose_creator" | |
| }, | |
| "last_set": { | |
| "type": "integer" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "value", | |
| "creator", | |
| "last_set" | |
| ], | |
| "type": "object" | |
| }, | |
| "unlinked": { | |
| "title": "Field to determine whether a channel has ever been shared/disconnected in the past", | |
| "type": "integer" | |
| }, | |
| "unread_count": { | |
| "type": "integer" | |
| }, | |
| "unread_count_display": { | |
| "type": "integer" | |
| }, | |
| "use_case": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "version": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "name", | |
| "created", | |
| "creator", | |
| "is_archived", | |
| "is_channel", | |
| "is_general", | |
| "is_mpim", | |
| "is_group", | |
| "is_org_shared", | |
| "is_im", | |
| "is_shared", | |
| "is_private", | |
| "name_normalized", | |
| "topic", | |
| "purpose" | |
| ], | |
| "title": "Conversation object", | |
| "type": "object" | |
| }, | |
| { | |
| "properties": { | |
| "accepted_user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "connected_team_ids": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "conversation_host_id": { | |
| "$ref": "#/definitions/defs_workspace_id" | |
| }, | |
| "created": { | |
| "type": "integer" | |
| }, | |
| "creator": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "display_counts": { | |
| "properties": { | |
| "display_counts": { | |
| "type": "integer" | |
| }, | |
| "guest_counts": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "display_counts", | |
| "guest_counts" | |
| ], | |
| "type": "object" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| "internal_team_ids": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "is_archived": { | |
| "type": "boolean" | |
| }, | |
| "is_channel": { | |
| "type": "boolean" | |
| }, | |
| "is_ext_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_frozen": { | |
| "type": "boolean" | |
| }, | |
| "is_general": { | |
| "type": "boolean" | |
| }, | |
| "is_group": { | |
| "type": "boolean" | |
| }, | |
| "is_im": { | |
| "type": "boolean" | |
| }, | |
| "is_member": { | |
| "type": "boolean" | |
| }, | |
| "is_moved": { | |
| "type": "integer" | |
| }, | |
| "is_mpim": { | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "is_non_threadable": { | |
| "type": "boolean" | |
| }, | |
| "is_open": { | |
| "type": "boolean" | |
| }, | |
| "is_org_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_pending_ext_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_private": { | |
| "type": "boolean" | |
| }, | |
| "is_read_only": { | |
| "type": "boolean" | |
| }, | |
| "is_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_starred": { | |
| "type": "boolean" | |
| }, | |
| "is_thread_only": { | |
| "type": "boolean" | |
| }, | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "members": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "name_normalized": { | |
| "type": "string" | |
| }, | |
| "num_members": { | |
| "type": "integer" | |
| }, | |
| "parent_conversation": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "pending_connected_team_ids": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "pending_shared": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "pin_count": { | |
| "type": "integer" | |
| }, | |
| "previous_names": { | |
| "items": { | |
| "$ref": "#/definitions/defs_channel_name" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "priority": { | |
| "type": "number" | |
| }, | |
| "purpose": { | |
| "properties": { | |
| "creator": { | |
| "$ref": "#/definitions/defs_topic_purpose_creator" | |
| }, | |
| "last_set": { | |
| "type": "integer" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "value", | |
| "creator", | |
| "last_set" | |
| ], | |
| "type": "object" | |
| }, | |
| "shared_team_ids": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "shares": { | |
| "items": { | |
| "properties": { | |
| "accepted_user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "is_active": { | |
| "type": "boolean" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/objs_team" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| }, | |
| "required": [ | |
| "team", | |
| "user", | |
| "is_active" | |
| ], | |
| "type": "object" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "timezone_count": { | |
| "type": "integer" | |
| }, | |
| "topic": { | |
| "properties": { | |
| "creator": { | |
| "$ref": "#/definitions/defs_topic_purpose_creator" | |
| }, | |
| "last_set": { | |
| "type": "integer" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "value", | |
| "creator", | |
| "last_set" | |
| ], | |
| "type": "object" | |
| }, | |
| "unlinked": { | |
| "title": "Field to determine whether a channel has ever been shared/disconnected in the past", | |
| "type": "integer" | |
| }, | |
| "unread_count": { | |
| "type": "integer" | |
| }, | |
| "unread_count_display": { | |
| "type": "integer" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "version": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "name", | |
| "created", | |
| "creator", | |
| "is_archived", | |
| "is_channel", | |
| "is_general", | |
| "is_mpim", | |
| "is_group", | |
| "is_org_shared", | |
| "is_im", | |
| "is_shared", | |
| "is_private", | |
| "name_normalized", | |
| "topic", | |
| "purpose" | |
| ], | |
| "title": "Conversation MPIM Object", | |
| "type": "object" | |
| }, | |
| { | |
| "properties": { | |
| "created": { | |
| "type": "integer" | |
| }, | |
| "has_pins": { | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_dm_id" | |
| }, | |
| "is_archived": { | |
| "type": "boolean" | |
| }, | |
| "is_ext_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_frozen": { | |
| "type": "boolean" | |
| }, | |
| "is_im": { | |
| "type": "boolean" | |
| }, | |
| "is_open": { | |
| "type": "boolean" | |
| }, | |
| "is_org_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_starred": { | |
| "type": "boolean" | |
| }, | |
| "is_user_deleted": { | |
| "type": "boolean" | |
| }, | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "parent_conversation": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "pin_count": { | |
| "type": "integer" | |
| }, | |
| "priority": { | |
| "type": "number" | |
| }, | |
| "shares": { | |
| "items": { | |
| "properties": { | |
| "date_create": { | |
| "type": "integer" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "is_active": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/objs_team" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "name", | |
| "team", | |
| "date_create", | |
| "is_active" | |
| ], | |
| "type": "object" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "unread_count": { | |
| "type": "integer" | |
| }, | |
| "unread_count_display": { | |
| "type": "integer" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "version": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "created", | |
| "is_im", | |
| "is_org_shared", | |
| "user", | |
| "priority" | |
| ], | |
| "title": "Conversation IM Channel Object from conversations.* methods", | |
| "type": "object" | |
| } | |
| ] | |
| }, | |
| "objs_enterprise_user": { | |
| "properties": { | |
| "enterprise_id": { | |
| "$ref": "#/definitions/defs_enterprise_id" | |
| }, | |
| "enterprise_name": { | |
| "$ref": "#/definitions/defs_enterprise_name" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_enterprise_user_id" | |
| }, | |
| "is_admin": { | |
| "type": "boolean" | |
| }, | |
| "is_owner": { | |
| "type": "boolean" | |
| }, | |
| "teams": { | |
| "items": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "enterprise_id", | |
| "enterprise_name", | |
| "is_admin", | |
| "is_owner", | |
| "teams" | |
| ], | |
| "type": "object" | |
| }, | |
| "objs_file": { | |
| "properties": { | |
| "channels": { | |
| "items": { | |
| "$ref": "#/definitions/defs_channel_id" | |
| }, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "comments_count": { | |
| "type": "integer" | |
| }, | |
| "created": { | |
| "type": "integer" | |
| }, | |
| "date_delete": { | |
| "type": "integer" | |
| }, | |
| "display_as_bot": { | |
| "type": "boolean" | |
| }, | |
| "editable": { | |
| "type": "boolean" | |
| }, | |
| "editor": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "external_id": { | |
| "type": "string" | |
| }, | |
| "external_type": { | |
| "type": "string" | |
| }, | |
| "external_url": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "filetype": { | |
| "type": "string" | |
| }, | |
| "groups": { | |
| "items": { | |
| "$ref": "#/definitions/defs_group_id" | |
| }, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "has_rich_preview": { | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_file_id" | |
| }, | |
| "image_exif_rotation": { | |
| "type": "integer" | |
| }, | |
| "ims": { | |
| "items": { | |
| "$ref": "#/definitions/defs_dm_id" | |
| }, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "is_external": { | |
| "type": "boolean" | |
| }, | |
| "is_public": { | |
| "type": "boolean" | |
| }, | |
| "is_starred": { | |
| "type": "boolean" | |
| }, | |
| "is_tombstoned": { | |
| "type": "boolean" | |
| }, | |
| "last_editor": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "mimetype": { | |
| "type": "string" | |
| }, | |
| "mode": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "non_owner_editable": { | |
| "type": "boolean" | |
| }, | |
| "num_stars": { | |
| "type": "integer" | |
| }, | |
| "original_h": { | |
| "type": "integer" | |
| }, | |
| "original_w": { | |
| "type": "integer" | |
| }, | |
| "permalink": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "permalink_public": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "pinned_info": { | |
| "$ref": "#/definitions/defs_pinned_info" | |
| }, | |
| "pinned_to": { | |
| "items": { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| "type": "array" | |
| }, | |
| "pretty_type": { | |
| "type": "string" | |
| }, | |
| "preview": { | |
| "type": "string" | |
| }, | |
| "public_url_shared": { | |
| "type": "boolean" | |
| }, | |
| "reactions": { | |
| "items": { | |
| "$ref": "#/definitions/objs_reaction" | |
| }, | |
| "type": "array" | |
| }, | |
| "shares": { | |
| "properties": { | |
| "private": { | |
| "additionalProperties": false | |
| }, | |
| "public": { | |
| "additionalProperties": false | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| }, | |
| "source_team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "thumb_1024": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "thumb_1024_h": { | |
| "type": "integer" | |
| }, | |
| "thumb_1024_w": { | |
| "type": "integer" | |
| }, | |
| "thumb_160": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "thumb_360": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "thumb_360_h": { | |
| "type": "integer" | |
| }, | |
| "thumb_360_w": { | |
| "type": "integer" | |
| }, | |
| "thumb_480": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "thumb_480_h": { | |
| "type": "integer" | |
| }, | |
| "thumb_480_w": { | |
| "type": "integer" | |
| }, | |
| "thumb_64": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "thumb_720": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "thumb_720_h": { | |
| "type": "integer" | |
| }, | |
| "thumb_720_w": { | |
| "type": "integer" | |
| }, | |
| "thumb_80": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "thumb_800": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "thumb_800_h": { | |
| "type": "integer" | |
| }, | |
| "thumb_800_w": { | |
| "type": "integer" | |
| }, | |
| "thumb_960": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "thumb_960_h": { | |
| "type": "integer" | |
| }, | |
| "thumb_960_w": { | |
| "type": "integer" | |
| }, | |
| "thumb_tiny": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "integer" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "updated": { | |
| "type": "integer" | |
| }, | |
| "url_private": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "url_private_download": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "user": { | |
| "type": "string" | |
| }, | |
| "user_team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "username": { | |
| "type": "string" | |
| } | |
| }, | |
| "title": "file object", | |
| "type": "object" | |
| }, | |
| "objs_group": { | |
| "properties": { | |
| "created": { | |
| "type": "integer" | |
| }, | |
| "creator": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_group_id" | |
| }, | |
| "is_archived": { | |
| "type": "boolean" | |
| }, | |
| "is_deleted": { | |
| "type": "boolean" | |
| }, | |
| "is_group": { | |
| "type": "boolean" | |
| }, | |
| "is_moved": { | |
| "type": "integer" | |
| }, | |
| "is_mpim": { | |
| "type": "boolean" | |
| }, | |
| "is_open": { | |
| "type": "boolean" | |
| }, | |
| "is_pending_ext_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_read_only": { | |
| "type": "boolean" | |
| }, | |
| "is_thread_only": { | |
| "type": "boolean" | |
| }, | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "members": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "name_normalized": { | |
| "type": "string" | |
| }, | |
| "num_members": { | |
| "type": "integer" | |
| }, | |
| "parent_group": { | |
| "$ref": "#/definitions/defs_group_id" | |
| }, | |
| "priority": { | |
| "type": "number" | |
| }, | |
| "purpose": { | |
| "properties": { | |
| "creator": { | |
| "$ref": "#/definitions/defs_topic_purpose_creator" | |
| }, | |
| "last_set": { | |
| "type": "integer" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "value", | |
| "creator", | |
| "last_set" | |
| ], | |
| "type": "object" | |
| }, | |
| "topic": { | |
| "properties": { | |
| "creator": { | |
| "$ref": "#/definitions/defs_topic_purpose_creator" | |
| }, | |
| "last_set": { | |
| "type": "integer" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "value", | |
| "creator", | |
| "last_set" | |
| ], | |
| "type": "object" | |
| }, | |
| "unread_count": { | |
| "type": "integer" | |
| }, | |
| "unread_count_display": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "name", | |
| "is_group", | |
| "created", | |
| "creator", | |
| "name_normalized", | |
| "topic", | |
| "purpose" | |
| ], | |
| "title": "Group object", | |
| "type": "object" | |
| }, | |
| "objs_icon": { | |
| "properties": { | |
| "image_102": { | |
| "type": "string" | |
| }, | |
| "image_132": { | |
| "type": "string" | |
| }, | |
| "image_230": { | |
| "type": "string" | |
| }, | |
| "image_34": { | |
| "type": "string" | |
| }, | |
| "image_44": { | |
| "type": "string" | |
| }, | |
| "image_68": { | |
| "type": "string" | |
| }, | |
| "image_88": { | |
| "type": "string" | |
| }, | |
| "image_default": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "objs_im": { | |
| "properties": { | |
| "created": { | |
| "type": "integer" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_dm_id" | |
| }, | |
| "is_app_home": { | |
| "type": "boolean" | |
| }, | |
| "is_archived": { | |
| "type": "boolean" | |
| }, | |
| "is_ext_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_frozen": { | |
| "type": "boolean" | |
| }, | |
| "is_im": { | |
| "type": "boolean" | |
| }, | |
| "is_org_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_shared": { | |
| "type": "boolean" | |
| }, | |
| "is_user_deleted": { | |
| "type": "boolean" | |
| }, | |
| "priority": { | |
| "type": "number" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "is_im", | |
| "is_org_shared", | |
| "user", | |
| "created", | |
| "is_user_deleted" | |
| ], | |
| "title": "IM Object", | |
| "type": "object" | |
| }, | |
| "objs_message": { | |
| "properties": { | |
| "attachments": { | |
| "items": { | |
| "properties": { | |
| "fallback": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "integer" | |
| }, | |
| "image_bytes": { | |
| "type": "integer" | |
| }, | |
| "image_height": { | |
| "type": "integer" | |
| }, | |
| "image_url": { | |
| "type": "string" | |
| }, | |
| "image_width": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "id" | |
| ], | |
| "type": "object" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "blocks": { | |
| "$ref": "#/definitions/blocks" | |
| }, | |
| "bot_id": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/defs_bot_id" | |
| }, | |
| { | |
| "title": "Nil bot_id set when display_as_bot is false", | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "bot_profile": { | |
| "$ref": "#/definitions/objs_bot_profile" | |
| }, | |
| "client_msg_id": { | |
| "type": "string" | |
| }, | |
| "comment": { | |
| "$ref": "#/definitions/objs_comment" | |
| }, | |
| "display_as_bot": { | |
| "type": "boolean" | |
| }, | |
| "file": { | |
| "$ref": "#/definitions/objs_file" | |
| }, | |
| "files": { | |
| "items": { | |
| "$ref": "#/definitions/objs_file" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "icons": { | |
| "properties": { | |
| "emoji": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "inviter": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "is_delayed_message": { | |
| "type": "boolean" | |
| }, | |
| "is_intro": { | |
| "type": "boolean" | |
| }, | |
| "is_starred": { | |
| "type": "boolean" | |
| }, | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest_reply": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "old_name": { | |
| "type": "string" | |
| }, | |
| "parent_user_id": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "permalink": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "pinned_to": { | |
| "items": { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| "type": "array" | |
| }, | |
| "purpose": { | |
| "type": "string" | |
| }, | |
| "reactions": { | |
| "items": { | |
| "$ref": "#/definitions/objs_reaction" | |
| }, | |
| "type": "array" | |
| }, | |
| "reply_count": { | |
| "type": "integer" | |
| }, | |
| "reply_users": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "reply_users_count": { | |
| "type": "integer" | |
| }, | |
| "source_team": { | |
| "$ref": "#/definitions/defs_workspace_id" | |
| }, | |
| "subscribed": { | |
| "type": "boolean" | |
| }, | |
| "subtype": { | |
| "type": "string" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_workspace_id" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "thread_ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "topic": { | |
| "type": "string" | |
| }, | |
| "ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "unread_count": { | |
| "type": "integer" | |
| }, | |
| "upload": { | |
| "type": "boolean" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "user_profile": { | |
| "$ref": "#/definitions/objs_user_profile_short" | |
| }, | |
| "user_team": { | |
| "$ref": "#/definitions/defs_workspace_id" | |
| }, | |
| "username": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "text", | |
| "type", | |
| "ts" | |
| ], | |
| "title": "Message object", | |
| "type": "object" | |
| }, | |
| "objs_paging": { | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "pages": { | |
| "type": "integer" | |
| }, | |
| "per_page": { | |
| "type": "integer" | |
| }, | |
| "spill": { | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "page", | |
| "total" | |
| ], | |
| "title": "paging object", | |
| "type": "object" | |
| }, | |
| "objs_reaction": { | |
| "additionalProperties": true, | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "users": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "required": [ | |
| "name", | |
| "users", | |
| "count" | |
| ], | |
| "title": "Reaction object", | |
| "type": "object" | |
| }, | |
| "objs_reminder": { | |
| "properties": { | |
| "complete_ts": { | |
| "type": "integer" | |
| }, | |
| "creator": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_reminder_id" | |
| }, | |
| "recurring": { | |
| "type": "boolean" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "time": { | |
| "type": "integer" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "creator", | |
| "user", | |
| "text", | |
| "recurring" | |
| ], | |
| "type": "object" | |
| }, | |
| "objs_resources": { | |
| "properties": { | |
| "excluded_ids": { | |
| "items": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| { | |
| "$ref": "#/definitions/defs_team" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "ids": { | |
| "items": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| { | |
| "$ref": "#/definitions/defs_team" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "wildcard": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "required": [ | |
| "ids" | |
| ], | |
| "title": "resources in info from apps.permissions.info", | |
| "type": "object" | |
| }, | |
| "objs_response_metadata": { | |
| "properties": { | |
| "next_cursor": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "next_cursor" | |
| ], | |
| "title": "new paging style", | |
| "type": "object" | |
| }, | |
| "objs_scopes": { | |
| "items": { | |
| "title": "Named OAuth scopes", | |
| "type": "string", | |
| "x-examples": [ | |
| "chat:write", | |
| "im:history", | |
| "im:read" | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "objs_subteam": { | |
| "properties": { | |
| "auto_provision": { | |
| "type": "boolean" | |
| }, | |
| "auto_type": { | |
| "items": [ | |
| { | |
| "type": "null" | |
| }, | |
| { | |
| "enum": [ | |
| "owner", | |
| "admin" | |
| ], | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "created_by": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "date_create": { | |
| "type": "integer" | |
| }, | |
| "date_delete": { | |
| "type": "integer" | |
| }, | |
| "date_update": { | |
| "type": "integer" | |
| }, | |
| "deleted_by": { | |
| "items": [ | |
| { | |
| "type": "null" | |
| }, | |
| { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| ] | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "enterprise_subteam_id": { | |
| "type": "string" | |
| }, | |
| "handle": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_subteam_id" | |
| }, | |
| "is_external": { | |
| "type": "boolean" | |
| }, | |
| "is_subteam": { | |
| "type": "boolean" | |
| }, | |
| "is_usergroup": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "prefs": { | |
| "properties": { | |
| "channels": { | |
| "items": { | |
| "$ref": "#/definitions/defs_channel_id" | |
| }, | |
| "type": "array" | |
| }, | |
| "groups": { | |
| "items": { | |
| "$ref": "#/definitions/defs_group_id" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "required": [ | |
| "channels", | |
| "groups" | |
| ], | |
| "type": "object" | |
| }, | |
| "team_id": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "updated_by": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "user_count": { | |
| "type": "integer" | |
| }, | |
| "users": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "team_id", | |
| "is_usergroup", | |
| "is_subteam", | |
| "name", | |
| "description", | |
| "handle", | |
| "is_external", | |
| "date_create", | |
| "date_update", | |
| "date_delete", | |
| "auto_type", | |
| "auto_provision", | |
| "enterprise_subteam_id", | |
| "created_by", | |
| "updated_by", | |
| "deleted_by", | |
| "prefs" | |
| ], | |
| "title": "Subteam/Usergroup Object", | |
| "type": "object" | |
| }, | |
| "objs_team": { | |
| "properties": { | |
| "archived": { | |
| "type": "boolean" | |
| }, | |
| "avatar_base_url": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "created": { | |
| "type": "integer" | |
| }, | |
| "date_create": { | |
| "type": "integer" | |
| }, | |
| "deleted": { | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "discoverable": { | |
| "type": "string" | |
| }, | |
| "domain": { | |
| "type": "string" | |
| }, | |
| "email_domain": { | |
| "type": "string" | |
| }, | |
| "enterprise_id": { | |
| "$ref": "#/definitions/defs_enterprise_id" | |
| }, | |
| "enterprise_name": { | |
| "$ref": "#/definitions/defs_enterprise_name" | |
| }, | |
| "has_compliance_export": { | |
| "type": "boolean" | |
| }, | |
| "icon": { | |
| "$ref": "#/definitions/objs_icon" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "is_assigned": { | |
| "type": "boolean" | |
| }, | |
| "is_enterprise": { | |
| "type": "integer" | |
| }, | |
| "limit_ts": { | |
| "type": "integer" | |
| }, | |
| "messages_count": { | |
| "type": "integer" | |
| }, | |
| "msg_edit_window_mins": { | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "over_integrations_limit": { | |
| "type": "boolean" | |
| }, | |
| "over_storage_limit": { | |
| "type": "boolean" | |
| }, | |
| "plan": { | |
| "enum": [ | |
| "", | |
| "std", | |
| "plus", | |
| "compliance", | |
| "enterprise" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "name", | |
| "domain", | |
| "email_domain", | |
| "icon" | |
| ], | |
| "title": "Team Object", | |
| "type": "object" | |
| }, | |
| "objs_team_profile_field": { | |
| "properties": { | |
| "field_name": { | |
| "type": "string" | |
| }, | |
| "hint": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "pattern": "^X[a-zA-Z0-9]{9,}$", | |
| "type": "string" | |
| }, | |
| "is_hidden": { | |
| "type": "boolean" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "options": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "ordering": { | |
| "type": "number" | |
| }, | |
| "possible_values": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "text", | |
| "date", | |
| "link", | |
| "mailto", | |
| "options_list", | |
| "user" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "ordering", | |
| "label", | |
| "hint", | |
| "type", | |
| "options" | |
| ], | |
| "type": "object" | |
| }, | |
| "objs_user": { | |
| "items": [ | |
| { | |
| "description": "user object for non enterprise type", | |
| "properties": { | |
| "color": { | |
| "pattern": "^[a-fA-F0-9]{6}$", | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean" | |
| }, | |
| "enterprise_user": { | |
| "$ref": "#/definitions/objs_enterprise_user" | |
| }, | |
| "has_2fa": { | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "is_admin": { | |
| "type": "boolean" | |
| }, | |
| "is_app_user": { | |
| "type": "boolean" | |
| }, | |
| "is_bot": { | |
| "type": "boolean" | |
| }, | |
| "is_external": { | |
| "type": "boolean" | |
| }, | |
| "is_invited_user": { | |
| "type": "boolean" | |
| }, | |
| "is_owner": { | |
| "type": "boolean" | |
| }, | |
| "is_primary_owner": { | |
| "type": "boolean" | |
| }, | |
| "is_restricted": { | |
| "type": "boolean" | |
| }, | |
| "is_ultra_restricted": { | |
| "type": "boolean" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "presence": { | |
| "type": "string" | |
| }, | |
| "profile": { | |
| "$ref": "#/definitions/objs_user_profile" | |
| }, | |
| "real_name": { | |
| "type": "string" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "team_id": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "team_profile": { | |
| "properties": { | |
| "fields": { | |
| "items": { | |
| "$ref": "#/definitions/objs_team_profile_field" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| } | |
| }, | |
| "required": [ | |
| "fields" | |
| ], | |
| "type": "object" | |
| }, | |
| "two_factor_type": { | |
| "type": "string" | |
| }, | |
| "tz": { | |
| "items": [ | |
| { | |
| "type": "null" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "tz_label": { | |
| "type": "string" | |
| }, | |
| "tz_offset": { | |
| "type": "number" | |
| }, | |
| "updated": { | |
| "type": "number" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "name", | |
| "deleted", | |
| "profile", | |
| "is_bot", | |
| "updated", | |
| "is_app_user" | |
| ], | |
| "type": "object" | |
| }, | |
| { | |
| "description": "enterprise user", | |
| "properties": { | |
| "color": { | |
| "description": "refercing to bug: https://jira.tinyspeck.com/browse/EVALUE-1559", | |
| "pattern": "^$", | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean" | |
| }, | |
| "enterprise_user": { | |
| "$ref": "#/definitions/objs_enterprise_user" | |
| }, | |
| "has_2fa": { | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "is_admin": { | |
| "type": "boolean" | |
| }, | |
| "is_app_user": { | |
| "type": "boolean" | |
| }, | |
| "is_bot": { | |
| "type": "boolean" | |
| }, | |
| "is_external": { | |
| "type": "boolean" | |
| }, | |
| "is_owner": { | |
| "type": "boolean" | |
| }, | |
| "is_primary_owner": { | |
| "type": "boolean" | |
| }, | |
| "is_restricted": { | |
| "type": "boolean" | |
| }, | |
| "is_ultra_restricted": { | |
| "type": "boolean" | |
| }, | |
| "locale": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "presence": { | |
| "type": "string" | |
| }, | |
| "profile": { | |
| "$ref": "#/definitions/objs_user_profile" | |
| }, | |
| "real_name": { | |
| "type": "string" | |
| }, | |
| "team_id": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "team_profile": { | |
| "properties": { | |
| "fields": { | |
| "items": { | |
| "$ref": "#/definitions/objs_team_profile_field" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| } | |
| }, | |
| "required": [ | |
| "fields" | |
| ], | |
| "type": "object" | |
| }, | |
| "teams": { | |
| "items": { | |
| "$ref": "#/definitions/defs_workspace_id" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "two_factor_type": { | |
| "type": "string" | |
| }, | |
| "tz": { | |
| "items": [ | |
| { | |
| "type": "null" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "tz_label": { | |
| "type": "string" | |
| }, | |
| "tz_offset": { | |
| "type": "number" | |
| }, | |
| "updated": { | |
| "type": "number" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "name", | |
| "deleted", | |
| "profile", | |
| "is_restricted", | |
| "is_ultra_restricted", | |
| "is_bot", | |
| "updated", | |
| "is_app_user" | |
| ], | |
| "type": "object" | |
| } | |
| ] | |
| }, | |
| "objs_user_profile": { | |
| "properties": { | |
| "always_active": { | |
| "type": "boolean" | |
| }, | |
| "api_app_id": { | |
| "$ref": "#/definitions/defs_app_id" | |
| }, | |
| "avatar_hash": { | |
| "type": "string" | |
| }, | |
| "bot_id": { | |
| "$ref": "#/definitions/defs_bot_id" | |
| }, | |
| "display_name": { | |
| "type": "string" | |
| }, | |
| "display_name_normalized": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "format": "email", | |
| "type": "string" | |
| }, | |
| "fields": { | |
| "items": { | |
| "type": "object" | |
| }, | |
| "type": [ | |
| "object", | |
| "null", | |
| "array" | |
| ] | |
| }, | |
| "first_name": { | |
| "type": "string" | |
| }, | |
| "guest_expiration_ts": { | |
| "type": "integer" | |
| }, | |
| "guest_invited_by": { | |
| "type": "string" | |
| }, | |
| "image_1024": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_192": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_24": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_32": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_48": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_512": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_72": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_original": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "is_custom_image": { | |
| "type": "boolean" | |
| }, | |
| "last_name": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "real_name": { | |
| "type": "string" | |
| }, | |
| "real_name_normalized": { | |
| "type": "string" | |
| }, | |
| "skype": { | |
| "type": "string" | |
| }, | |
| "status_emoji": { | |
| "type": "string" | |
| }, | |
| "status_expiration": { | |
| "type": "integer" | |
| }, | |
| "status_text": { | |
| "type": "string" | |
| }, | |
| "status_text_canonical": { | |
| "type": "string" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_workspace_id" | |
| }, | |
| "teams": { | |
| "$ref": "#/definitions/defs_workspace_id" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "real_name", | |
| "display_name", | |
| "avatar_hash", | |
| "real_name_normalized", | |
| "display_name_normalized" | |
| ], | |
| "title": "User profile object", | |
| "type": "object" | |
| }, | |
| "objs_user_profile_short": { | |
| "properties": { | |
| "avatar_hash": { | |
| "type": "string" | |
| }, | |
| "display_name": { | |
| "type": "string" | |
| }, | |
| "display_name_normalized": { | |
| "type": "string" | |
| }, | |
| "first_name": { | |
| "type": "string" | |
| }, | |
| "image_72": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "is_restricted": { | |
| "type": "boolean" | |
| }, | |
| "is_ultra_restricted": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "real_name": { | |
| "type": "string" | |
| }, | |
| "real_name_normalized": { | |
| "type": "string" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_workspace_id" | |
| } | |
| }, | |
| "required": [ | |
| "avatar_hash", | |
| "image_72", | |
| "first_name", | |
| "real_name", | |
| "display_name", | |
| "team", | |
| "name", | |
| "is_restricted", | |
| "is_ultra_restricted" | |
| ], | |
| "type": "object" | |
| } | |
| }, | |
| "externalDocs": { | |
| "description": "Learn more about the Slack Web API", | |
| "url": "https://api.slack.com/web" | |
| }, | |
| "host": "slack.com", | |
| "info": { | |
| "contact": { | |
| "name": "Slack developer relations", | |
| "url": "https://api.slack.com/support" | |
| }, | |
| "description": "One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.", | |
| "title": "Slack Web API", | |
| "version": "1.5.0" | |
| }, | |
| "paths": { | |
| "/admin.apps.approve": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Approve an app for installation on a workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.apps.approve" | |
| }, | |
| "operationId": "admin_apps_approve", | |
| "parameters": [ | |
| { | |
| "in": "formData", | |
| "name": "team_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.apps:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The id of the app to approve.", | |
| "in": "formData", | |
| "name": "app_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The id of the request to approve.", | |
| "in": "formData", | |
| "name": "request_id", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.apps:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.apps", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.apps.approved.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "List approved apps for an org or workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.apps.approved.list" | |
| }, | |
| "operationId": "admin_apps_approved_list", | |
| "parameters": [ | |
| { | |
| "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.apps:read`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "team_id", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "enterprise_id", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "approved_apps": [ | |
| { | |
| "app": { | |
| "additional_info": "", | |
| "app_directory_url": "https://myteam.enterprise.slack.com/apps/A0W7UKG8E-my-test-app", | |
| "app_homepage_url": "https://www.slack.com", | |
| "description": "test app", | |
| "help_url": "https://www.slack.com", | |
| "icons": { | |
| "image_1024": "https://3026743124446w96_2bd4ea1ad1f89a23c242_1024.png", | |
| "image_128": "https://30267341249446w6_2bd4ea1ad1f89a23c242_128.png", | |
| "image_192": "https://30267431249446w6_2bd4ea1ad1f89a23c242_192.png", | |
| "image_32": "https://302674312496446w_2bd4ea1ad1f89a23c242_32.png", | |
| "image_36": "https://302674312496446w_2bd4ea1ad1f89a23c242_36.png", | |
| "image_48": "https://302674312496446w_2bd4ea1ad1f89a23c242_48.png", | |
| "image_512": "https://30267431249446w6_2bd4ea1ad1f89a23c242_512.png", | |
| "image_64": "https://302674312496446w_2bd4ea1ad1f89a23c242_64.png", | |
| "image_72": "https://302674312496446w_2bd4ea1ad1f89a23c242_72.png", | |
| "image_96": "https://302674312496446w_2bd4ea1ad1f89a23c242_96.png", | |
| "image_original": "https://302674446w12496_2bd4ea1ad1f89a23c242_original.png" | |
| }, | |
| "id": "A0W7UKG8E", | |
| "is_app_directory_approved": false, | |
| "is_internal": false, | |
| "name": "My Test App", | |
| "privacy_policy_url": "https://www.slack.com" | |
| }, | |
| "date_updated": 1574296707, | |
| "last_resolved_by": { | |
| "actor_id": "W0G82F4FD", | |
| "actor_type": "user" | |
| }, | |
| "scopes": [ | |
| { | |
| "description": "Add the ability for people to direct message or mention @my_test_app", | |
| "is_sensitive": true, | |
| "name": "bot", | |
| "token_type": "bot" | |
| } | |
| ] | |
| } | |
| ], | |
| "ok": true, | |
| "response_metadata": { | |
| "next_cursor": "" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.apps:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.apps.approved", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.apps.requests.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "List app requests for a team/workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.apps.requests.list" | |
| }, | |
| "operationId": "admin_apps_requests_list", | |
| "parameters": [ | |
| { | |
| "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.apps:read`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "team_id", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "app_requests": [ | |
| { | |
| "app": { | |
| "additional_info": "", | |
| "app_directory_url": "https://acmecorp.slack.com/apps/A061BL8RQ0-test-app", | |
| "app_homepage_url": "", | |
| "description": "", | |
| "help_url": "", | |
| "icons": { | |
| "image_1024": "/cdn/15258203/img/testapp/service_1024.png", | |
| "image_128": "/cdn/157258203/img/testapp/service_128.png", | |
| "image_192": "/cdn/157258203/img/testapp/service_192.png", | |
| "image_32": "/cdn/157658203/img/testapp/service_32.png", | |
| "image_36": "/cdn/157658203/img/testapp/service_36.png", | |
| "image_48": "/cdn/157658203/img/testapp/service_48.png", | |
| "image_512": "/cdn/15758203/img/testapp/service_512.png", | |
| "image_64": "/cdn/157658203/img/testapp/service_64.png", | |
| "image_72": "/cdn/157658203/img/testapp/service_72.png", | |
| "image_96": "/cdn/157658203/img/testapp/service_96.png" | |
| }, | |
| "id": "A061BL8RQ0", | |
| "is_app_directory_approved": true, | |
| "is_internal": false, | |
| "name": "Test App", | |
| "privacy_policy_url": "https://testapp.com/privacy" | |
| }, | |
| "date_created": 1578956327, | |
| "id": "Ar0XJGFLMLS", | |
| "message": "test test again", | |
| "previous_resolution": null, | |
| "scopes": [ | |
| { | |
| "description": "Post messages to specific channels in Slack", | |
| "is_sensitive": false, | |
| "name": "incoming-webhook", | |
| "token_type": "user" | |
| } | |
| ], | |
| "team": { | |
| "domain": "acmecorp", | |
| "id": "T0M94LNUCR", | |
| "name": "Acme Corp" | |
| }, | |
| "user": { | |
| "email": "janedoe@example.com", | |
| "id": "W08RA9G5HR", | |
| "name": "Jane Doe" | |
| } | |
| } | |
| ], | |
| "ok": true, | |
| "response_metadata": { | |
| "next_cursor": "" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "missing_scope", | |
| "needed": "admin.apps:read", | |
| "ok": false, | |
| "provided": "read,client,admin,identify,post,apps" | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.apps:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.apps.requests", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.apps.restrict": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Restrict an app for installation on a workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.apps.restrict" | |
| }, | |
| "operationId": "admin_apps_restrict", | |
| "parameters": [ | |
| { | |
| "in": "formData", | |
| "name": "team_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.apps:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The id of the app to restrict.", | |
| "in": "formData", | |
| "name": "app_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The id of the request to restrict.", | |
| "in": "formData", | |
| "name": "request_id", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.apps:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.apps", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.apps.restricted.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "List restricted apps for an org or workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.apps.restricted.list" | |
| }, | |
| "operationId": "admin_apps_restricted_list", | |
| "parameters": [ | |
| { | |
| "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.apps:read`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "team_id", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "enterprise_id", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "response_metadata": { | |
| "next_cursor": "" | |
| }, | |
| "restricted_apps": [ | |
| { | |
| "app": { | |
| "additional_info": "", | |
| "app_directory_url": "https://myteam.enterprise.slack.com/apps/A0FDLP8M2L-my-test-app", | |
| "app_homepage_url": "https://example.com", | |
| "description": "A fun test app for Slack", | |
| "help_url": "https://example.com", | |
| "icons": { | |
| "image_1024": "https://1433265338rl878408_eb57dbc818daa4ba15d6_1024.png", | |
| "image_128": "https://4332653438rl87808_eb57dbc818daa4ba15d6_128.png", | |
| "image_192": "https://4332653438rl87808_eb57dbc818daa4ba15d6_192.png", | |
| "image_32": "https://143326534038rl8788_eb57dbc818daa4ba15d6_32.png", | |
| "image_36": "https://143326534038rl8788_eb57dbc818daa4ba15d6_36.png", | |
| "image_48": "https://143326534038rl8788_eb57dbc818daa4ba15d6_48.png", | |
| "image_512": "https://4332653438rl87808_eb57dbc818daa4ba15d6_512.png", | |
| "image_64": "https://143326534038rl8788_eb57dbc818daa4ba15d6_64.png", | |
| "image_72": "https://143326534038rl8788_eb57dbc818daa4ba15d6_72.png", | |
| "image_96": "https://143326534038rl8788_eb57dbc818daa4ba15d6_96.png", | |
| "image_original": "https://143338rl8782653408_eb57dbc818daa4ba15d6_original.png" | |
| }, | |
| "id": "A0FDLP8M2L", | |
| "is_app_directory_approved": true, | |
| "is_internal": false, | |
| "name": "My Test App", | |
| "privacy_policy_url": "https://example.com" | |
| }, | |
| "date_updated": 1574296721, | |
| "last_resolved_by": { | |
| "actor_id": "W0G82LMFD", | |
| "actor_type": "user" | |
| }, | |
| "scopes": [ | |
| { | |
| "description": "Upload, edit, and delete files on the user\u201fs behalf", | |
| "is_sensitive": true, | |
| "name": "files:write:user", | |
| "token_type": "user" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.apps:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.apps.restricted", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.conversations.setTeams": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Set the workspaces in an Enterprise grid org that connect to a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.conversations.setTeams" | |
| }, | |
| "operationId": "admin_conversations_setTeams", | |
| "parameters": [ | |
| { | |
| "description": "The encoded `channel_id` to add or remove to workspaces.", | |
| "in": "formData", | |
| "name": "channel_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "True if channel has to be converted to an org channel", | |
| "in": "formData", | |
| "name": "org_channel", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The list of workspaces to which the channel should be shared. Not required if the channel is being shared orgwide. Example: `['T1234', 'T5678']`", | |
| "in": "formData", | |
| "name": "target_team_ids", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.conversations:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.conversations", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.emoji.add": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Add an emoji.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.emoji.add" | |
| }, | |
| "operationId": "admin_emoji_add", | |
| "parameters": [ | |
| { | |
| "description": "The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best.", | |
| "in": "formData", | |
| "name": "url", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included.", | |
| "in": "formData", | |
| "name": "name", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.emoji", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.emoji.addAlias": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Add an emoji alias.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.emoji.addAlias" | |
| }, | |
| "operationId": "admin_emoji_addAlias", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The name of the emoji to be aliased. Colons (`:myemoji:`) around the value are not required, although they may be included.", | |
| "in": "formData", | |
| "name": "name", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The alias of the emoji.", | |
| "in": "formData", | |
| "name": "alias_for", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.emoji", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.emoji.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "List emoji for an Enterprise Grid organization.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.emoji.list" | |
| }, | |
| "operationId": "admin_emoji_list", | |
| "parameters": [ | |
| { | |
| "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:read`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "cache_ts": "1575283387.000000", | |
| "categories": [ | |
| { | |
| "emoji_names": [ | |
| "grinning", | |
| "grin", | |
| "joy", | |
| "etc etc ..." | |
| ], | |
| "name": "Smileys & People" | |
| } | |
| ], | |
| "categories_version": "5", | |
| "emoji": { | |
| "black_square": "alias:black_large_square", | |
| "bowtie": "https://emoji.slack-edge.com/T9TK3CUKW/bowtie/f3ec6f2bb0.png", | |
| "cubimal_chick": "https://emoji.slack-edge.com/T9TK3CUKW/cubimal_chick/85961c43d7.png", | |
| "dusty_stick": "https://emoji.slack-edge.com/T9TK3CUKW/dusty_stick/6177a62312.png", | |
| "glitch_crab": "https://emoji.slack-edge.com/T9TK3CUKW/glitch_crab/db049f1f9c.png", | |
| "piggy": "https://emoji.slack-edge.com/T9TK3CUKW/piggy/b7762ee8cd.png", | |
| "pride": "https://emoji.slack-edge.com/T9TK3CUKW/pride/56b1bd3388.png", | |
| "shipit": "alias:squirrel", | |
| "simple_smile": { | |
| "apple": "https://a.slack-edge.com/80588/img/emoji_2017_12_06/apple/simple_smile.png", | |
| "google": "https://a.slack-edge.com/80588/img/emoji_2017_12_06/google/simple_smile.png" | |
| }, | |
| "slack": "https://emoji.slack-edge.com/T9TK3CUKW/slack/7d462d2443.png", | |
| "slack_call": "https://emoji.slack-edge.com/T9TK3CUKW/slack_call/b81fffd6dd.png", | |
| "squirrel": "https://emoji.slack-edge.com/T9TK3CUKW/squirrel/465f40c0e0.png", | |
| "thumbsup_all": "https://emoji.slack-edge.com/T9TK3CUKW/thumbsup_all/50096a1020.gif", | |
| "white_square": "alias:white_large_square" | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.emoji", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.emoji.remove": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Remove an emoji across an Enterprise Grid organization", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.emoji.remove" | |
| }, | |
| "operationId": "admin_emoji_remove", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included.", | |
| "in": "formData", | |
| "name": "name", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.emoji", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.emoji.rename": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Rename an emoji.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.emoji.rename" | |
| }, | |
| "operationId": "admin_emoji_rename", | |
| "parameters": [ | |
| { | |
| "description": "The new name of the emoji.", | |
| "in": "formData", | |
| "name": "new_name", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The name of the emoji to be renamed. Colons (`:myemoji:`) around the value are not required, although they may be included.", | |
| "in": "formData", | |
| "name": "name", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.emoji", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.inviteRequests.approve": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Approve a workspace invite request.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.inviteRequests.approve" | |
| }, | |
| "operationId": "admin_inviteRequests_approve", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.invites:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID for the workspace where the invite request was made.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID of the request to invite.", | |
| "in": "formData", | |
| "name": "invite_request_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.invites:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.inviteRequests", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.inviteRequests.approved.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "List all approved workspace invite requests.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.inviteRequests.approved.list" | |
| }, | |
| "operationId": "admin_inviteRequests_approved_list", | |
| "parameters": [ | |
| { | |
| "description": "Value of the `next_cursor` field sent as part of the previous API response", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.invites:read`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "ID for the workspace where the invite requests were made.", | |
| "in": "query", | |
| "name": "team_id", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.invites:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.inviteRequests.approved", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.inviteRequests.denied.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "List all denied workspace invite requests.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.inviteRequests.denied.list" | |
| }, | |
| "operationId": "admin_inviteRequests_denied_list", | |
| "parameters": [ | |
| { | |
| "description": "Value of the `next_cursor` field sent as part of the previous api response", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.invites:read`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "ID for the workspace where the invite requests were made.", | |
| "in": "query", | |
| "name": "team_id", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.invites:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.inviteRequests.denied", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.inviteRequests.deny": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Deny a workspace invite request.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.inviteRequests.deny" | |
| }, | |
| "operationId": "admin_inviteRequests_deny", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.invites:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID for the workspace where the invite request was made.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID of the request to invite.", | |
| "in": "formData", | |
| "name": "invite_request_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.invites:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.inviteRequests", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.inviteRequests.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "List all pending workspace invite requests.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.inviteRequests.list" | |
| }, | |
| "operationId": "admin_inviteRequests_list", | |
| "parameters": [ | |
| { | |
| "description": "Value of the `next_cursor` field sent as part of the previous API response", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.invites:read`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "ID for the workspace where the invite requests were made.", | |
| "in": "query", | |
| "name": "team_id", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.invites:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.inviteRequests", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.teams.admins.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "List all of the admins on a given workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.teams.admins.list" | |
| }, | |
| "operationId": "admin_teams_admins_list", | |
| "parameters": [ | |
| { | |
| "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:read`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "admin_ids": [ | |
| "U1234" | |
| ], | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.teams.admins", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.teams.create": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Create an Enterprise team.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.teams.create" | |
| }, | |
| "operationId": "admin_teams_create", | |
| "parameters": [ | |
| { | |
| "description": "Team domain (for example, slacksoftballteam).", | |
| "in": "formData", | |
| "name": "team_domain", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Description for the team.", | |
| "in": "formData", | |
| "name": "team_description", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Team name (for example, Slack Softball Team).", | |
| "in": "formData", | |
| "name": "team_name", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Who can join the team. A team's discoverability can be `open`, `closed`, `invite_only`, or `unlisted`.", | |
| "in": "formData", | |
| "name": "team_discoverability", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "team": "T12345" | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.teams", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.teams.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "List all teams on an Enterprise organization", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.teams.list" | |
| }, | |
| "operationId": "admin_teams_list", | |
| "parameters": [ | |
| { | |
| "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:read`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Must be between 1 - 100 both inclusive.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "teams": [ | |
| { | |
| "discoverability": "hidden", | |
| "id": "T1234", | |
| "name": "My Team", | |
| "primary_owner": { | |
| "email": "bront@slack.com", | |
| "user_id": "W1234" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.teams", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.teams.owners.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "List all of the owners on a given workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.teams.owners.list" | |
| }, | |
| "operationId": "admin_teams_owners_list", | |
| "parameters": [ | |
| { | |
| "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:read`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "owner_ids": [ | |
| "U1234" | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.teams.owners", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.teams.settings.info": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Fetch information about settings in a workspace", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.teams.settings.info" | |
| }, | |
| "operationId": "admin_teams_settings_info", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:read`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "team": { | |
| "default_channels": "array", | |
| "domain": "string", | |
| "email_domain": "string", | |
| "enterprise_id": "string", | |
| "enterprise_name": "string", | |
| "icon": "array", | |
| "id": "string", | |
| "name": "string" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.teams.settings", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.teams.settings.setDefaultChannels": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Set the default channels of a workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.teams.settings.setDefaultChannels" | |
| }, | |
| "operationId": "admin_teams_settings_setDefaultChannels", | |
| "parameters": [ | |
| { | |
| "description": "An array of channel IDs.", | |
| "in": "formData", | |
| "name": "channel_ids", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID for the workspace to set the default channel for.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.teams.settings", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.teams.settings.setDescription": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Set the description of a given workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.teams.settings.setDescription" | |
| }, | |
| "operationId": "admin_teams_settings_setDescription", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID for the workspace to set the description for.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The new description for the workspace.", | |
| "in": "formData", | |
| "name": "description", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.teams.settings", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.teams.settings.setDiscoverability": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "An API method that allows admins to set the discoverability of a given workspace", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.teams.settings.setDiscoverability" | |
| }, | |
| "operationId": "admin_teams_settings_setDiscoverability", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID of the workspace to set discoverability on.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "This workspace's discovery setting. It must be set to one of `open`, `invite_only`, `closed`, or `unlisted`.", | |
| "in": "formData", | |
| "name": "discoverability", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.teams.settings", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.teams.settings.setIcon": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Sets the icon of a workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.teams.settings.setIcon" | |
| }, | |
| "operationId": "admin_teams_settings_setIcon", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Image URL for the icon", | |
| "in": "formData", | |
| "name": "image_url", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID for the workspace to set the icon for.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.teams.settings", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.teams.settings.setName": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Set the name of a given workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.teams.settings.setName" | |
| }, | |
| "operationId": "admin_teams_settings_setName", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.teams:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID for the workspace to set the name for.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The new name of the workspace.", | |
| "in": "formData", | |
| "name": "name", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.teams:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.teams.settings", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.users.assign": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Add an Enterprise user to a workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.users.assign" | |
| }, | |
| "operationId": "admin_users_assign", | |
| "parameters": [ | |
| { | |
| "description": "The ID of the user to add to the workspace.", | |
| "in": "formData", | |
| "name": "user_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Comma separated values of channel IDs to add user in the new workspace.", | |
| "in": "formData", | |
| "name": "channel_ids", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID (`T1234`) of the workspace.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.users:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "True if user should be added to the workspace as a single-channel guest.", | |
| "in": "formData", | |
| "name": "is_ultra_restricted", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "True if user should be added to the workspace as a guest.", | |
| "in": "formData", | |
| "name": "is_restricted", | |
| "type": "boolean" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.users:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.users", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.users.invite": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Invite a user to a workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.users.invite" | |
| }, | |
| "operationId": "admin_users_invite", | |
| "parameters": [ | |
| { | |
| "description": "A comma-separated list of `channel_id`s for this user to join. At least one channel is required.", | |
| "in": "formData", | |
| "name": "channel_ids", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID (`T1234`) of the workspace.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Full name of the user.", | |
| "in": "formData", | |
| "name": "real_name", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.users:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Is this user a single channel guest user? (default: false)", | |
| "in": "formData", | |
| "name": "is_ultra_restricted", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "An optional message to send to the user in the invite email.", | |
| "in": "formData", | |
| "name": "custom_message", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Is this user a multi-channel guest user? (default: false)", | |
| "in": "formData", | |
| "name": "is_restricted", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.", | |
| "in": "formData", | |
| "name": "guest_expiration_ts", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The email address of the person to invite.", | |
| "in": "formData", | |
| "name": "email", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Allow this invite to be resent in the future if a user has not signed up yet. (default: false)", | |
| "in": "formData", | |
| "name": "resend", | |
| "type": "boolean" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.users:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.users", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.users.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "List users on a workspace", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.users.list" | |
| }, | |
| "operationId": "admin_users_list", | |
| "parameters": [ | |
| { | |
| "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.users:read`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Limit for how many users to be retrieved per page", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "The ID (`T1234`) of the workspace.", | |
| "in": "query", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "users": [ | |
| { | |
| "email": "bront@slack.com", | |
| "id": "T1234", | |
| "is_admin": false, | |
| "is_bot": false, | |
| "is_owner": false, | |
| "is_primary_owner": false, | |
| "is_restricted": false, | |
| "is_ultra_restricted": false | |
| } | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.users:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.users", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.users.remove": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Remove a user from a workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.users.remove" | |
| }, | |
| "operationId": "admin_users_remove", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.users:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID of the user to remove.", | |
| "in": "formData", | |
| "name": "user_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID (`T1234`) of the workspace.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.users:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.users", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.users.session.reset": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Wipes all valid sessions on all devices for a given user", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.users.session.reset" | |
| }, | |
| "operationId": "admin_users_session_reset", | |
| "parameters": [ | |
| { | |
| "description": "Only expire mobile sessions (default: false)", | |
| "in": "formData", | |
| "name": "mobile_only", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.users:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID of the user to wipe sessions for", | |
| "in": "formData", | |
| "name": "user_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Only expire web sessions (default: false)", | |
| "in": "formData", | |
| "name": "web_only", | |
| "type": "boolean" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.users:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.users.session", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.users.setAdmin": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Set an existing guest, regular user, or owner to be an admin user.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.users.setAdmin" | |
| }, | |
| "operationId": "admin_users_setAdmin", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.users:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID of the user to designate as an admin.", | |
| "in": "formData", | |
| "name": "user_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID (`T1234`) of the workspace.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.users:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.users", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.users.setExpiration": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Set an expiration for a guest user", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.users.setExpiration" | |
| }, | |
| "operationId": "admin_users_setExpiration", | |
| "parameters": [ | |
| { | |
| "description": "Timestamp when guest account should be disabled.", | |
| "in": "formData", | |
| "name": "expiration_ts", | |
| "required": true, | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `admin.users:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID of the user to set an expiration for.", | |
| "in": "formData", | |
| "name": "user_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID (`T1234`) of the workspace.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.users:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.users", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.users.setOwner": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Set an existing guest, regular user, or admin user to be a workspace owner.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.users.setOwner" | |
| }, | |
| "operationId": "admin_users_setOwner", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.users:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Id of the user to promote to owner.", | |
| "in": "formData", | |
| "name": "user_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID (`T1234`) of the workspace.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.users:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.users", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/admin.users.setRegular": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Set an existing guest user, admin user, or owner to be a regular user.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/admin.users.setRegular" | |
| }, | |
| "operationId": "admin_users_setRegular", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `admin.users:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID of the user to designate as a regular user.", | |
| "in": "formData", | |
| "name": "user_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID (`T1234`) of the workspace.", | |
| "in": "formData", | |
| "name": "team_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "admin.users:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "admin.users", | |
| "admin" | |
| ] | |
| } | |
| }, | |
| "/api.test": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Checks API calling code.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/api.test" | |
| }, | |
| "operationId": "api_test", | |
| "parameters": [ | |
| { | |
| "description": "example property to return", | |
| "in": "query", | |
| "name": "foo", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Error response to return", | |
| "in": "query", | |
| "name": "error", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Standard success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": { | |
| "type": "object" | |
| }, | |
| "description": "Schema for successful response api.test method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "api.test success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Artificial error response", | |
| "examples": { | |
| "application/json": { | |
| "args": { | |
| "error": "my_error" | |
| }, | |
| "error": "my_error", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": { | |
| "type": "object" | |
| }, | |
| "description": "Schema for error response api.test method", | |
| "properties": { | |
| "error": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "api.test error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "api" | |
| ] | |
| } | |
| }, | |
| "/apps.permissions.info": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Returns list of permissions this app has on a team.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/apps.permissions.info" | |
| }, | |
| "operationId": "apps_permissions_info", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Standard success response when used with a user token", | |
| "examples": { | |
| "application/json": { | |
| "info": { | |
| "app_home": { | |
| "resources": { | |
| "ids": [ | |
| "D0C0NU1Q8", | |
| "D0BH95DLH" | |
| ] | |
| }, | |
| "scopes": [ | |
| "chat:write", | |
| "im:history", | |
| "im:read" | |
| ] | |
| }, | |
| "channel": { | |
| "resources": { | |
| "excluded_ids": [], | |
| "ids": [ | |
| "C061FA5PB" | |
| ], | |
| "wildcard": false | |
| }, | |
| "scopes": [ | |
| "channels:read" | |
| ] | |
| }, | |
| "group": { | |
| "resources": { | |
| "ids": [] | |
| }, | |
| "scopes": [] | |
| }, | |
| "im": { | |
| "resources": { | |
| "ids": [] | |
| }, | |
| "scopes": [] | |
| }, | |
| "mpim": { | |
| "resources": { | |
| "ids": [] | |
| }, | |
| "scopes": [] | |
| }, | |
| "team": { | |
| "resources": { | |
| "ids": [] | |
| }, | |
| "scopes": [] | |
| } | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from apps.permissions.info method", | |
| "properties": { | |
| "info": { | |
| "properties": { | |
| "app_home": { | |
| "properties": { | |
| "resources": { | |
| "$ref": "#/definitions/objs_resources" | |
| }, | |
| "scopes": { | |
| "$ref": "#/definitions/objs_scopes" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "channel": { | |
| "properties": { | |
| "resources": { | |
| "$ref": "#/definitions/objs_resources" | |
| }, | |
| "scopes": { | |
| "$ref": "#/definitions/objs_scopes" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "group": { | |
| "properties": { | |
| "resources": { | |
| "$ref": "#/definitions/objs_resources" | |
| }, | |
| "scopes": { | |
| "$ref": "#/definitions/objs_scopes" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "im": { | |
| "properties": { | |
| "resources": { | |
| "$ref": "#/definitions/objs_resources" | |
| }, | |
| "scopes": { | |
| "$ref": "#/definitions/objs_scopes" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "mpim": { | |
| "properties": { | |
| "resources": { | |
| "$ref": "#/definitions/objs_resources" | |
| }, | |
| "scopes": { | |
| "$ref": "#/definitions/objs_scopes" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "team": { | |
| "properties": { | |
| "resources": { | |
| "$ref": "#/definitions/objs_resources" | |
| }, | |
| "scopes": { | |
| "$ref": "#/definitions/objs_scopes" | |
| } | |
| }, | |
| "required": [ | |
| "scopes", | |
| "resources" | |
| ], | |
| "type": "object" | |
| } | |
| }, | |
| "required": [ | |
| "team", | |
| "channel", | |
| "group", | |
| "mpim", | |
| "im", | |
| "app_home" | |
| ], | |
| "type": "object" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "info" | |
| ], | |
| "title": "apps.permissions.info schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Standard failure response when used with an invalid token", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from apps.permissions.info method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "apps.permissions.info error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "apps.permissions", | |
| "apps" | |
| ] | |
| } | |
| }, | |
| "/apps.permissions.request": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Allows an app to request additional scopes", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/apps.permissions.request" | |
| }, | |
| "operationId": "apps_permissions_request", | |
| "parameters": [ | |
| { | |
| "description": "A comma separated list of scopes to request for", | |
| "in": "query", | |
| "name": "scopes", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Token used to trigger the permissions API", | |
| "in": "query", | |
| "name": "trigger_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Standard success response when used with a user token", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from apps.permissions.request method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "apps.permissions.request schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Standard failure response when trigger_id is invalid", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_trigger_id", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from apps.permissions.request method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "invalid_trigger", | |
| "trigger_exchanged", | |
| "invalid_scope", | |
| "invalid_user", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "apps.permissions.request error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "apps.permissions", | |
| "apps" | |
| ] | |
| } | |
| }, | |
| "/apps.permissions.resources.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Returns list of resource grants this app has on a team.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/apps.permissions.resources.list" | |
| }, | |
| "operationId": "apps_permissions_resources_list", | |
| "parameters": [ | |
| { | |
| "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical successful paginated response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "resources": [ | |
| { | |
| "id": "T0DES3UAN", | |
| "type": "team" | |
| }, | |
| { | |
| "id": "D024BFF1M", | |
| "type": "app_home" | |
| }, | |
| { | |
| "id": "C024BE91L", | |
| "type": "channel" | |
| } | |
| ], | |
| "response_metadata": { | |
| "next_cursor": "dGVhbTpDMUg5UkVTR0w=" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "Schema for successful response apps.permissions.resources.list method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "resources": { | |
| "items": { | |
| "properties": { | |
| "id": { | |
| "title": "An ID for a resource", | |
| "type": "string", | |
| "x-examples": [ | |
| "T0DES3UAN", | |
| "C0ABC1ABC" | |
| ] | |
| }, | |
| "type": { | |
| "title": "The type of resource the `id` corresponds to", | |
| "type": "string", | |
| "x-examples": [ | |
| "team", | |
| "channel", | |
| "mpim" | |
| ] | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| }, | |
| "response_metadata": { | |
| "properties": { | |
| "next_cursor": { | |
| "type": "string", | |
| "x-examples": [ | |
| "dGVhbTpDMUg5UkVTR0w=" | |
| ] | |
| } | |
| }, | |
| "required": [ | |
| "next_cursor" | |
| ], | |
| "type": "object" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "resources" | |
| ], | |
| "title": "apps.permissions.resources.list success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_cursor", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from apps.permissions.resources.list method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "invalid_cursor", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "apps.permissions.resources.list error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "apps.permissions.resources", | |
| "apps" | |
| ] | |
| } | |
| }, | |
| "/apps.permissions.scopes.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Returns list of scopes this app has on a team.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/apps.permissions.scopes.list" | |
| }, | |
| "operationId": "apps_permissions_scopes_list", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical successful paginated response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "scopes": { | |
| "app_home": [ | |
| "chat:write", | |
| "im:history", | |
| "im:read" | |
| ], | |
| "channel": [ | |
| "channels:history", | |
| "chat:write" | |
| ], | |
| "group": [ | |
| "chat:write" | |
| ], | |
| "im": [ | |
| "chat:write" | |
| ], | |
| "mpim": [ | |
| "chat:write" | |
| ], | |
| "team": [ | |
| "users:read" | |
| ], | |
| "user": [] | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "Schema for successful response api.permissions.scopes.list method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "scopes": { | |
| "additionalProperties": true, | |
| "properties": { | |
| "app_home": { | |
| "$ref": "#/definitions/objs_scopes" | |
| }, | |
| "channel": { | |
| "$ref": "#/definitions/objs_scopes" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/objs_scopes" | |
| }, | |
| "im": { | |
| "$ref": "#/definitions/objs_scopes" | |
| }, | |
| "mpim": { | |
| "$ref": "#/definitions/objs_scopes" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/objs_scopes" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/objs_scopes" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "scopes" | |
| ], | |
| "title": "api.permissions.scopes.list success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from apps.permissions.scopes.list method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "apps.permissions.scopes.list error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "apps.permissions.scopes", | |
| "apps" | |
| ] | |
| } | |
| }, | |
| "/apps.permissions.users.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Returns list of user grants and corresponding scopes this app has on a team.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/apps.permissions.users.list" | |
| }, | |
| "operationId": "apps_permissions_users_list", | |
| "parameters": [ | |
| { | |
| "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical successful paginated response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "resources": [ | |
| { | |
| "id": "U0DES3UAN", | |
| "scopes": [ | |
| "dnd:write:user", | |
| "reminders:write:user" | |
| ] | |
| }, | |
| { | |
| "id": "U024BFF1M", | |
| "scopes": [ | |
| "reminders:write:user" | |
| ] | |
| } | |
| ], | |
| "response_metadata": { | |
| "next_cursor": "dGVhbTdPMUg5UkFTT0w=" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_cursor", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "apps.permissions.users", | |
| "apps" | |
| ] | |
| } | |
| }, | |
| "/apps.permissions.users.request": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Enables an app to trigger a permissions modal to grant an app access to a user access scope.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/apps.permissions.users.request" | |
| }, | |
| "operationId": "apps_permissions_users_request", | |
| "parameters": [ | |
| { | |
| "description": "A comma separated list of user scopes to request for", | |
| "in": "query", | |
| "name": "scopes", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The user this scope is being requested for", | |
| "in": "query", | |
| "name": "user", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Token used to trigger the request", | |
| "in": "query", | |
| "name": "trigger_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Standard success response when used with a user token", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Standard failure response when trigger_id is invalid", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_trigger_id", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "apps.permissions.users", | |
| "apps" | |
| ] | |
| } | |
| }, | |
| "/apps.uninstall": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Uninstalls your app from a workspace.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/apps.uninstall" | |
| }, | |
| "operationId": "apps_uninstall", | |
| "parameters": [ | |
| { | |
| "description": "Issued when you created your application.", | |
| "in": "query", | |
| "name": "client_secret", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Issued when you created your application.", | |
| "in": "query", | |
| "name": "client_id", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from apps.uninstall method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "apps.uninstall schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from apps.uninstall method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "invalid_client_id", | |
| "bad_client_secret", | |
| "client_id_token_mismatch", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "apps.uninstall error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "apps" | |
| ] | |
| } | |
| }, | |
| "/auth.revoke": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Revokes a token.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/auth.revoke" | |
| }, | |
| "operationId": "auth_revoke", | |
| "parameters": [ | |
| { | |
| "description": "Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked.", | |
| "in": "query", | |
| "name": "test", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "revoked": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from auth.revoke method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "revoked": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "revoked" | |
| ], | |
| "title": "auth.revoke schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from auth.revoke method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "auth.revoke error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "auth" | |
| ] | |
| } | |
| }, | |
| "/auth.test": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Checks authentication & identity.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/auth.test" | |
| }, | |
| "operationId": "auth_test", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Standard success response when used with a user token", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "team": "Subarachnoid Workspace", | |
| "team_id": "T12345678", | |
| "url": "https://subarachnoid.slack.com/", | |
| "user": "grace", | |
| "user_id": "W12345678" | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response auth.test method", | |
| "properties": { | |
| "is_enterprise_install": { | |
| "type": "boolean" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "team": { | |
| "type": "string" | |
| }, | |
| "team_id": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "type": "string" | |
| }, | |
| "user_id": { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "url", | |
| "team", | |
| "user", | |
| "team_id", | |
| "user_id" | |
| ], | |
| "title": "auth.test success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Standard failure response when used with an invalid token", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response auth.test method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "not_authed", | |
| "invalid_auth", | |
| "token_revoked", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "auth.test error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "auth" | |
| ] | |
| } | |
| }, | |
| "/bots.info": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Gets information about a bot user.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/bots.info" | |
| }, | |
| "operationId": "bots_info", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `users:read`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Bot user to get info on", | |
| "in": "query", | |
| "name": "bot", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "When successful, returns bot info by bot ID.", | |
| "examples": { | |
| "application/json": { | |
| "bot": { | |
| "app_id": "A161CLERW", | |
| "deleted": false, | |
| "icons": { | |
| "image_36": "https://...", | |
| "image_48": "https://...", | |
| "image_72": "https://..." | |
| }, | |
| "id": "B061F7JD2", | |
| "name": "beforebot", | |
| "updated": 1449272004, | |
| "user_id": "U012ABCDEF" | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from bots.info method", | |
| "properties": { | |
| "bot": { | |
| "properties": { | |
| "app_id": { | |
| "$ref": "#/definitions/defs_app_id" | |
| }, | |
| "deleted": { | |
| "type": "boolean" | |
| }, | |
| "icons": { | |
| "properties": { | |
| "image_36": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_48": { | |
| "format": "uri", | |
| "type": "string" | |
| }, | |
| "image_72": { | |
| "format": "uri", | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "image_36", | |
| "image_48", | |
| "image_72" | |
| ], | |
| "type": "object" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_bot_id" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "updated": { | |
| "type": "integer" | |
| }, | |
| "user_id": { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "deleted", | |
| "name", | |
| "updated", | |
| "app_id", | |
| "icons" | |
| ], | |
| "type": "object" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "bot" | |
| ], | |
| "title": "bots.info schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "When no bot can be found, it returns an error.", | |
| "examples": { | |
| "application/json": { | |
| "error": "bot_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from bots.info method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "bot_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "bots.info error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "users:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "bots" | |
| ] | |
| } | |
| }, | |
| "/channels.archive": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Archives a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.archive" | |
| }, | |
| "operationId": "channels_archive", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel to archive", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from channels.archive method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "channels.archive success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response channels.archive method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "already_archived", | |
| "cant_archive_general", | |
| "restricted_action", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "team_added_to_org", | |
| "missing_charset", | |
| "superfluous_charset" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.archive error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.create": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Creates a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.create" | |
| }, | |
| "operationId": "channels_create", | |
| "parameters": [ | |
| { | |
| "description": "Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.", | |
| "in": "formData", | |
| "name": "validate", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Name of channel to create", | |
| "in": "formData", | |
| "name": "name", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response resulting in a new channel", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "created": 1502833204, | |
| "creator": "U061F7AUR", | |
| "id": "C0DEL09A5", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_general": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "last_read": "0000000000.000000", | |
| "latest": null, | |
| "members": [ | |
| "U061F7AUR" | |
| ], | |
| "name": "endeavor", | |
| "name_normalized": "endeavor", | |
| "previous_names": [], | |
| "purpose": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "" | |
| }, | |
| "topic": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "" | |
| }, | |
| "unread_count": 0, | |
| "unread_count_display": 0 | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response channels.create method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_channel" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "channels.create error schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Example error response when an invalid name is provided", | |
| "examples": { | |
| "application/json": { | |
| "detail": "Value passed for `name` contained unallowed special characters.", | |
| "error": "invalid_name_specials", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response channels.create method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "name_taken", | |
| "restricted_action", | |
| "no_channel", | |
| "invalid_name_required", | |
| "invalid_name_punctuation", | |
| "invalid_name_maxlength", | |
| "invalid_name_specials", | |
| "invalid_name", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "team_added_to_org", | |
| "missing_charset", | |
| "superfluous_charset" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.create error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.history": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Fetches history of messages and events from a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.history" | |
| }, | |
| "operationId": "channels_history", | |
| "parameters": [ | |
| { | |
| "description": "Number of messages to return, between 1 and 1000.", | |
| "in": "query", | |
| "name": "count", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Include `unread_count_display` in the output?", | |
| "in": "query", | |
| "name": "unreads", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Include messages with latest or oldest timestamp in results.", | |
| "in": "query", | |
| "name": "inclusive", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `channels:history`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Start of time range of messages to include in results.", | |
| "in": "query", | |
| "name": "oldest", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Channel to fetch history for.", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "End of time range of messages to include in results.", | |
| "in": "query", | |
| "name": "latest", | |
| "type": "number" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response containing the channel's history", | |
| "examples": { | |
| "application/json": { | |
| "has_more": false, | |
| "messages": [ | |
| { | |
| "text": "Hello", | |
| "ts": "1358546515.000008", | |
| "type": "message", | |
| "user": "U2147483896" | |
| }, | |
| { | |
| "is_starred": true, | |
| "reactions": [ | |
| { | |
| "count": 3, | |
| "name": "space_invader", | |
| "users": [ | |
| "U1", | |
| "U2", | |
| "U3" | |
| ] | |
| }, | |
| { | |
| "count": 5, | |
| "name": "sweet_potato", | |
| "users": [ | |
| "U1", | |
| "U2", | |
| "U3", | |
| "U4", | |
| "U5" | |
| ] | |
| } | |
| ], | |
| "text": "World", | |
| "ts": "1358546515.000007", | |
| "type": "message", | |
| "user": "U2147483896" | |
| }, | |
| { | |
| "ts": "1358546515.000007", | |
| "type": "something_else" | |
| }, | |
| { | |
| "attachments": [ | |
| { | |
| "fallback": "This is an attachment fallback", | |
| "id": 1, | |
| "text": "Don't get too attached" | |
| } | |
| ], | |
| "bot_id": "B19LU7CSY", | |
| "subtype": "bot_message", | |
| "text": "Containment unit is 98% full", | |
| "ts": "1503435956.000247", | |
| "type": "message", | |
| "username": "ecto1138" | |
| } | |
| ], | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response channels.history method", | |
| "properties": { | |
| "channel_actions_count": { | |
| "type": "integer" | |
| }, | |
| "channel_actions_ts": { | |
| "items": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "has_more": { | |
| "type": "boolean" | |
| }, | |
| "is_limited": { | |
| "type": "boolean" | |
| }, | |
| "messages": { | |
| "items": { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "messages", | |
| "has_more", | |
| "channel_actions_ts", | |
| "channel_actions_count" | |
| ], | |
| "title": "channels.history success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Error response when the specified channel cannot be found", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response channels.history method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "invalid_ts_latest", | |
| "invalid_ts_oldest", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.history error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:history" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.info": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Gets information about a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.info" | |
| }, | |
| "operationId": "channels_info", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `channels:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Set this to `true` to receive the locale for this channel. Defaults to `false`", | |
| "in": "query", | |
| "name": "include_locale", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Channel to get info on", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "created": 1466025154, | |
| "creator": "U0G9QF9C6", | |
| "id": "C1H9RESGL", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_general": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "last_read": "1503435939.000101", | |
| "latest": { | |
| "attachments": [ | |
| { | |
| "fallback": "This is an attachment fallback", | |
| "id": 1, | |
| "text": "Don't get too attached" | |
| } | |
| ], | |
| "bot_id": "B19LU7CSY", | |
| "subtype": "bot_message", | |
| "text": "Containment unit is 98% full", | |
| "ts": "1503435956.000247", | |
| "type": "message", | |
| "username": "ecto1138" | |
| }, | |
| "members": [ | |
| "U0G9QF9C6", | |
| "U1QNSQB9U" | |
| ], | |
| "name": "busting", | |
| "name_normalized": "busting", | |
| "previous_names": [ | |
| "dusting" | |
| ], | |
| "purpose": { | |
| "creator": "U0G9QF9C6", | |
| "last_set": 1503435128, | |
| "value": "Discuss busting ghosts" | |
| }, | |
| "topic": { | |
| "creator": "U0G9QF9C6", | |
| "last_set": 1503435128, | |
| "value": "Spiritual containment strategies" | |
| }, | |
| "unread_count": 1, | |
| "unread_count_display": 1 | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response channels.info method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_channel" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "channels.info success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Error response when the specified channel cannot be found", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response channels.info method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "team_added_to_org", | |
| "missing_charset", | |
| "superfluous_charset" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.info error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.invite": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Invites a user to a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.invite" | |
| }, | |
| "operationId": "channels_invite", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "User to invite to channel.", | |
| "in": "formData", | |
| "name": "user", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel to invite user to.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "created": 1466025154, | |
| "creator": "U0G9QF9C6", | |
| "id": "C1H9RESGL", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_general": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "last_read": "1503435963.000307", | |
| "latest": { | |
| "subtype": "channel_leave", | |
| "text": "<@U1QNSQB9U|protobot> has left the channel", | |
| "ts": "1503435963.000307", | |
| "type": "message", | |
| "user": "U1QNSQB9U" | |
| }, | |
| "members": [ | |
| "U0G9QF9C6", | |
| "U1QNSQB9U" | |
| ], | |
| "name": "busting", | |
| "name_normalized": "busting", | |
| "previous_names": [], | |
| "purpose": { | |
| "creator": "U0G9QF9C6", | |
| "last_set": 1503435128, | |
| "value": "My Purpose" | |
| }, | |
| "topic": { | |
| "creator": "U0G9QF9C6", | |
| "last_set": 1503435128, | |
| "value": "My Topic" | |
| }, | |
| "unread_count": 0, | |
| "unread_count_display": 0 | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response channels.invite method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_channel" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "channels.invite error schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "A somewhat typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "cant_invite", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response channels.invite method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "user_not_found", | |
| "cant_invite_self", | |
| "not_in_channel", | |
| "already_in_channel", | |
| "is_archived", | |
| "cant_invite", | |
| "too_many_users", | |
| "ura_max_channels", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "team_added_to_org", | |
| "missing_charset", | |
| "superfluous_charset" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.invite error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.join": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Joins a channel, creating it if needed.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.join" | |
| }, | |
| "operationId": "channels_join", | |
| "parameters": [ | |
| { | |
| "description": "Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.", | |
| "in": "formData", | |
| "name": "validate", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Name of channel to join", | |
| "in": "formData", | |
| "name": "name", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "already_in_channel": true, | |
| "channel": { | |
| "created": 1466025154, | |
| "creator": "U0G9QF9C6", | |
| "id": "C1H9RESGL", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_general": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "members": [ | |
| "U0G9QF9C6", | |
| "U1QNSQB9U" | |
| ], | |
| "name": "busting", | |
| "name_normalized": "busting", | |
| "previous_names": [], | |
| "purpose": { | |
| "creator": "U0G9QF9C6", | |
| "last_set": 1503435128, | |
| "value": "My Purpose" | |
| }, | |
| "topic": { | |
| "creator": "U0G9QF9C6", | |
| "last_set": 1503435128, | |
| "value": "My Topic" | |
| } | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from channels.join method", | |
| "properties": { | |
| "already_in_channel": { | |
| "type": "boolean" | |
| }, | |
| "channel": { | |
| "$ref": "#/definitions/objs_channel" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "channels.join schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from channels.join method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "name_taken", | |
| "restricted_action", | |
| "no_channel", | |
| "is_archived", | |
| "invalid_name_required", | |
| "invalid_name_punctuation", | |
| "invalid_name_maxlength", | |
| "invalid_name_specials", | |
| "invalid_name", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.join error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.kick": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Removes a user from a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.kick" | |
| }, | |
| "operationId": "channels_kick", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "User to remove from channel.", | |
| "in": "formData", | |
| "name": "user", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel to remove user from.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from channels.kick method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "channels.kick schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "not_in_channel", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from channels.kick method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "user_not_found", | |
| "cant_kick_self", | |
| "not_in_channel", | |
| "cant_kick_from_general", | |
| "restricted_action", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.kick error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.leave": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Leaves a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.leave" | |
| }, | |
| "operationId": "channels_leave", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel to leave", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from channels.leave method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "channels.leave schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from channels.leave method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "is_archived", | |
| "cant_leave_general", | |
| "cant_leave_mandatory_shared_channel", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.leave error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Lists all channels in a Slack team.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.list" | |
| }, | |
| "operationId": "channels_list", | |
| "parameters": [ | |
| { | |
| "description": "Exclude the `members` collection from each `channel`", | |
| "in": "query", | |
| "name": "exclude_members", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `channels:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Exclude archived channels from the list", | |
| "in": "query", | |
| "name": "exclude_archived", | |
| "type": "boolean" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical cursored success response", | |
| "examples": { | |
| "application/json": { | |
| "channels": [ | |
| { | |
| "created": 1449709280, | |
| "creator": "U0G9QF9C6", | |
| "id": "C0G9QF9GW", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_general": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "members": [ | |
| "U0G9QF9C6", | |
| "U0G9WFXNZ" | |
| ], | |
| "name": "random", | |
| "name_normalized": "random", | |
| "num_members": 2, | |
| "previous_names": [], | |
| "purpose": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels." | |
| }, | |
| "topic": { | |
| "creator": "U0G9QF9C6", | |
| "last_set": 1449709352, | |
| "value": "Other stuff" | |
| } | |
| }, | |
| { | |
| "created": 1449709280, | |
| "creator": "U0G9QF9C6", | |
| "id": "C0G9QKBBL", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_general": true, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "members": [ | |
| "U0G9QF9C6", | |
| "U0G9WFXNZ" | |
| ], | |
| "name": "general", | |
| "name_normalized": "general", | |
| "num_members": 2, | |
| "previous_names": [], | |
| "purpose": { | |
| "creator": "U0G9QF9C6", | |
| "last_set": 1449709334, | |
| "value": "To talk about anything!" | |
| }, | |
| "topic": { | |
| "creator": "U0G9QF9C6", | |
| "last_set": 1449709364, | |
| "value": "Talk about anything!" | |
| } | |
| } | |
| ], | |
| "ok": true, | |
| "response_metadata": { | |
| "next_cursor": "dGVhbTpDMUg5UkVTR0w=" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response channels.list method", | |
| "properties": { | |
| "channels": { | |
| "items": { | |
| "$ref": "#/definitions/objs_channel" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "response_metadata": { | |
| "$ref": "#/definitions/objs_response_metadata" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channels" | |
| ], | |
| "title": "channels.list success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response channels.list method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "limit_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.list error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.mark": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sets the read cursor in a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.mark" | |
| }, | |
| "operationId": "channels_mark", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Timestamp of the most recently seen message.", | |
| "in": "formData", | |
| "name": "ts", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Channel to set reading cursor in.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response channels.mark method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "channels.mark success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response channels.mark method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "invalid_timestamp", | |
| "not_in_channel", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.mark error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.rename": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Renames a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.rename" | |
| }, | |
| "operationId": "channels_rename", | |
| "parameters": [ | |
| { | |
| "description": "Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.", | |
| "in": "formData", | |
| "name": "validate", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "New name for channel.", | |
| "in": "formData", | |
| "name": "name", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel to rename", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "created": 1477445146, | |
| "creator": "U2U85N1RZ", | |
| "id": "C2U875RJN", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_general": false, | |
| "is_member": false, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "members": [], | |
| "name": "humans-and-bots", | |
| "name_normalized": "humans-and-bots", | |
| "previous_names": [ | |
| "humans" | |
| ], | |
| "purpose": { | |
| "creator": "U2U85N1RZ", | |
| "last_set": 1509475801, | |
| "value": "the purpose of this channel is to bring people and robots together in harmony" | |
| }, | |
| "topic": { | |
| "creator": "U2U85N1RZ", | |
| "last_set": 1509475775, | |
| "value": "here be robots" | |
| }, | |
| "unlinked": 0 | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from channels.rename method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_channel" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "channels.rename schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from channels.rename method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "not_in_channel", | |
| "not_authorized", | |
| "invalid_name", | |
| "name_taken", | |
| "invalid_name_required", | |
| "invalid_name_punctuation", | |
| "invalid_name_maxlength", | |
| "invalid_name_specials", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.rename error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.replies": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieve a thread of messages posted to a channel", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.replies" | |
| }, | |
| "operationId": "channels_replies", | |
| "parameters": [ | |
| { | |
| "description": "Unique identifier of a thread's parent message", | |
| "in": "query", | |
| "name": "thread_ts", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `channels:history`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel to fetch thread from", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "has_more": false, | |
| "messages": [ | |
| { | |
| "last_read": "1509484885.000082", | |
| "reply_count": 2, | |
| "subscribed": true, | |
| "text": "This is a channel message", | |
| "thread_ts": "1485913694.000025", | |
| "ts": "1485913694.000025", | |
| "type": "message", | |
| "unread_count": 0, | |
| "user": "U2X9P5FEL" | |
| }, | |
| { | |
| "parent_user_id": "U2X9P5FEL", | |
| "text": "This is a thread reply", | |
| "thread_ts": "1485913694.000025", | |
| "ts": "1509484424.000601", | |
| "type": "message", | |
| "user": "U2U85N1RZ" | |
| }, | |
| { | |
| "parent_user_id": "U2X9P5FEL", | |
| "text": "This is another thread reply", | |
| "thread_ts": "1485913694.000025", | |
| "ts": "1509484885.000082", | |
| "type": "message", | |
| "user": "U2U85N1RZ" | |
| } | |
| ], | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from channels.replies method", | |
| "properties": { | |
| "has_more": { | |
| "type": "boolean" | |
| }, | |
| "messages": { | |
| "items": { | |
| "items": [ | |
| { | |
| "properties": { | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest_reply": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "reply_count": { | |
| "type": "integer" | |
| }, | |
| "reply_users": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "reply_users_count": { | |
| "type": "integer" | |
| }, | |
| "source_team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "subscribed": { | |
| "type": "boolean" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "thread_ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "unread_count": { | |
| "type": "integer" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "user_profile": { | |
| "$ref": "#/definitions/objs_user_profile_short" | |
| }, | |
| "user_team": { | |
| "$ref": "#/definitions/defs_team" | |
| } | |
| }, | |
| "required": [ | |
| "type", | |
| "user", | |
| "text", | |
| "thread_ts", | |
| "reply_count", | |
| "subscribed", | |
| "ts" | |
| ], | |
| "type": "object" | |
| }, | |
| { | |
| "properties": { | |
| "is_starred": { | |
| "type": "boolean" | |
| }, | |
| "parent_user_id": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "source_team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "thread_ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "user_profile": { | |
| "$ref": "#/definitions/objs_user_profile_short" | |
| }, | |
| "user_team": { | |
| "$ref": "#/definitions/defs_team" | |
| } | |
| }, | |
| "required": [ | |
| "type", | |
| "user", | |
| "text", | |
| "thread_ts", | |
| "parent_user_id", | |
| "ts" | |
| ], | |
| "type": "object" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "messages", | |
| "has_more" | |
| ], | |
| "title": "channels.replies schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "thread_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from channels.replies method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "thread_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.replies error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:history" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.setPurpose": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sets the purpose for a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.setPurpose" | |
| }, | |
| "operationId": "channels_setPurpose", | |
| "parameters": [ | |
| { | |
| "description": "if it is true, treat this like a message and not an unescaped thing", | |
| "in": "formData", | |
| "name": "name_tagging", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The new purpose", | |
| "in": "formData", | |
| "name": "purpose", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel to set the purpose of", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "purpose": "My special purpose" | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from channels.setPurpose method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "purpose": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "purpose" | |
| ], | |
| "title": "channels.setPurpose schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from channels.setPurpose method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "not_in_channel", | |
| "is_archived", | |
| "too_long", | |
| "user_is_restricted", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.setPurpose error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.setTopic": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sets the topic for a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.setTopic" | |
| }, | |
| "operationId": "channels_setTopic", | |
| "parameters": [ | |
| { | |
| "description": "The new topic", | |
| "in": "formData", | |
| "name": "topic", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel to set the topic of", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "topic": "To picture topicality" | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from channels.setTopic method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "topic": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "topic", | |
| "ok" | |
| ], | |
| "title": "channels.setTopic schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from channels.setTopic method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "not_in_channel", | |
| "is_archived", | |
| "too_long", | |
| "user_is_restricted", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.setTopic error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/channels.unarchive": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Unarchives a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/channels.unarchive" | |
| }, | |
| "operationId": "channels_unarchive", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel to unarchive", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from channels.unarchive method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "channels.unarchive schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from channels.unarchive method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "not_archived", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "channels.unarchive error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "channels" | |
| ] | |
| } | |
| }, | |
| "/chat.delete": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Deletes a message.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/chat.delete" | |
| }, | |
| "operationId": "chat_delete", | |
| "parameters": [ | |
| { | |
| "description": "Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope.", | |
| "in": "formData", | |
| "name": "as_user", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `chat:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Timestamp of the message to be deleted.", | |
| "in": "formData", | |
| "name": "ts", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Channel containing the message to be deleted.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": "C024BE91L", | |
| "ok": true, | |
| "ts": "1401383885.000061" | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response of chat.delete method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel", | |
| "ts" | |
| ], | |
| "title": "chat.delete success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "message_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from chat.delete method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "message_not_found", | |
| "channel_not_found", | |
| "cant_delete_message", | |
| "compliance_exports_prevent_deletion", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "chat.delete error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "chat:write:user", | |
| "chat:write:bot" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "chat" | |
| ] | |
| } | |
| }, | |
| "/chat.deleteScheduledMessage": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Deletes a pending scheduled message from the queue.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/chat.deleteScheduledMessage" | |
| }, | |
| "operationId": "chat_deleteScheduledMessage", | |
| "parameters": [ | |
| { | |
| "description": "Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope.", | |
| "in": "formData", | |
| "name": "as_user", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `chat:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The channel the scheduled_message is posting to", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "`scheduled_message_id` returned from call to chat.scheduleMessage", | |
| "in": "formData", | |
| "name": "scheduled_message_id", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from chat.deleteScheduledMessage method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "chat.deleteScheduledMessage schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response if no message is found", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_scheduled_message_id", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from chat.deleteScheduledMessage method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "invalid_scheduled_message_id", | |
| "channel_not_found", | |
| "bad_token", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "ekm_access_denied", | |
| "missing_scope", | |
| "invalid_arguments", | |
| "invalid_arg_name", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "chat.deleteScheduledMessage error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "chat:write:user", | |
| "chat:write:bot" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "chat" | |
| ] | |
| } | |
| }, | |
| "/chat.getPermalink": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieve a permalink URL for a specific extant message", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/chat.getPermalink" | |
| }, | |
| "operationId": "chat_getPermalink", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "A message's `ts` value, uniquely identifying it within a channel", | |
| "in": "query", | |
| "name": "message_ts", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID of the conversation or channel containing the message", | |
| "in": "query", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Standard success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": "C1H9RESGA", | |
| "ok": true, | |
| "permalink": "https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008" | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response chat.getPermalink", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "permalink": { | |
| "format": "uri", | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel", | |
| "permalink" | |
| ], | |
| "title": "chat.getPermalink success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Error response when channel cannot be found", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from chat.getPermalink method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "message_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "chat.getPermalink error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "chat" | |
| ] | |
| } | |
| }, | |
| "/chat.meMessage": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Share a me message into a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/chat.meMessage" | |
| }, | |
| "operationId": "chat_meMessage", | |
| "parameters": [ | |
| { | |
| "description": "Text of the message to send.", | |
| "in": "formData", | |
| "name": "text", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `chat:write:user`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": "C024BE7LR", | |
| "ok": true, | |
| "ts": "1417671948.000006" | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from chat.meMessage method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "chat.meMessage schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from chat.meMessage method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "not_in_channel", | |
| "is_archived", | |
| "msg_too_long", | |
| "no_text", | |
| "rate_limited", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "chat.meMessage error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "chat:write:user" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "chat" | |
| ] | |
| } | |
| }, | |
| "/chat.postEphemeral": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sends an ephemeral message to a user in a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/chat.postEphemeral" | |
| }, | |
| "operationId": "chat_postEphemeral", | |
| "parameters": [ | |
| { | |
| "description": "Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", | |
| "in": "formData", | |
| "name": "username", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Provide another message's `ts` value to post this message in a thread. Avoid using a reply's `ts` value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.", | |
| "in": "formData", | |
| "name": "thread_ts", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", | |
| "in": "formData", | |
| "name": "blocks", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", | |
| "in": "formData", | |
| "name": "attachments", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.", | |
| "in": "formData", | |
| "name": "as_user", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Find and link channel names and usernames.", | |
| "in": "formData", | |
| "name": "link_names", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Change how messages are treated. Defaults to `none`. See [below](#formatting).", | |
| "in": "formData", | |
| "name": "parse", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `chat:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.", | |
| "in": "formData", | |
| "name": "text", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.", | |
| "in": "formData", | |
| "name": "user", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below.", | |
| "in": "formData", | |
| "name": "icon_emoji", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", | |
| "in": "formData", | |
| "name": "icon_url", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "message_ts": "1502210682.580145", | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from chat.postEphemeral method", | |
| "properties": { | |
| "message_ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "message_ts" | |
| ], | |
| "title": "chat.postEphemeral success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "user_not_in_channel", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from chat.postEphemeral method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "is_archived", | |
| "msg_too_long", | |
| "no_text", | |
| "restricted_action", | |
| "too_many_attachments", | |
| "user_not_in_channel", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "chat.postEphemeral error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "chat:write:user", | |
| "chat:write:bot" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "chat" | |
| ] | |
| } | |
| }, | |
| "/chat.postMessage": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sends a message to a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/chat.postMessage" | |
| }, | |
| "operationId": "chat_postMessage", | |
| "parameters": [ | |
| { | |
| "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", | |
| "in": "formData", | |
| "name": "attachments", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Pass true to enable unfurling of primarily text-based content.", | |
| "in": "formData", | |
| "name": "unfurl_links", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.", | |
| "in": "formData", | |
| "name": "text", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Pass false to disable unfurling of media content.", | |
| "in": "formData", | |
| "name": "unfurl_media", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Change how messages are treated. Defaults to `none`. See [below](#formatting).", | |
| "in": "formData", | |
| "name": "parse", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.", | |
| "in": "formData", | |
| "name": "as_user", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Disable Slack markup parsing by setting to `false`. Enabled by default.", | |
| "in": "formData", | |
| "name": "mrkdwn", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", | |
| "in": "formData", | |
| "name": "blocks", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below.", | |
| "in": "formData", | |
| "name": "icon_emoji", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Find and link channel names and usernames.", | |
| "in": "formData", | |
| "name": "link_names", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.", | |
| "in": "formData", | |
| "name": "reply_broadcast", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.", | |
| "in": "formData", | |
| "name": "thread_ts", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", | |
| "in": "formData", | |
| "name": "username", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `chat:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", | |
| "in": "formData", | |
| "name": "icon_url", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": "C1H9RESGL", | |
| "message": { | |
| "attachments": [ | |
| { | |
| "fallback": "This is an attachment's fallback", | |
| "id": 1, | |
| "text": "This is an attachment" | |
| } | |
| ], | |
| "bot_id": "B19LU7CSY", | |
| "subtype": "bot_message", | |
| "text": "Here's a message for you", | |
| "ts": "1503435956.000247", | |
| "type": "message", | |
| "username": "ecto1" | |
| }, | |
| "ok": true, | |
| "ts": "1503435956.000247" | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response of chat.postMessage method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| "message": { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel", | |
| "ts", | |
| "message" | |
| ], | |
| "title": "chat.postMessage success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response if too many attachments are included", | |
| "examples": { | |
| "application/json": { | |
| "error": "too_many_attachments", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response chat.postMessage method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "not_in_channel", | |
| "is_archived", | |
| "msg_too_long", | |
| "no_text", | |
| "too_many_attachments", | |
| "rate_limited", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "chat.postMessage error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "chat:write:user", | |
| "chat:write:bot" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "chat" | |
| ] | |
| } | |
| }, | |
| "/chat.scheduleMessage": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Schedules a message to be sent to a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/chat.scheduleMessage" | |
| }, | |
| "operationId": "chat_scheduleMessage", | |
| "parameters": [ | |
| { | |
| "description": "Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.", | |
| "in": "formData", | |
| "name": "thread_ts", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", | |
| "in": "formData", | |
| "name": "blocks", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", | |
| "in": "formData", | |
| "name": "attachments", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Pass true to enable unfurling of primarily text-based content.", | |
| "in": "formData", | |
| "name": "unfurl_links", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.", | |
| "in": "formData", | |
| "name": "text", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Find and link channel names and usernames.", | |
| "in": "formData", | |
| "name": "link_names", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Pass false to disable unfurling of media content.", | |
| "in": "formData", | |
| "name": "unfurl_media", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Change how messages are treated. Defaults to `none`. See [chat.postMessage](chat.postMessage#formatting).", | |
| "in": "formData", | |
| "name": "parse", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `chat:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [chat.postMessage](chat.postMessage#authorship).", | |
| "in": "formData", | |
| "name": "as_user", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Unix EPOCH timestamp of time in future to send the message.", | |
| "in": "formData", | |
| "name": "post_at", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.", | |
| "in": "formData", | |
| "name": "reply_broadcast", | |
| "type": "boolean" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": "C1H9RESGL", | |
| "message": { | |
| "attachments": [ | |
| { | |
| "fallback": "This is an attachment's fallback", | |
| "id": 1, | |
| "text": "This is an attachment" | |
| } | |
| ], | |
| "bot_id": "B19LU7CSY", | |
| "subtype": "bot_message", | |
| "text": "Here's a message for you in the future", | |
| "type": "delayed_message", | |
| "username": "ecto1" | |
| }, | |
| "ok": true, | |
| "post_at": "1562180400", | |
| "scheduled_message_id": "Q1298393284" | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response of chat.scheduleMessage method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/defs_channel" | |
| }, | |
| "message": { | |
| "properties": { | |
| "bot_id": { | |
| "$ref": "#/definitions/defs_bot_id" | |
| }, | |
| "bot_profile": { | |
| "$ref": "#/definitions/objs_bot_profile" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "username": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "type", | |
| "text", | |
| "bot_id", | |
| "user", | |
| "team" | |
| ], | |
| "type": "object" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "post_at": { | |
| "pattern": "^\\d{10}$", | |
| "type": "integer" | |
| }, | |
| "scheduled_message_id": { | |
| "pattern": "^[Q][A-Z0-9]{8,}$", | |
| "title": "Scheduled Message ID", | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel", | |
| "post_at", | |
| "scheduled_message_id", | |
| "message" | |
| ], | |
| "title": "chat.scheduleMessage success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response if the `post_at` is invalid (ex. in the past or too far into the future)", | |
| "examples": { | |
| "application/json": { | |
| "error": "time_in_past", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response chat.scheduleMessage method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "invalid_time", | |
| "time_in_past", | |
| "time_too_far", | |
| "channel_not_found", | |
| "not_in_channel", | |
| "is_archived", | |
| "msg_too_long", | |
| "no_text", | |
| "restricted_action", | |
| "restricted_action_read_only_channel", | |
| "restricted_action_thread_only_channel", | |
| "restricted_action_non_threadable_channel", | |
| "too_many_attachments", | |
| "rate_limited", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "ekm_access_denied", | |
| "missing_scope", | |
| "invalid_arguments", | |
| "invalid_arg_name", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "chat.scheduleMessage error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "chat:write:user", | |
| "chat:write:bot" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "chat" | |
| ] | |
| } | |
| }, | |
| "/chat.scheduledMessages.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Returns a list of scheduled messages.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/chat.scheduledMessages.list" | |
| }, | |
| "operationId": "chat_scheduledMessages_list", | |
| "parameters": [ | |
| { | |
| "description": "For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Maximum number of original entries to return.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "A UNIX timestamp of the oldest value in the time range", | |
| "in": "query", | |
| "name": "oldest", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "The channel of the scheduled messages", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "A UNIX timestamp of the latest value in the time range", | |
| "in": "query", | |
| "name": "latest", | |
| "type": "number" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "response_metadata": { | |
| "next_cursor": "" | |
| }, | |
| "scheduled_messages": [ | |
| { | |
| "channel_id": "C1H9RESGL", | |
| "date_created": 1551891734, | |
| "id": 1298393284, | |
| "post_at": 1551991428, | |
| "text": "Here's a message for you in the future" | |
| } | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from chat.scheduledMessages.list method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "response_metadata": { | |
| "properties": { | |
| "next_cursor": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "next_cursor" | |
| ], | |
| "type": "object" | |
| }, | |
| "scheduled_messages": { | |
| "items": { | |
| "properties": { | |
| "channel_id": { | |
| "$ref": "#/definitions/defs_channel_id" | |
| }, | |
| "date_created": { | |
| "pattern": "^\\d{10}$", | |
| "type": "integer" | |
| }, | |
| "id": { | |
| "pattern": "^[Q][A-Z0-9]{8,}$", | |
| "type": "string" | |
| }, | |
| "post_at": { | |
| "pattern": "^\\d{10}$", | |
| "type": "integer" | |
| }, | |
| "text": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "channel_id", | |
| "post_at", | |
| "date_created" | |
| ], | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "scheduled_messages", | |
| "response_metadata" | |
| ], | |
| "title": "chat.scheduledMessages.list schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response if the channel passed is invalid", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_channel", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from chat.scheduledMessages.list method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "invalid_channel", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "ekm_access_denied", | |
| "missing_scope", | |
| "invalid_arguments", | |
| "invalid_arg_name", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "chat.scheduledMessages.list error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "chat.scheduledMessages", | |
| "chat" | |
| ] | |
| } | |
| }, | |
| "/chat.unfurl": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Provide custom unfurl behavior for user-posted URLs", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/chat.unfurl" | |
| }, | |
| "operationId": "chat_unfurl", | |
| "parameters": [ | |
| { | |
| "description": "Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior", | |
| "in": "formData", | |
| "name": "user_auth_message", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain", | |
| "in": "formData", | |
| "name": "user_auth_required", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.", | |
| "in": "formData", | |
| "name": "unfurls", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Timestamp of the message to add unfurl behavior to.", | |
| "in": "formData", | |
| "name": "ts", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.", | |
| "in": "formData", | |
| "name": "user_auth_url", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `links:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel ID of the message", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical, minimal success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from chat.unfurl method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "chat.unfurl success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "cannot_unfurl_url", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from chat.unfurl method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "cannot_unfurl_url", | |
| "cannot_find_service", | |
| "missing_unfurls", | |
| "cannot_prompt", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "chat.unfurl error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "links:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "chat" | |
| ] | |
| } | |
| }, | |
| "/chat.update": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Updates a message.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/chat.update" | |
| }, | |
| "operationId": "chat_update", | |
| "parameters": [ | |
| { | |
| "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", | |
| "in": "formData", | |
| "name": "blocks", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting `text`.", | |
| "in": "formData", | |
| "name": "attachments", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users.", | |
| "in": "formData", | |
| "name": "as_user", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Timestamp of the message to be updated.", | |
| "in": "formData", | |
| "name": "ts", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. Accepts either `none` or `full`. See [below](#formatting).", | |
| "in": "formData", | |
| "name": "parse", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `chat:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "New text for the message, using the [default formatting rules](/docs/formatting). It's not required when presenting `attachments`.", | |
| "in": "formData", | |
| "name": "text", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Find and link channel names and usernames. Defaults to `none`. See [below](#formatting).", | |
| "in": "formData", | |
| "name": "link_names", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Channel containing the message to be updated.", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": "C024BE91L", | |
| "message": { | |
| "text": "Updated text you carefully authored", | |
| "user": "U34567890" | |
| }, | |
| "ok": true, | |
| "text": "Updated text you carefully authored", | |
| "ts": "1401383885.000061" | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response of chat.update method", | |
| "properties": { | |
| "channel": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "properties": { | |
| "attachments": { | |
| "items": { | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| }, | |
| "blocks": { | |
| "$ref": "#/definitions/blocks" | |
| }, | |
| "text": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "text" | |
| ], | |
| "title": "Message object", | |
| "type": "object" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "ts": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel", | |
| "ts", | |
| "text", | |
| "message" | |
| ], | |
| "title": "chat.update success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "cant_update_message", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response chat.update method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "message_not_found", | |
| "cant_update_message", | |
| "channel_not_found", | |
| "edit_window_closed", | |
| "msg_too_long", | |
| "too_many_attachments", | |
| "rate_limited", | |
| "no_text", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "request_timeout", | |
| "invalid_json", | |
| "json_not_object", | |
| "upgrade_required", | |
| "fatal_error", | |
| "is_inactive" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "chat.update error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "chat:write:user", | |
| "chat:write:bot" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "chat" | |
| ] | |
| } | |
| }, | |
| "/conversations.archive": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Archives a conversation.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.archive" | |
| }, | |
| "operationId": "conversations_archive", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID of conversation to archive", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response conversations.archive method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "conversations.archive success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.archive method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "missing_scope", | |
| "not_supported", | |
| "channel_not_found", | |
| "already_archived", | |
| "cant_archive_general", | |
| "restricted_action", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "team_added_to_org", | |
| "missing_charset", | |
| "superfluous_charset" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.archive error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.close": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Closes a direct message or multi-person direct message.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.close" | |
| }, | |
| "operationId": "conversations_close", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Conversation to close.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response conversations.close method", | |
| "properties": { | |
| "already_closed": { | |
| "type": "boolean" | |
| }, | |
| "no_op": { | |
| "type": "boolean" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "conversations.close success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.close method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "channel_not_found", | |
| "user_does_not_own_channel", | |
| "missing_scope", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.close error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.create": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Initiates a public or private channel-based conversation", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.create" | |
| }, | |
| "operationId": "conversations_create", | |
| "parameters": [ | |
| { | |
| "description": "Name of the public or private channel to create", | |
| "in": "formData", | |
| "name": "name", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "**Required** for workspace apps. A list of between 1 and 30 human users that will be added to the newly-created conversation. This argument has no effect when used by classic Slack apps.", | |
| "in": "formData", | |
| "name": "user_ids", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Create a private channel instead of a public one", | |
| "in": "formData", | |
| "name": "is_private", | |
| "type": "boolean" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "If successful, the command returns a rather stark [conversation object](/types/conversation)", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "created": 1504554479, | |
| "creator": "U0123456", | |
| "id": "C0EAQDV4Z", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_ext_shared": false, | |
| "is_general": false, | |
| "is_group": false, | |
| "is_im": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_pending_ext_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "last_read": "0000000000.000000", | |
| "latest": null, | |
| "name": "endeavor", | |
| "name_normalized": "endeavor", | |
| "pending_shared": [], | |
| "previous_names": [], | |
| "priority": 0, | |
| "purpose": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "" | |
| }, | |
| "topic": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "" | |
| }, | |
| "unlinked": 0, | |
| "unread_count": 0, | |
| "unread_count_display": 0 | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response conversations.create method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_conversation" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "conversations.create success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response when name already in use", | |
| "examples": { | |
| "application/json": { | |
| "error": "name_taken", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.create method", | |
| "properties": { | |
| "detail": { | |
| "type": "string" | |
| }, | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "missing_scope", | |
| "name_taken", | |
| "restricted_action", | |
| "no_channel", | |
| "invalid_name_required", | |
| "invalid_name_punctuation", | |
| "invalid_name_maxlength", | |
| "invalid_name_specials", | |
| "invalid_name", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.create error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.history": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Fetches a conversation's history of messages and events.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.history" | |
| }, | |
| "operationId": "conversations_history", | |
| "parameters": [ | |
| { | |
| "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", | |
| "in": "query", | |
| "name": "inclusive", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:history`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Start of time range of messages to include in results.", | |
| "in": "query", | |
| "name": "oldest", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Conversation ID to fetch history for.", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "End of time range of messages to include in results.", | |
| "in": "query", | |
| "name": "latest", | |
| "type": "number" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response containing a channel's messages", | |
| "examples": { | |
| "application/json": { | |
| "has_more": true, | |
| "messages": [ | |
| { | |
| "text": "I find you punny and would like to smell your nose letter", | |
| "ts": "1512085950.000216", | |
| "type": "message", | |
| "user": "U012AB3CDE" | |
| }, | |
| { | |
| "text": "What, you want to smell my shoes better?", | |
| "ts": "1512104434.000490", | |
| "type": "message", | |
| "user": "U061F7AUR" | |
| } | |
| ], | |
| "ok": true, | |
| "pin_count": 0, | |
| "response_metadata": { | |
| "next_cursor": "bmV4dF90czoxNTEyMDg1ODYxMDAwNTQz" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.history method", | |
| "properties": { | |
| "channel_actions_count": { | |
| "type": "integer" | |
| }, | |
| "channel_actions_ts": { | |
| "items": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "has_more": { | |
| "type": "boolean" | |
| }, | |
| "messages": { | |
| "items": { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "pin_count": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "messages", | |
| "has_more", | |
| "pin_count", | |
| "channel_actions_ts", | |
| "channel_actions_count" | |
| ], | |
| "title": "conversations.history success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.history method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "missing_scope", | |
| "channel_not_found", | |
| "invalid_ts_latest", | |
| "invalid_ts_oldest", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.history error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:history", | |
| "groups:history", | |
| "im:history", | |
| "mpim:history" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.info": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieve information about a conversation.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.info" | |
| }, | |
| "operationId": "conversations_info", | |
| "parameters": [ | |
| { | |
| "description": "Set to `true` to include the member count for the specified conversation. Defaults to `false`", | |
| "in": "query", | |
| "name": "include_num_members", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Conversation ID to learn more about", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Set this to `true` to receive the locale for this conversation. Defaults to `false`", | |
| "in": "query", | |
| "name": "include_locale", | |
| "type": "boolean" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response for a public channel. (Also, a response from a private channel and a multi-party IM is very similar to this example.)", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "created": 1449252889, | |
| "creator": "W012A3BCD", | |
| "id": "C012AB3CD", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_ext_shared": false, | |
| "is_general": true, | |
| "is_group": false, | |
| "is_im": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_pending_ext_shared": false, | |
| "is_private": false, | |
| "is_read_only": false, | |
| "is_shared": false, | |
| "last_read": "1502126650.228446", | |
| "locale": "en-US", | |
| "name": "general", | |
| "name_normalized": "general", | |
| "parent_conversation": null, | |
| "pending_shared": [], | |
| "previous_names": [ | |
| "specifics", | |
| "abstractions", | |
| "etc" | |
| ], | |
| "purpose": { | |
| "creator": "W012A3BCD", | |
| "last_set": 1449709364, | |
| "value": "This part of the workspace is for fun. Make fun here." | |
| }, | |
| "topic": { | |
| "creator": "W012A3BCD", | |
| "last_set": 1449709364, | |
| "value": "For public discussion of generalities" | |
| }, | |
| "unlinked": 0 | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response conversations.info", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_conversation" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "conversations.info success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response when a channel cannot be found", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.info method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "missing_scope", | |
| "channel_not_found", | |
| "team_added_to_org", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.info error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:read", | |
| "groups:read", | |
| "im:read", | |
| "mpim:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.invite": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Invites users to a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.invite" | |
| }, | |
| "operationId": "conversations_invite", | |
| "parameters": [ | |
| { | |
| "description": "A comma separated list of user IDs. Up to 1000 users may be listed.", | |
| "in": "formData", | |
| "name": "users", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The ID of the public or private channel to invite user(s) to.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response when an invitation is extended", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "created": 1449252889, | |
| "creator": "W012A3BCD", | |
| "id": "C012AB3CD", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_ext_shared": false, | |
| "is_general": true, | |
| "is_group": false, | |
| "is_im": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_pending_ext_shared": false, | |
| "is_private": false, | |
| "is_read_only": false, | |
| "is_shared": false, | |
| "last_read": "1502126650.228446", | |
| "locale": "en-US", | |
| "name": "general", | |
| "name_normalized": "general", | |
| "num_members": 23, | |
| "pending_shared": [], | |
| "previous_names": [ | |
| "specifics", | |
| "abstractions", | |
| "etc" | |
| ], | |
| "purpose": { | |
| "creator": "W012A3BCD", | |
| "last_set": 1449709364, | |
| "value": "This part of the workspace is for fun. Make fun here." | |
| }, | |
| "topic": { | |
| "creator": "W012A3BCD", | |
| "last_set": 1449709364, | |
| "value": "For public discussion of generalities" | |
| }, | |
| "unlinked": 0 | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.invite method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_conversation" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "conversations.invite error schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response when an invite is attempted on a conversation type that does not support it", | |
| "examples": { | |
| "application/json": { | |
| "error": "method_not_supported_for_channel_type", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.invite method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "missing_scope", | |
| "channel_not_found", | |
| "user_not_found", | |
| "no_user", | |
| "cant_invite_self", | |
| "not_in_channel", | |
| "already_in_channel", | |
| "is_archived", | |
| "cant_invite", | |
| "too_many_users", | |
| "ura_max_channels", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "team_added_to_org", | |
| "missing_charset", | |
| "superfluous_charset" | |
| ], | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "items": { | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "missing_scope", | |
| "channel_not_found", | |
| "user_not_found", | |
| "no_user", | |
| "cant_invite_self", | |
| "not_in_channel", | |
| "already_in_channel", | |
| "is_archived", | |
| "cant_invite", | |
| "too_many_users", | |
| "ura_max_channels", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "team_added_to_org", | |
| "missing_charset", | |
| "superfluous_charset" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "type": "object" | |
| }, | |
| "minItems": 1, | |
| "title": "errors is returned when an error associates an user", | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "conversations.invite error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.join": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Joins an existing conversation.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.join" | |
| }, | |
| "operationId": "conversations_join", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `channels:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID of conversation to join", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "created": 1449252889, | |
| "creator": "U061F7AUR", | |
| "id": "C061EG9SL", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_ext_shared": false, | |
| "is_general": true, | |
| "is_group": false, | |
| "is_im": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_pending_ext_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "name": "general", | |
| "name_normalized": "general", | |
| "pending_shared": [], | |
| "previous_names": [], | |
| "purpose": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "For widget discussion" | |
| }, | |
| "topic": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "Which widget do you worry about?" | |
| }, | |
| "unlinked": 0 | |
| }, | |
| "ok": true, | |
| "response_metadata": { | |
| "warnings": [ | |
| "already_in_channel" | |
| ] | |
| }, | |
| "warning": "already_in_channel" | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.join method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_conversation" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "response_metadata": { | |
| "properties": { | |
| "warnings": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| } | |
| }, | |
| "title": "Response metadata", | |
| "type": "object" | |
| }, | |
| "warning": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "conversations.join success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response if the conversation is archived and cannot be joined", | |
| "examples": { | |
| "application/json": { | |
| "error": "is_archived", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.join method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "missing_scope", | |
| "channel_not_found", | |
| "is_archived", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "team_added_to_org", | |
| "missing_charset", | |
| "superfluous_charset" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.join error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.kick": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Removes a user from a conversation.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.kick" | |
| }, | |
| "operationId": "conversations_kick", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "User ID to be removed.", | |
| "in": "formData", | |
| "name": "user", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID of conversation to remove user from.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response conversations.kick method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "conversations.kick success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response when you attempt to kick yourself from a channel", | |
| "examples": { | |
| "application/json": { | |
| "error": "cant_kick_self", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response conversations.kick method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "missing_scope", | |
| "channel_not_found", | |
| "user_not_found", | |
| "cant_kick_self", | |
| "not_in_channel", | |
| "cant_kick_from_general", | |
| "restricted_action", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.kick error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.leave": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Leaves a conversation.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.leave" | |
| }, | |
| "operationId": "conversations_leave", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Conversation to leave", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.leave method", | |
| "properties": { | |
| "not_in_channel": { | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "conversations.leave success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response when attempting to leave a workspace's \"general\" channel", | |
| "examples": { | |
| "application/json": { | |
| "error": "cant_leave_general", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.leave method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "last_member", | |
| "missing_scope", | |
| "channel_not_found", | |
| "is_archived", | |
| "cant_leave_general", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "team_added_to_org", | |
| "missing_charset", | |
| "superfluous_charset" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.leave error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Lists all channels in a Slack team.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.list" | |
| }, | |
| "operationId": "conversations_list", | |
| "parameters": [ | |
| { | |
| "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Set to `true` to exclude archived channels from the list", | |
| "in": "query", | |
| "name": "exclude_archived", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", | |
| "in": "query", | |
| "name": "types", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response with only public channels", | |
| "examples": { | |
| "application/json": { | |
| "channels": [ | |
| { | |
| "created": 1449252889, | |
| "creator": "U012A3CDE", | |
| "id": "C012AB3CD", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_ext_shared": false, | |
| "is_general": true, | |
| "is_group": false, | |
| "is_im": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_pending_ext_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "name": "general", | |
| "name_normalized": "general", | |
| "num_members": 4, | |
| "pending_shared": [], | |
| "previous_names": [], | |
| "purpose": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "This channel is for team-wide communication and announcements. All team members are in this channel." | |
| }, | |
| "topic": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "Company-wide announcements and work-based matters" | |
| }, | |
| "unlinked": 0 | |
| }, | |
| { | |
| "created": 1449252889, | |
| "creator": "U061F7AUR", | |
| "id": "C061EG9T2", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_ext_shared": false, | |
| "is_general": false, | |
| "is_group": false, | |
| "is_im": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_pending_ext_shared": false, | |
| "is_private": false, | |
| "is_shared": false, | |
| "name": "random", | |
| "name_normalized": "random", | |
| "num_members": 4, | |
| "pending_shared": [], | |
| "previous_names": [], | |
| "purpose": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels." | |
| }, | |
| "topic": { | |
| "creator": "", | |
| "last_set": 0, | |
| "value": "Non-work banter and water cooler conversation" | |
| }, | |
| "unlinked": 0 | |
| } | |
| ], | |
| "ok": true, | |
| "response_metadata": { | |
| "next_cursor": "dGVhbTpDMDYxRkE1UEI=" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.list method", | |
| "properties": { | |
| "channels": { | |
| "items": { | |
| "$ref": "#/definitions/objs_conversation" | |
| }, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "response_metadata": { | |
| "properties": { | |
| "next_cursor": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "next_cursor" | |
| ], | |
| "type": "object" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channels" | |
| ], | |
| "title": "conversations.list success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.list method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "missing_scope", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.list error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:read", | |
| "groups:read", | |
| "im:read", | |
| "mpim:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.members": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieve members of a conversation.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.members" | |
| }, | |
| "operationId": "conversations_members", | |
| "parameters": [ | |
| { | |
| "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "ID of the conversation to retrieve members for", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical paginated success response", | |
| "examples": { | |
| "application/json": { | |
| "members": [ | |
| "U023BECGF", | |
| "U061F7AUR", | |
| "W012A3CDE" | |
| ], | |
| "ok": true, | |
| "response_metadata": { | |
| "next_cursor": "e3VzZXJfaWQ6IFcxMjM0NTY3fQ==" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response conversations.members method", | |
| "properties": { | |
| "members": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "response_metadata": { | |
| "properties": { | |
| "next_cursor": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "next_cursor" | |
| ], | |
| "type": "object" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "members", | |
| "response_metadata" | |
| ], | |
| "title": "conversations.members success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response when an invalid cursor is provided", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_cursor", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response conversations.members method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "invalid_limit", | |
| "invalid_cursor", | |
| "fetch_members_failed", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.members error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:read", | |
| "groups:read", | |
| "im:read", | |
| "mpim:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.open": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Opens or resumes a direct message or multi-person direct message.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.open" | |
| }, | |
| "operationId": "conversations_open", | |
| "parameters": [ | |
| { | |
| "description": "Boolean, indicates you want the full IM channel definition in the response.", | |
| "in": "formData", | |
| "name": "return_im", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`.", | |
| "in": "formData", | |
| "name": "users", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "id": "D069C7QFK" | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.open method when opening channels, ims, mpims", | |
| "properties": { | |
| "already_open": { | |
| "type": "boolean" | |
| }, | |
| "channel": { | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/objs_conversation" | |
| }, | |
| { | |
| "properties": { | |
| "created": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_dm_id" | |
| }, | |
| "is_im": { | |
| "type": "boolean" | |
| }, | |
| "is_open": { | |
| "type": "boolean" | |
| }, | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest": { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| "unread_count": { | |
| "type": "number" | |
| }, | |
| "unread_count_display": { | |
| "type": "number" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| }, | |
| "required": [ | |
| "id" | |
| ], | |
| "type": "object" | |
| } | |
| ] | |
| }, | |
| "no_op": { | |
| "type": "boolean" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "conversations.open success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.open method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "user_not_found", | |
| "user_not_visible", | |
| "user_disabled", | |
| "users_list_not_supplied", | |
| "not_enough_users", | |
| "too_many_users", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "channel_not_found" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.open error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.rename": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Renames a conversation.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.rename" | |
| }, | |
| "operationId": "conversations_rename", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "New name for conversation.", | |
| "in": "formData", | |
| "name": "name", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID of conversation to rename", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "created": 1449252889, | |
| "creator": "W012A3BCD", | |
| "id": "C012AB3CD", | |
| "is_archived": false, | |
| "is_channel": true, | |
| "is_ext_shared": false, | |
| "is_general": true, | |
| "is_group": false, | |
| "is_im": false, | |
| "is_member": true, | |
| "is_mpim": false, | |
| "is_org_shared": false, | |
| "is_pending_ext_shared": false, | |
| "is_private": false, | |
| "is_read_only": false, | |
| "is_shared": false, | |
| "last_read": "1502126650.228446", | |
| "locale": "en-US", | |
| "name": "general", | |
| "name_normalized": "general", | |
| "num_members": 23, | |
| "pending_shared": [], | |
| "previous_names": [ | |
| "specifics", | |
| "abstractions", | |
| "etc" | |
| ], | |
| "purpose": { | |
| "creator": "W012A3BCD", | |
| "last_set": 1449709364, | |
| "value": "This part of the workspace is for fun. Make fun here." | |
| }, | |
| "topic": { | |
| "creator": "W012A3BCD", | |
| "last_set": 1449709364, | |
| "value": "For public discussion of generalities" | |
| }, | |
| "unlinked": 0 | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.rename method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_conversation" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "conversations.rename success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response when the calling user is not a member of the conversation", | |
| "examples": { | |
| "application/json": { | |
| "error": "not_in_channel", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.rename method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "user_is_restricted", | |
| "method_not_supported_for_channel_type", | |
| "missing_scope", | |
| "channel_not_found", | |
| "not_in_channel", | |
| "not_authorized", | |
| "invalid_name", | |
| "name_taken", | |
| "invalid_name_required", | |
| "invalid_name_punctuation", | |
| "invalid_name_maxlength", | |
| "invalid_name_specials", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.rename error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.replies": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieve a thread of messages posted to a conversation", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.replies" | |
| }, | |
| "operationId": "conversations_replies", | |
| "parameters": [ | |
| { | |
| "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", | |
| "in": "query", | |
| "name": "inclusive", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Unique identifier of a thread's parent message.", | |
| "in": "query", | |
| "name": "ts", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:history`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Start of time range of messages to include in results.", | |
| "in": "query", | |
| "name": "oldest", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Conversation ID to fetch thread from.", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "End of time range of messages to include in results.", | |
| "in": "query", | |
| "name": "latest", | |
| "type": "number" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "has_more": true, | |
| "messages": [ | |
| { | |
| "last_read": "1484678597.521003", | |
| "reply_count": 3, | |
| "subscribed": true, | |
| "text": "island", | |
| "thread_ts": "1482960137.003543", | |
| "ts": "1482960137.003543", | |
| "type": "message", | |
| "unread_count": 0, | |
| "user": "U061F7AUR" | |
| }, | |
| { | |
| "parent_user_id": "U061F7AUR", | |
| "text": "one island", | |
| "thread_ts": "1482960137.003543", | |
| "ts": "1483037603.017503", | |
| "type": "message", | |
| "user": "U061F7AUR" | |
| }, | |
| { | |
| "parent_user_id": "U061F7AUR", | |
| "text": "two island", | |
| "thread_ts": "1482960137.003543", | |
| "ts": "1483051909.018632", | |
| "type": "message", | |
| "user": "U061F7AUR" | |
| }, | |
| { | |
| "parent_user_id": "U061F7AUR", | |
| "text": "three for the land", | |
| "thread_ts": "1482960137.003543", | |
| "ts": "1483125339.020269", | |
| "type": "message", | |
| "user": "U061F7AUR" | |
| } | |
| ], | |
| "ok": true, | |
| "response_metadata": { | |
| "next_cursor": "bmV4dF90czoxNDg0Njc4MjkwNTE3MDkx" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.replies method", | |
| "properties": { | |
| "has_more": { | |
| "type": "boolean" | |
| }, | |
| "messages": { | |
| "items": { | |
| "items": [ | |
| { | |
| "properties": { | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest_reply": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "reply_count": { | |
| "type": "integer" | |
| }, | |
| "reply_users": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "reply_users_count": { | |
| "type": "integer" | |
| }, | |
| "source_team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "subscribed": { | |
| "type": "boolean" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "thread_ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "unread_count": { | |
| "type": "integer" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "user_profile": { | |
| "$ref": "#/definitions/objs_user_profile_short" | |
| }, | |
| "user_team": { | |
| "$ref": "#/definitions/defs_team" | |
| } | |
| }, | |
| "required": [ | |
| "type", | |
| "user", | |
| "text", | |
| "thread_ts", | |
| "reply_count", | |
| "subscribed", | |
| "ts" | |
| ], | |
| "type": "object" | |
| }, | |
| { | |
| "properties": { | |
| "is_starred": { | |
| "type": "boolean" | |
| }, | |
| "parent_user_id": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "source_team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "thread_ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "user_profile": { | |
| "$ref": "#/definitions/objs_user_profile_short" | |
| }, | |
| "user_team": { | |
| "$ref": "#/definitions/defs_team" | |
| } | |
| }, | |
| "required": [ | |
| "type", | |
| "user", | |
| "text", | |
| "thread_ts", | |
| "parent_user_id", | |
| "ts" | |
| ], | |
| "type": "object" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "messages" | |
| ], | |
| "title": "conversations.replies success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "thread_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.replies method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "missing_scope", | |
| "channel_not_found", | |
| "thread_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.replies error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:history", | |
| "groups:history", | |
| "im:history", | |
| "mpim:history" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.setPurpose": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sets the purpose for a conversation.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.setPurpose" | |
| }, | |
| "operationId": "conversations_setPurpose", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "A new, specialer purpose", | |
| "in": "formData", | |
| "name": "purpose", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Conversation to set the purpose of", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.setPurpose method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_conversation" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "conversations.setPurpose success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.setPurpose method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "missing_scope", | |
| "channel_not_found", | |
| "not_in_channel", | |
| "is_archived", | |
| "too_long", | |
| "user_is_restricted", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.setPurpose error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.setTopic": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sets the topic for a conversation.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.setTopic" | |
| }, | |
| "operationId": "conversations_setTopic", | |
| "parameters": [ | |
| { | |
| "description": "The new topic string. Does not support formatting or linkification.", | |
| "in": "formData", | |
| "name": "topic", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Conversation to set the topic of", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.setTopic method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_conversation" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "conversations.setTopic success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.setTopic method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "missing_scope", | |
| "channel_not_found", | |
| "not_in_channel", | |
| "is_archived", | |
| "too_long", | |
| "user_is_restricted", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.setTopic error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/conversations.unarchive": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Reverses conversation archival.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/conversations.unarchive" | |
| }, | |
| "operationId": "conversations_unarchive", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `conversations:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID of conversation to unarchive", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from conversations.unarchive method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "conversations.unarchive success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from conversations.unarchive method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "method_not_supported_for_channel_type", | |
| "missing_scope", | |
| "channel_not_found", | |
| "not_archived", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "team_added_to_org", | |
| "missing_charset", | |
| "superfluous_charset" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "conversations.unarchive error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "channels:write", | |
| "groups:write", | |
| "im:write", | |
| "mpim:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "conversations" | |
| ] | |
| } | |
| }, | |
| "/dialog.open": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Open a dialog with a user", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/dialog.open" | |
| }, | |
| "operationId": "dialog_open", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `none`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Exchange a trigger to post to the user.", | |
| "in": "query", | |
| "name": "trigger_id", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The dialog definition. This must be a JSON-encoded string.", | |
| "in": "query", | |
| "name": "dialog", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response is quite minimal.", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from dialog.open method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "dialog.open schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response, before getting to any possible validation errors.", | |
| "examples": { | |
| "application/json": { | |
| "error": "missing_trigger", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from dialog.open method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "validation_errors", | |
| "missing_trigger", | |
| "missing_dialog", | |
| "trigger_exchanged", | |
| "trigger_expired", | |
| "invalid_trigger", | |
| "app_missing_action_url", | |
| "cannot_create_dialog", | |
| "failed_sending_dialog", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "dialog.open error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "none" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "dialog" | |
| ] | |
| } | |
| }, | |
| "/dnd.endDnd": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Ends the current user's Do Not Disturb session immediately.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/dnd.endDnd" | |
| }, | |
| "operationId": "dnd_endDnd", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `dnd:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from dnd.endDnd method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "dnd.endDnd schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from dnd.endDnd method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "unknown_error", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "dnd.endDnd error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "dnd:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "dnd" | |
| ] | |
| } | |
| }, | |
| "/dnd.endSnooze": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Ends the current user's snooze mode immediately.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/dnd.endSnooze" | |
| }, | |
| "operationId": "dnd_endSnooze", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `dnd:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from dnd.endSnooze method", | |
| "properties": { | |
| "dnd_enabled": { | |
| "type": "boolean" | |
| }, | |
| "next_dnd_end_ts": { | |
| "type": "integer" | |
| }, | |
| "next_dnd_start_ts": { | |
| "type": "integer" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "snooze_enabled": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "dnd_enabled", | |
| "next_dnd_start_ts", | |
| "next_dnd_end_ts", | |
| "snooze_enabled" | |
| ], | |
| "title": "dnd.endSnooze schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from dnd.endSnooze method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "snooze_not_active", | |
| "snooze_end_failed", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "dnd.endSnooze error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "dnd:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "dnd" | |
| ] | |
| } | |
| }, | |
| "/dnd.info": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieves a user's current Do Not Disturb status.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/dnd.info" | |
| }, | |
| "operationId": "dnd_info", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `dnd:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "User to fetch status for (defaults to current user)", | |
| "in": "query", | |
| "name": "user", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from dnd.info method", | |
| "properties": { | |
| "dnd_enabled": { | |
| "type": "boolean" | |
| }, | |
| "next_dnd_end_ts": { | |
| "type": "integer" | |
| }, | |
| "next_dnd_start_ts": { | |
| "type": "integer" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "snooze_enabled": { | |
| "type": "boolean" | |
| }, | |
| "snooze_endtime": { | |
| "type": "integer" | |
| }, | |
| "snooze_remaining": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "dnd_enabled", | |
| "next_dnd_start_ts", | |
| "next_dnd_end_ts", | |
| "snooze_enabled", | |
| "snooze_endtime", | |
| "snooze_remaining" | |
| ], | |
| "title": "dnd.info schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from dnd.info method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "user_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "dnd.info error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "dnd:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "dnd" | |
| ] | |
| } | |
| }, | |
| "/dnd.setSnooze": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Turns on Do Not Disturb mode for the current user, or changes its duration.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/dnd.setSnooze" | |
| }, | |
| "operationId": "dnd_setSnooze", | |
| "parameters": [ | |
| { | |
| "description": "Number of minutes, from now, to snooze until.", | |
| "in": "formData", | |
| "name": "num_minutes", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `dnd:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from dnd.setSnooze method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "snooze_enabled": { | |
| "type": "boolean" | |
| }, | |
| "snooze_endtime": { | |
| "type": "integer" | |
| }, | |
| "snooze_remaining": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "snooze_enabled", | |
| "snooze_endtime", | |
| "snooze_remaining" | |
| ], | |
| "title": "dnd.setSnooze schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from dnd.setSnooze method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "missing_duration", | |
| "snooze_failed", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "too_long", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "dnd.setSnooze error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "dnd:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "dnd" | |
| ] | |
| } | |
| }, | |
| "/dnd.teamInfo": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieves the Do Not Disturb status for up to 50 users on a team.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/dnd.teamInfo" | |
| }, | |
| "operationId": "dnd_teamInfo", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `dnd:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Comma-separated list of users to fetch Do Not Disturb status for", | |
| "in": "query", | |
| "name": "users", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true, | |
| "users": { | |
| "U023BECGF": { | |
| "dnd_enabled": true, | |
| "next_dnd_end_ts": 1450423800, | |
| "next_dnd_start_ts": 1450387800 | |
| }, | |
| "W058CJVAA": { | |
| "dnd_enabled": false, | |
| "next_dnd_end_ts": 1, | |
| "next_dnd_start_ts": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from dnd.teamInfo method", | |
| "properties": { | |
| "cached": { | |
| "type": "boolean" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "users": { | |
| "type": "object" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "users" | |
| ], | |
| "title": "dnd.teamInfo success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from dnd.teamInfo method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "dnd.teamInfo error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "dnd:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "dnd" | |
| ] | |
| } | |
| }, | |
| "/emoji.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Lists custom emoji for a team.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/emoji.list" | |
| }, | |
| "operationId": "emoji_list", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `emoji:read`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "emoji:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "emoji" | |
| ] | |
| } | |
| }, | |
| "/files.comments.delete": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Deletes an existing comment on a file.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.comments.delete" | |
| }, | |
| "operationId": "files_comments_delete", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `files:write:user`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The comment to delete.", | |
| "in": "formData", | |
| "name": "id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "File to delete a comment from.", | |
| "in": "formData", | |
| "name": "file", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Standard success response is very simple", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response files.comments.delete method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "files.comments.delete schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Standard failure response when used with an invalid token", | |
| "examples": { | |
| "application/json": { | |
| "error": "file_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response files.comments.delete method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "cant_delete", | |
| "comment_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "no_permission", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "files.comments.delete error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "files:write:user" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files.comments", | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.delete": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Deletes a file.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.delete" | |
| }, | |
| "operationId": "files_delete", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `files:write:user`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "ID of file to delete.", | |
| "in": "formData", | |
| "name": "file", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response files.delete method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "files.delete schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response files.delete method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "file_not_found", | |
| "file_deleted", | |
| "cant_delete_file", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "no_permission", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "files.delete error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "files:write:user" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.info": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Gets information about a team file.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.info" | |
| }, | |
| "operationId": "files_info", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "count", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection of comments. See [pagination](/docs/pagination) for more details.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `files:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Specify a file by providing its ID.", | |
| "in": "query", | |
| "name": "file", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "page", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "comments": [], | |
| "file": { | |
| "channels": [ | |
| "C0T8SE4AU" | |
| ], | |
| "comments_count": 0, | |
| "created": 1531763342, | |
| "deanimate_gif": "https://.../tedair_deanimate_gif.png", | |
| "display_as_bot": false, | |
| "editable": false, | |
| "external_type": "", | |
| "filetype": "gif", | |
| "groups": [], | |
| "has_rich_preview": false, | |
| "id": "F0S43PZDF", | |
| "image_exif_rotation": 1, | |
| "ims": [], | |
| "is_external": false, | |
| "is_public": true, | |
| "is_starred": false, | |
| "mimetype": "image/gif", | |
| "mode": "hosted", | |
| "name": "tedair.gif", | |
| "original_h": 226, | |
| "original_w": 176, | |
| "permalink": "https://https://.../tedair.gif", | |
| "permalink_public": "https://.../...", | |
| "pjpeg": "https://.../tedair_pjpeg.jpg", | |
| "pretty_type": "GIF", | |
| "public_url_shared": false, | |
| "shares": { | |
| "public": { | |
| "C0T8SE4AU": [ | |
| { | |
| "channel_name": "file-under", | |
| "latest_reply": "1531763348.000001", | |
| "reply_count": 1, | |
| "reply_users": [ | |
| "U061F7AUR" | |
| ], | |
| "reply_users_count": 1, | |
| "team_id": "T061EG9R6", | |
| "thread_ts": "1531763273.000015", | |
| "ts": "1531763348.000001" | |
| } | |
| ] | |
| } | |
| }, | |
| "size": 137531, | |
| "thumb_160": "https://.../tedair_=_160.png", | |
| "thumb_360": "https://.../tedair_360.png", | |
| "thumb_360_gif": "https://.../tedair_360.gif", | |
| "thumb_360_h": 226, | |
| "thumb_360_w": 176, | |
| "thumb_64": "https://.../tedair_64.png", | |
| "thumb_80": "https://.../tedair_80.png", | |
| "timestamp": 1531763342, | |
| "title": "tedair.gif", | |
| "url_private": "https://.../tedair.gif", | |
| "url_private_download": "https://.../tedair.gif", | |
| "user": "U061F7AUR", | |
| "username": "" | |
| }, | |
| "ok": true, | |
| "response_metadata": { | |
| "next_cursor": "dGVhbTpDMUg5UkVTR0w=" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from files.info method", | |
| "properties": { | |
| "comments": { | |
| "$ref": "#/definitions/objs_comments" | |
| }, | |
| "content_html": { | |
| "type": "null" | |
| }, | |
| "editor": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "file": { | |
| "$ref": "#/definitions/objs_file" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "paging": { | |
| "$ref": "#/definitions/objs_paging" | |
| }, | |
| "response_metadata": { | |
| "$ref": "#/definitions/objs_response_metadata" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "file", | |
| "comments" | |
| ], | |
| "title": "files.info schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from files.info method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "file_not_found", | |
| "file_deleted", | |
| "timezone_count_failed", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "no_permission", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "files.info error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "files:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Lists & filters team files.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.list" | |
| }, | |
| "operationId": "files_list", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "count", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Filter files appearing in a specific channel, indicated by its ID.", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Filter files created before this timestamp (inclusive).", | |
| "in": "query", | |
| "name": "ts_to", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Filter files created after this timestamp (inclusive).", | |
| "in": "query", | |
| "name": "ts_from", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `files:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Filter files created by a single user.", | |
| "in": "query", | |
| "name": "user", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.", | |
| "in": "query", | |
| "name": "show_files_hidden_by_limit", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "page", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Filter files by type ([see below](#file_types)). You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list.", | |
| "in": "query", | |
| "name": "types", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "files": [ | |
| { | |
| "channels": [ | |
| "C0T8SE4AU" | |
| ], | |
| "comments_count": 0, | |
| "created": 1531763254, | |
| "deanimate_gif": "https://.../billair_deanimate_gif.png", | |
| "display_as_bot": false, | |
| "editable": false, | |
| "external_type": "", | |
| "filetype": "gif", | |
| "groups": [], | |
| "id": "F0S43P1CZ", | |
| "image_exif_rotation": 1, | |
| "ims": [], | |
| "is_external": false, | |
| "is_public": true, | |
| "mimetype": "image/gif", | |
| "mode": "hosted", | |
| "name": "billair.gif", | |
| "original_h": 226, | |
| "original_w": 176, | |
| "permalink": "https://https://.../billair.gif", | |
| "permalink_public": "https://.../...", | |
| "pjpeg": "https://.../billair_pjpeg.jpg", | |
| "pretty_type": "GIF", | |
| "public_url_shared": false, | |
| "size": 144538, | |
| "thumb_160": "https://.../billair_=_160.png", | |
| "thumb_360": "https://.../billair_360.png", | |
| "thumb_360_gif": "https://.../billair_360.gif", | |
| "thumb_360_h": 226, | |
| "thumb_360_w": 176, | |
| "thumb_64": "https://.../billair_64.png", | |
| "thumb_80": "https://.../billair_80.png", | |
| "timestamp": 1531763254, | |
| "title": "billair.gif", | |
| "url_private": "https://.../billair.gif", | |
| "url_private_download": "https://.../billair.gif", | |
| "user": "U061F7AUR", | |
| "username": "" | |
| }, | |
| { | |
| "channels": [ | |
| "C0T8SE4AU" | |
| ], | |
| "comments_count": 0, | |
| "created": 1531763342, | |
| "deanimate_gif": "https://.../tedair_deanimate_gif.png", | |
| "display_as_bot": false, | |
| "editable": false, | |
| "external_type": "", | |
| "filetype": "gif", | |
| "groups": [], | |
| "id": "F0S43PZDF", | |
| "image_exif_rotation": 1, | |
| "ims": [], | |
| "is_external": false, | |
| "is_public": true, | |
| "mimetype": "image/gif", | |
| "mode": "hosted", | |
| "name": "tedair.gif", | |
| "original_h": 226, | |
| "original_w": 176, | |
| "permalink": "https://https://.../tedair.gif", | |
| "permalink_public": "https://.../...", | |
| "pjpeg": "https://.../tedair_pjpeg.jpg", | |
| "pretty_type": "GIF", | |
| "public_url_shared": false, | |
| "size": 137531, | |
| "thumb_160": "https://.../tedair_=_160.png", | |
| "thumb_360": "https://.../tedair_360.png", | |
| "thumb_360_gif": "https://.../tedair_360.gif", | |
| "thumb_360_h": 226, | |
| "thumb_360_w": 176, | |
| "thumb_64": "https://.../tedair_64.png", | |
| "thumb_80": "https://.../tedair_80.png", | |
| "timestamp": 1531763342, | |
| "title": "tedair.gif", | |
| "url_private": "https://.../tedair.gif", | |
| "url_private_download": "https://.../tedair.gif", | |
| "user": "U061F7AUR", | |
| "username": "" | |
| } | |
| ], | |
| "ok": true, | |
| "paging": { | |
| "count": 100, | |
| "page": 1, | |
| "pages": 1, | |
| "total": 2 | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from files.list method", | |
| "properties": { | |
| "files": { | |
| "items": { | |
| "$ref": "#/definitions/objs_file" | |
| }, | |
| "minItems": 0, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "paging": { | |
| "$ref": "#/definitions/objs_paging" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "files", | |
| "paging" | |
| ], | |
| "title": "files.list schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from files.list method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "user_not_found", | |
| "unknown_type", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "no_permission", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "files.list error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "files:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.remote.add": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Adds a file from a remote service", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.remote.add" | |
| }, | |
| "operationId": "files_remote_add", | |
| "parameters": [ | |
| { | |
| "description": "Title of the file being shared.", | |
| "in": "formData", | |
| "name": "title", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "type of file", | |
| "in": "formData", | |
| "name": "filetype", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `remote_files:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.", | |
| "in": "formData", | |
| "name": "indexable_file_contents", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Preview of the document via `multipart/form-data`.", | |
| "in": "formData", | |
| "name": "preview_image", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Creator defined GUID for the file.", | |
| "in": "formData", | |
| "name": "external_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "URL of the remote file.", | |
| "in": "formData", | |
| "name": "external_url", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "remote_files:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files.remote", | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.remote.info": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieve information about a remote file added to Slack", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.remote.info" | |
| }, | |
| "operationId": "files_remote_info", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `remote_files:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Creator defined GUID for the file.", | |
| "in": "query", | |
| "name": "external_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Specify a file by providing its ID.", | |
| "in": "query", | |
| "name": "file", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "remote_files:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files.remote", | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.remote.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieve information about a remote file added to Slack", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.remote.list" | |
| }, | |
| "operationId": "files_remote_list", | |
| "parameters": [ | |
| { | |
| "description": "Filter files created before this timestamp (inclusive).", | |
| "in": "query", | |
| "name": "ts_to", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Filter files created after this timestamp (inclusive).", | |
| "in": "query", | |
| "name": "ts_from", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `remote_files:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Filter files appearing in a specific channel, indicated by its ID.", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "remote_files:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files.remote", | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.remote.remove": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Remove a remote file.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.remote.remove" | |
| }, | |
| "operationId": "files_remote_remove", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `remote_files:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Creator defined GUID for the file.", | |
| "in": "formData", | |
| "name": "external_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Specify a file by providing its ID.", | |
| "in": "formData", | |
| "name": "file", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "remote_files:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files.remote", | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.remote.share": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Share a remote file into a channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.remote.share" | |
| }, | |
| "operationId": "files_remote_share", | |
| "parameters": [ | |
| { | |
| "description": "Comma-separated list of channel IDs where the file will be shared.", | |
| "in": "query", | |
| "name": "channels", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `remote_files:share`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Creator defined GUID for the file.", | |
| "in": "query", | |
| "name": "external_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Specify a file by providing its ID.", | |
| "in": "query", | |
| "name": "file", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "remote_files:share" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files.remote", | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.remote.update": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Updates an existing remote file.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.remote.update" | |
| }, | |
| "operationId": "files_remote_update", | |
| "parameters": [ | |
| { | |
| "description": "Title of the file being shared.", | |
| "in": "formData", | |
| "name": "title", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "type of file", | |
| "in": "formData", | |
| "name": "filetype", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `remote_files:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Specify a file by providing its ID.", | |
| "in": "formData", | |
| "name": "file", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "File containing contents that can be used to improve searchability for the remote file.", | |
| "in": "formData", | |
| "name": "indexable_file_contents", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Preview of the document via `multipart/form-data`.", | |
| "in": "formData", | |
| "name": "preview_image", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Creator defined GUID for the file.", | |
| "in": "formData", | |
| "name": "external_id", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "URL of the remote file.", | |
| "in": "formData", | |
| "name": "external_url", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default success template", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "Default error template", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "remote_files:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files.remote", | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.revokePublicURL": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Revokes public/external sharing access for a file", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.revokePublicURL" | |
| }, | |
| "operationId": "files_revokePublicURL", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `files:write:user`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "File to revoke", | |
| "in": "formData", | |
| "name": "file", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from files.revokePublicURL method", | |
| "properties": { | |
| "file": { | |
| "$ref": "#/definitions/objs_file" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "file" | |
| ], | |
| "title": "files.revokePublicURL schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from files.revokePublicURL method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "file_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "files.revokePublicURL error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "files:write:user" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.sharedPublicURL": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Enables a file for public/external sharing.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.sharedPublicURL" | |
| }, | |
| "operationId": "files_sharedPublicURL", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `files:write:user`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "File to share", | |
| "in": "formData", | |
| "name": "file", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from files.sharedPublicURL method", | |
| "properties": { | |
| "file": { | |
| "$ref": "#/definitions/objs_file" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "file" | |
| ], | |
| "title": "files.sharedPublicURL schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from files.sharedPublicURL method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "file_not_found", | |
| "not_allowed", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "files.sharedPublicURL error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "files:write:user" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/files.upload": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Uploads or creates a file.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/files.upload" | |
| }, | |
| "operationId": "files_upload", | |
| "parameters": [ | |
| { | |
| "description": "Comma-separated list of channel names or IDs where the file will be shared.", | |
| "in": "formData", | |
| "name": "channels", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Title of file.", | |
| "in": "formData", | |
| "name": "title", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The message text introducing the file in specified `channels`.", | |
| "in": "formData", | |
| "name": "initial_comment", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "A [file type](/types/file#file_types) identifier.", | |
| "in": "formData", | |
| "name": "filetype", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Filename of file.", | |
| "in": "formData", | |
| "name": "filename", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "File contents via a POST variable. If omitting this parameter, you must provide a `file`.", | |
| "in": "formData", | |
| "name": "content", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `files:write:user`", | |
| "in": "formData", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "File contents via `multipart/form-data`. If omitting this parameter, you must submit `content`.", | |
| "in": "formData", | |
| "name": "file", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Provide another message's `ts` value to upload this file as a reply. Never use a reply's `ts` value; use its parent instead.", | |
| "in": "formData", | |
| "name": "thread_ts", | |
| "type": "number" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success response after uploading a file to a channel with an initial message", | |
| "examples": { | |
| "application/json": { | |
| "file": { | |
| "channels": [], | |
| "comments_count": 0, | |
| "created": 1532293501, | |
| "display_as_bot": false, | |
| "editable": false, | |
| "external_type": "", | |
| "filetype": "gif", | |
| "groups": [], | |
| "has_rich_preview": false, | |
| "id": "F0TD00400", | |
| "image_exif_rotation": 1, | |
| "ims": [ | |
| "D0L4B9P0Q" | |
| ], | |
| "is_external": false, | |
| "is_public": false, | |
| "is_starred": false, | |
| "mimetype": "image/jpeg", | |
| "mode": "hosted", | |
| "name": "dramacat.gif", | |
| "original_h": 366, | |
| "original_w": 526, | |
| "permalink": "https://.../dramacat.gif", | |
| "permalink_public": "https://.../More-Path-Components", | |
| "pretty_type": "JPEG", | |
| "public_url_shared": false, | |
| "shares": { | |
| "private": { | |
| "D0L4B9P0Q": [ | |
| { | |
| "reply_count": 0, | |
| "reply_users": [], | |
| "reply_users_count": 0, | |
| "ts": "1532293503.000001" | |
| } | |
| ] | |
| } | |
| }, | |
| "size": 43518, | |
| "thumb_160": "https://.../dramacat_160.gif", | |
| "thumb_360": "https://.../dramacat_360.gif", | |
| "thumb_360_h": 250, | |
| "thumb_360_w": 360, | |
| "thumb_480": "https://.../dramacat_480.gif", | |
| "thumb_480_h": 334, | |
| "thumb_480_w": 480, | |
| "thumb_64": "https://.../dramacat_64.gif", | |
| "thumb_80": "https://.../dramacat_80.gif", | |
| "timestamp": 1532293501, | |
| "title": "dramacat", | |
| "url_private": "https://.../dramacat.gif", | |
| "url_private_download": "https://.../dramacat.gif", | |
| "user": "U0L4B9NSU", | |
| "username": "" | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response files.upload method", | |
| "properties": { | |
| "file": { | |
| "$ref": "#/definitions/objs_file" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "file" | |
| ], | |
| "title": "files.upload schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response files.upload method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "posting_to_general_channel_denied", | |
| "invalid_channel", | |
| "file_uploads_disabled", | |
| "file_uploads_except_images_disabled", | |
| "storage_limit_reached", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "no_permission", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "files.upload error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "files:write:user" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "files" | |
| ] | |
| } | |
| }, | |
| "/groups.archive": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Archives a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.archive" | |
| }, | |
| "operationId": "groups_archive", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to archive", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.archive method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "groups.archive schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.archive method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "already_archived", | |
| "group_contains_others", | |
| "restricted_action", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.archive error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.create": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Creates a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.create" | |
| }, | |
| "operationId": "groups_create", | |
| "parameters": [ | |
| { | |
| "description": "Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.", | |
| "in": "formData", | |
| "name": "validate", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Name of private channel to create", | |
| "in": "formData", | |
| "name": "name", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response groups.create method", | |
| "properties": { | |
| "group": { | |
| "$ref": "#/definitions/objs_group" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "group" | |
| ], | |
| "title": "groups.create success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response groups.create method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "no_channel", | |
| "restricted_action", | |
| "name_taken", | |
| "invalid_name_required", | |
| "invalid_name_punctuation", | |
| "invalid_name_maxlength", | |
| "invalid_name_specials", | |
| "invalid_name", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.create error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.createChild": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Clones and archives a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.createChild" | |
| }, | |
| "operationId": "groups_createChild", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "formData", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to clone and archive.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.createChild method", | |
| "properties": { | |
| "group": { | |
| "$ref": "#/definitions/objs_group" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "group" | |
| ], | |
| "title": "groups.createChild schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.createChild method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "already_archived", | |
| "restricted_action", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.createChild error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.history": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Fetches history of messages and events from a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.history" | |
| }, | |
| "operationId": "groups_history", | |
| "parameters": [ | |
| { | |
| "description": "Number of messages to return, between 1 and 1000.", | |
| "in": "query", | |
| "name": "count", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Include `unread_count_display` in the output?", | |
| "in": "query", | |
| "name": "unreads", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Include messages with latest or oldest timestamp in results.", | |
| "in": "query", | |
| "name": "inclusive", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `groups:history`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Start of time range of messages to include in results.", | |
| "in": "query", | |
| "name": "oldest", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Private channel to fetch history for.", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "End of time range of messages to include in results.", | |
| "in": "query", | |
| "name": "latest", | |
| "type": "number" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "has_more": false, | |
| "latest": "1358547726.000003", | |
| "messages": [ | |
| { | |
| "text": "Hello", | |
| "ts": "1358546515.000008", | |
| "type": "message", | |
| "user": "U2147483896" | |
| }, | |
| { | |
| "is_starred": true, | |
| "text": "World", | |
| "ts": "1358546515.000007", | |
| "type": "message", | |
| "user": "U2147483896" | |
| }, | |
| { | |
| "ts": "1358546515.000007", | |
| "type": "something_else" | |
| } | |
| ], | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response groups.history method", | |
| "properties": { | |
| "channel_actions_count": { | |
| "type": "integer" | |
| }, | |
| "channel_actions_ts": { | |
| "items": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "has_more": { | |
| "type": "boolean" | |
| }, | |
| "messages": { | |
| "items": { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "messages", | |
| "has_more", | |
| "channel_actions_ts", | |
| "channel_actions_count" | |
| ], | |
| "title": "groups.history success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response groups.history method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "invalid_ts_latest", | |
| "invalid_ts_oldest", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "ekm_access_denied", | |
| "missing_scope", | |
| "invalid_arguments", | |
| "invalid_arg_name", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "request_timeout", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.history error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:history" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.info": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Gets information about a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.info" | |
| }, | |
| "operationId": "groups_info", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `groups:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Set this to `true` to receive the locale for this group. Defaults to `false`", | |
| "in": "query", | |
| "name": "include_locale", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Private channel to get info on", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response groups.info method", | |
| "properties": { | |
| "group": { | |
| "$ref": "#/definitions/objs_group" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "group" | |
| ], | |
| "title": "groups.info success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response groups.info method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "invalid_for_external_shared_channel" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.info error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.invite": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Invites a user to a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.invite" | |
| }, | |
| "operationId": "groups_invite", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "User to invite.", | |
| "in": "formData", | |
| "name": "user", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to invite user to.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response groups.invite method", | |
| "properties": { | |
| "group": { | |
| "$ref": "#/definitions/objs_group" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "group" | |
| ], | |
| "title": "groups.invite success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response groups.invite method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "user_not_found", | |
| "cant_invite_self", | |
| "is_archived", | |
| "cant_invite", | |
| "ura_max_channels", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "user_is_bot", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.invite error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.kick": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Removes a user from a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.kick" | |
| }, | |
| "operationId": "groups_kick", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "User to remove from private channel.", | |
| "in": "formData", | |
| "name": "user", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to remove user from.", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.kick method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "groups.kick schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.kick method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "user_not_found", | |
| "cant_kick_self", | |
| "not_in_group", | |
| "restricted_action", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.kick error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.leave": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Leaves a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.leave" | |
| }, | |
| "operationId": "groups_leave", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to leave", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.leave method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "groups.leave schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.leave method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "is_archived", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_ultra_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.leave error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Lists private channels that the calling user has access to.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.list" | |
| }, | |
| "operationId": "groups_list", | |
| "parameters": [ | |
| { | |
| "description": "Exclude the `members` from each `group`", | |
| "in": "query", | |
| "name": "exclude_members", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more details.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `groups:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Don't return archived private channels.", | |
| "in": "query", | |
| "name": "exclude_archived", | |
| "type": "boolean" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response groups.list method", | |
| "properties": { | |
| "groups": { | |
| "items": { | |
| "$ref": "#/definitions/objs_group" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "response_metadata": { | |
| "$ref": "#/definitions/objs_response_metadata" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "groups" | |
| ], | |
| "title": "groups.list success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response groups.list method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.list error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.mark": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sets the read cursor in a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.mark" | |
| }, | |
| "operationId": "groups_mark", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Timestamp of the most recently seen message.", | |
| "in": "formData", | |
| "name": "ts", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Private channel to set reading cursor in.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.mark method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "groups.mark success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.mark method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "invalid_timestamp", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.mark error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.open": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Opens a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.open" | |
| }, | |
| "operationId": "groups_open", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to open.", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.open method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "groups.open schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.open method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.open error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.rename": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Renames a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.rename" | |
| }, | |
| "operationId": "groups_rename", | |
| "parameters": [ | |
| { | |
| "description": "Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.", | |
| "in": "formData", | |
| "name": "validate", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "New name for private channel.", | |
| "in": "formData", | |
| "name": "name", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to rename", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.rename method", | |
| "properties": { | |
| "channel": { | |
| "$ref": "#/definitions/objs_group" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "groups.rename schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.rename method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "invalid_name", | |
| "name_taken", | |
| "invalid_name_required", | |
| "invalid_name_punctuation", | |
| "invalid_name_maxlength", | |
| "invalid_name_specials", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.rename error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.replies": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieve a thread of messages posted to a private channel", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.replies" | |
| }, | |
| "operationId": "groups_replies", | |
| "parameters": [ | |
| { | |
| "description": "Unique identifier of a thread's parent message", | |
| "in": "query", | |
| "name": "thread_ts", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `groups:history`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to fetch thread from", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "messages": [ | |
| { | |
| "text": "Hello", | |
| "ts": "1358546515.000008", | |
| "type": "message", | |
| "user": "U2147483896" | |
| }, | |
| { | |
| "is_starred": true, | |
| "text": "World", | |
| "ts": "1358546515.000007", | |
| "type": "message", | |
| "user": "U2147483896" | |
| }, | |
| { | |
| "ts": "1358546515.000007", | |
| "type": "something_else" | |
| } | |
| ], | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.replies method", | |
| "properties": { | |
| "has_more": { | |
| "type": "boolean" | |
| }, | |
| "messages": { | |
| "items": { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "messages" | |
| ], | |
| "title": "groups.replies schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.replies method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "thread_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.replies error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:history" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.setPurpose": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sets the purpose for a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.setPurpose" | |
| }, | |
| "operationId": "groups_setPurpose", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The new purpose", | |
| "in": "formData", | |
| "name": "purpose", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to set the purpose of", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.setPurpose method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "purpose": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "purpose" | |
| ], | |
| "title": "groups.setPurpose schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.setPurpose method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "is_archived", | |
| "too_long", | |
| "user_is_restricted", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.setPurpose error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.setTopic": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sets the topic for a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.setTopic" | |
| }, | |
| "operationId": "groups_setTopic", | |
| "parameters": [ | |
| { | |
| "description": "The new topic", | |
| "in": "formData", | |
| "name": "topic", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to set the topic of", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.setTopic method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "topic": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "topic" | |
| ], | |
| "title": "groups.setTopic schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.setTopic method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "is_archived", | |
| "too_long", | |
| "user_is_restricted", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.setTopic error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/groups.unarchive": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Unarchives a private channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/groups.unarchive" | |
| }, | |
| "operationId": "groups_unarchive", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `groups:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Private channel to unarchive", | |
| "in": "formData", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from groups.unarchive method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "groups.unarchive schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from groups.unarchive method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "not_archived", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "user_is_bot", | |
| "user_is_restricted", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "groups.unarchive error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "groups:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "groups" | |
| ] | |
| } | |
| }, | |
| "/im.close": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Close a direct message channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/im.close" | |
| }, | |
| "operationId": "im_close", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `im:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Direct message channel to close.", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from im.close method", | |
| "properties": { | |
| "already_closed": { | |
| "type": "boolean" | |
| }, | |
| "no_op": { | |
| "type": "boolean" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "im.close schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from im.close method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "user_does_not_own_channel", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "im.close error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "im:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "im" | |
| ] | |
| } | |
| }, | |
| "/im.history": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Fetches history of messages and events from direct message channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/im.history" | |
| }, | |
| "operationId": "im_history", | |
| "parameters": [ | |
| { | |
| "description": "Number of messages to return, between 1 and 1000.", | |
| "in": "query", | |
| "name": "count", | |
| "type": "integer" | |
| }, | |
| { | |
| "description": "Include `unread_count_display` in the output?", | |
| "in": "query", | |
| "name": "unreads", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Include messages with latest or oldest timestamp in results.", | |
| "in": "query", | |
| "name": "inclusive", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `im:history`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Start of time range of messages to include in results.", | |
| "in": "query", | |
| "name": "oldest", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Direct message channel to fetch history for.", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "End of time range of messages to include in results.", | |
| "in": "query", | |
| "name": "latest", | |
| "type": "number" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "has_more": false, | |
| "latest": "1358547726.000003", | |
| "messages": [ | |
| { | |
| "text": "Hello", | |
| "ts": "1358546515.000008", | |
| "type": "message", | |
| "user": "U2147483896" | |
| }, | |
| { | |
| "is_starred": true, | |
| "text": "World", | |
| "ts": "1358546515.000007", | |
| "type": "message", | |
| "user": "U2147483896" | |
| }, | |
| { | |
| "ts": "1358546515.000007", | |
| "type": "something_else" | |
| } | |
| ], | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from im.history method", | |
| "properties": { | |
| "channel_actions_count": { | |
| "type": "integer" | |
| }, | |
| "channel_actions_ts": { | |
| "items": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "has_more": { | |
| "type": "boolean" | |
| }, | |
| "messages": { | |
| "items": { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| "minItems": 1, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "messages", | |
| "has_more", | |
| "channel_actions_ts", | |
| "channel_actions_count" | |
| ], | |
| "title": "im.history success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from im.history method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "invalid_ts_latest", | |
| "invalid_ts_oldest", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "needed": { | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| }, | |
| "provided": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "im.history error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "im:history" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "im" | |
| ] | |
| } | |
| }, | |
| "/im.list": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Lists direct message channels for the calling user.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/im.list" | |
| }, | |
| "operationId": "im_list", | |
| "parameters": [ | |
| { | |
| "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", | |
| "in": "query", | |
| "name": "cursor", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `im:read`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", | |
| "in": "query", | |
| "name": "limit", | |
| "type": "integer" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ims": [ | |
| { | |
| "created": 1449709280, | |
| "id": "D0G9QPY56", | |
| "is_im": true, | |
| "is_org_shared": false, | |
| "is_user_deleted": false, | |
| "user": "USLACKBOT" | |
| }, | |
| { | |
| "created": 1466692204, | |
| "id": "D1KL59A72", | |
| "is_im": true, | |
| "is_org_shared": false, | |
| "is_user_deleted": false, | |
| "user": "U0G9QF9C6" | |
| }, | |
| { | |
| "created": 1449722883, | |
| "id": "D0G9XPFH9", | |
| "is_im": true, | |
| "is_org_shared": false, | |
| "is_user_deleted": false, | |
| "user": "U0G9WFXNZ" | |
| }, | |
| { | |
| "created": 1452098023, | |
| "id": "D0HRHJSF7", | |
| "is_im": true, | |
| "is_org_shared": false, | |
| "is_user_deleted": false, | |
| "user": "W0HRJL7CK" | |
| }, | |
| { | |
| "created": 1465834222, | |
| "id": "D1GD7CHC0", | |
| "is_im": true, | |
| "is_org_shared": false, | |
| "is_user_deleted": true, | |
| "user": "U1GDBDGR3" | |
| }, | |
| { | |
| "created": 1468274703, | |
| "id": "D1QMF76M9", | |
| "is_im": true, | |
| "is_org_shared": false, | |
| "is_user_deleted": false, | |
| "user": "U1QNSQB9U" | |
| }, | |
| { | |
| "created": 1502210225, | |
| "id": "D6K48KKRN", | |
| "is_im": true, | |
| "is_org_shared": false, | |
| "is_user_deleted": false, | |
| "user": "U6KR7BVFW" | |
| } | |
| ], | |
| "ok": true, | |
| "response_metadata": { | |
| "next_cursor": "aW1faWQ6RDBCSDk1RExI=" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response im.list method", | |
| "properties": { | |
| "ims": { | |
| "items": { | |
| "$ref": "#/definitions/objs_im" | |
| }, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| }, | |
| "response_metadata": { | |
| "$ref": "#/definitions/objs_response_metadata" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "ims" | |
| ], | |
| "title": "im.list success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from im.list method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "invalid_cursor", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "no_permission", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "im.list error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "im:read" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "im" | |
| ] | |
| } | |
| }, | |
| "/im.mark": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Sets the read cursor in a direct message channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/im.mark" | |
| }, | |
| "operationId": "im_mark", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `im:write`", | |
| "in": "header", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Direct message channel to set reading cursor in.", | |
| "in": "formData", | |
| "name": "channel", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Timestamp of the most recently seen message.", | |
| "in": "formData", | |
| "name": "ts", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response im.mark method", | |
| "properties": { | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok" | |
| ], | |
| "title": "im.mark success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response im.mark method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "invalid_timestamp", | |
| "not_in_channel", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "im.mark error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "im:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "im" | |
| ] | |
| } | |
| }, | |
| "/im.open": { | |
| "post": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded", | |
| "application/json" | |
| ], | |
| "description": "Opens a direct message channel.", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/im.open" | |
| }, | |
| "operationId": "im_open", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `im:write`", | |
| "in": "header", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Boolean, indicates you want the full IM channel definition in the response.", | |
| "in": "formData", | |
| "name": "return_im", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "User to open a direct message channel with.", | |
| "in": "formData", | |
| "name": "user", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Set this to `true` to receive the locale for this im. Defaults to `false`", | |
| "in": "formData", | |
| "name": "include_locale", | |
| "type": "boolean" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "channel": { | |
| "id": "D947RLWRX" | |
| }, | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from im.open method", | |
| "properties": { | |
| "already_open": { | |
| "type": "boolean" | |
| }, | |
| "channel": { | |
| "properties": { | |
| "created": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "$ref": "#/definitions/defs_dm_id" | |
| }, | |
| "is_im": { | |
| "type": "boolean" | |
| }, | |
| "is_open": { | |
| "type": "boolean" | |
| }, | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest": { | |
| "$ref": "#/definitions/objs_message" | |
| }, | |
| "unread_count": { | |
| "type": "number" | |
| }, | |
| "unread_count_display": { | |
| "type": "number" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| } | |
| }, | |
| "required": [ | |
| "id" | |
| ], | |
| "type": "object" | |
| }, | |
| "no_op": { | |
| "type": "boolean" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "channel" | |
| ], | |
| "title": "im.open success schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "invalid_auth", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from im.open method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "user_not_found", | |
| "user_not_visible", | |
| "user_disabled", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "no_permission", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "im.open error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "im:write" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "im" | |
| ] | |
| } | |
| }, | |
| "/im.replies": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "Retrieve a thread of messages posted to a direct message conversation", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/im.replies" | |
| }, | |
| "operationId": "im_replies", | |
| "parameters": [ | |
| { | |
| "description": "Unique identifier of a thread's parent message", | |
| "in": "query", | |
| "name": "thread_ts", | |
| "type": "number" | |
| }, | |
| { | |
| "description": "Authentication token. Requires scope: `im:history`", | |
| "in": "query", | |
| "name": "token", | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Direct message channel to fetch thread from", | |
| "in": "query", | |
| "name": "channel", | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response", | |
| "examples": { | |
| "application/json": { | |
| "messages": [ | |
| { | |
| "text": "Hello", | |
| "ts": "1358546515.000008", | |
| "type": "message", | |
| "user": "U2147483896" | |
| }, | |
| { | |
| "is_starred": true, | |
| "text": "World", | |
| "ts": "1358546515.000007", | |
| "type": "message", | |
| "user": "U2147483896" | |
| }, | |
| { | |
| "ts": "1358546515.000007", | |
| "type": "something_else" | |
| } | |
| ], | |
| "ok": true | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for successful response from im.replies method", | |
| "properties": { | |
| "has_more": { | |
| "type": "boolean" | |
| }, | |
| "messages": { | |
| "items": { | |
| "items": [ | |
| { | |
| "properties": { | |
| "last_read": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "latest_reply": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "reply_count": { | |
| "type": "integer" | |
| }, | |
| "reply_users": { | |
| "items": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "type": "array", | |
| "uniqueItems": true | |
| }, | |
| "reply_users_count": { | |
| "type": "integer" | |
| }, | |
| "source_team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "subscribed": { | |
| "type": "boolean" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "thread_ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "unread_count": { | |
| "type": "integer" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "user_profile": { | |
| "$ref": "#/definitions/objs_user_profile_short" | |
| }, | |
| "user_team": { | |
| "$ref": "#/definitions/defs_team" | |
| } | |
| }, | |
| "required": [ | |
| "type", | |
| "user", | |
| "text", | |
| "thread_ts", | |
| "reply_count", | |
| "subscribed", | |
| "ts" | |
| ], | |
| "type": "object" | |
| }, | |
| { | |
| "properties": { | |
| "is_starred": { | |
| "type": "boolean" | |
| }, | |
| "parent_user_id": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "source_team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "team": { | |
| "$ref": "#/definitions/defs_team" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "thread_ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "ts": { | |
| "$ref": "#/definitions/defs_ts" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/defs_user_id" | |
| }, | |
| "user_profile": { | |
| "$ref": "#/definitions/objs_user_profile_short" | |
| }, | |
| "user_team": { | |
| "$ref": "#/definitions/defs_team" | |
| } | |
| }, | |
| "required": [ | |
| "type", | |
| "user", | |
| "text", | |
| "thread_ts", | |
| "parent_user_id", | |
| "ts" | |
| ], | |
| "type": "object" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_true" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "messages", | |
| "has_more" | |
| ], | |
| "title": "im.replies schema", | |
| "type": "object" | |
| } | |
| }, | |
| "default": { | |
| "description": "Typical error response", | |
| "examples": { | |
| "application/json": { | |
| "error": "channel_not_found", | |
| "ok": false | |
| } | |
| }, | |
| "schema": { | |
| "description": "Schema for error response from im.replies method", | |
| "properties": { | |
| "error": { | |
| "enum": [ | |
| "channel_not_found", | |
| "thread_not_found", | |
| "not_authed", | |
| "invalid_auth", | |
| "account_inactive", | |
| "token_revoked", | |
| "no_permission", | |
| "org_login_required", | |
| "invalid_arg_name", | |
| "invalid_array_arg", | |
| "invalid_charset", | |
| "invalid_form_data", | |
| "invalid_post_type", | |
| "missing_post_type", | |
| "team_added_to_org", | |
| "invalid_json", | |
| "json_not_object", | |
| "request_timeout", | |
| "upgrade_required", | |
| "fatal_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "ok": { | |
| "$ref": "#/definitions/defs_ok_false" | |
| } | |
| }, | |
| "required": [ | |
| "ok", | |
| "error" | |
| ], | |
| "title": "im.replies error schema", | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "slackAuth": [ | |
| "im:history" | |
| ] | |
| } | |
| ], | |
| "tags": [ | |
| "im" | |
| ] | |
| } | |
| }, | |
| "/migration.exchange": { | |
| "get": { | |
| "consumes": [ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "description": "For Enterprise Grid workspaces, map local user IDs to global user IDs", | |
| "externalDocs": { | |
| "description": "API method documentation", | |
| "url": "https://api.slack.com/methods/migration.exchange" | |
| }, | |
| "operationId": "migration_exchange", | |
| "parameters": [ | |
| { | |
| "description": "Authentication token. Requires scope: `tokens.basic`", | |
| "in": "query", | |
| "name": "token", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "description": "Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`.", | |
| "in": "query", | |
| "name": "to_old", | |
| "type": "boolean" | |
| }, | |
| { | |
| "description": "A comma-separated list of user ids, up to 400 per request", | |
| "in": "query", | |
| "name": "users", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Typical success response when mappings exist for the specified user IDs", | |
| "examples": { | |
| "application/json": { | |
| "enterprise_id": "E1KQTNXE1", | |
| "invalid_user_ids": [ | |
| "U21ABZZXX" | |
| ], | |
| "ok": true, | |
| "team_id": "T1KR7PE1W", | |
| "user_id_map": { | |
| "U06UBSUN5": "W06M56XJM", | |
| "U06UBSVB3": "W06PUUDLY", | |
| "U06UBSVDX": "W06PUUDMW", | |
| "U06UEB62U": "W06PTT6GH", | |
| "W06UAZ65Q": "W06UAZ65Q" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "additionalProperties": true, | |
| "description": "Schema for successful response from migration.exchange method", | |
| "properties": { | |
| "enterprise_id": { | |
| "title": "The enterprise grid organization ID containing the workspace/team.", | |
| "type": "string" | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment