{ "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": "^[WU][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_optional_app_id": { "pattern": "^(A[A-Z0-9]{1,})?$", "title": "App ID or empty string", "type": "string" }, "defs_pinned_info": { "additionalProperties": false, "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": { "additionalProperties": false, "properties": { "app_id": { "$ref": "#/definitions/defs_app_id" }, "deleted": { "type": "boolean" }, "icons": { "additionalProperties": false, "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": { "additionalProperties": false, "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": { "additionalProperties": false, "properties": { "creator": { "$ref": "#/definitions/defs_topic_purpose_creator" }, "last_set": { "type": "integer" }, "value": { "type": "string" } }, "required": [ "value", "creator", "last_set" ], "type": "object" }, "topic": { "additionalProperties": false, "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": { "additionalProperties": false, "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": [ { "additionalProperties": false, "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": { "additionalProperties": false, "properties": { "display_counts": { "type": "integer" }, "guest_counts": { "type": "integer" } }, "required": [ "display_counts", "guest_counts" ], "type": "object" }, "enterprise_id": { "$ref": "#/definitions/defs_enterprise_id" }, "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": { "additionalProperties": false, "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": { "additionalProperties": false, "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": { "additionalProperties": false, "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" }, { "additionalProperties": false, "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": { "additionalProperties": false, "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": { "additionalProperties": false, "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": { "additionalProperties": false, "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": { "additionalProperties": false, "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" }, { "additionalProperties": false, "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": { "additionalProperties": false, "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": { "additionalProperties": false, "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" }, "type": "array", "uniqueItems": true } }, "required": [ "id", "enterprise_id", "enterprise_name", "is_admin", "is_owner", "teams" ], "type": "object" }, "objs_external_org_migrations": { "properties": { "current": { "items": { "properties": { "date_started": { "type": "integer" }, "team_id": { "type": "string" } }, "required": [ "team_id", "date_started" ], "type": "object" }, "type": "array" }, "date_updated": { "type": "integer" } }, "required": [ "date_updated", "current" ], "title": "External Org Migrations", "type": "object" }, "objs_file": { "additionalProperties": false, "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": { "additionalProperties": false, "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_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_message": { "additionalProperties": false, "properties": { "attachments": { "items": { "additionalProperties": false, "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": { "additionalProperties": false, "properties": { "emoji": { "type": "string" }, "image_64": { "format": "uri", "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": { "additionalProperties": false, "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_primary_owner": { "properties": { "email": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id", "email" ], "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": { "additionalProperties": false, "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": { "additionalProperties": false, "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": { "items": [ { "additionalProperties": false, "properties": { "next_cursor": { "type": "string" } }, "required": [ "next_cursor" ], "title": "new paging style", "type": "object" }, { "additionalProperties": false, "properties": { "messages": { "items": { "type": "string" }, "type": "array" }, "warnings": { "items": { "enum": [ "method_deprecated" ], "type": "string" }, "type": "array" } }, "required": [ "messages", "warnings" ], "title": "deprecation_warning", "type": "object" }, { "additionalProperties": false, "properties": { "messages": { "items": { "type": "string" }, "type": "array" }, "next_cursor": { "type": "string" }, "warnings": { "items": { "enum": [ "method_deprecated" ], "type": "string" }, "type": "array" } }, "required": [ "messages", "warnings", "next_cursor" ], "title": "deprecation_warning and paging style together", "type": "object" } ] }, "objs_scopes": { "items": { "title": "Named OAuth scopes", "type": "string", "x-examples": [ "chat:write", "im:history", "im:read" ] }, "type": "array" }, "objs_subteam": { "additionalProperties": false, "properties": { "auto_provision": { "type": "boolean" }, "auto_type": { "items": [ { "type": "null" }, { "enum": [ "owner", "admin" ], "type": "string" } ] }, "channel_count": { "type": "integer" }, "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": { "additionalProperties": false, "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": { "additionalProperties": false, "properties": { "archived": { "type": "boolean" }, "avatar_base_url": { "format": "uri", "type": "string" }, "created": { "type": "integer" }, "date_create": { "type": "integer" }, "deleted": { "type": "boolean" }, "description": { "type": [ "null", "string" ] }, "discoverable": { "items": [ { "type": "null" }, { "type": "string" } ] }, "domain": { "type": "string" }, "email_domain": { "type": "string" }, "enterprise_id": { "$ref": "#/definitions/defs_enterprise_id" }, "enterprise_name": { "$ref": "#/definitions/defs_enterprise_name" }, "external_org_migrations": { "$ref": "#/definitions/objs_external_org_migrations" }, "has_compliance_export": { "type": "boolean" }, "icon": { "$ref": "#/definitions/objs_icon" }, "id": { "$ref": "#/definitions/defs_workspace_id" }, "is_assigned": { "type": "boolean" }, "is_enterprise": { "type": "integer" }, "is_over_storage_limit": { "type": "boolean" }, "limit_ts": { "type": "integer" }, "locale": { "type": "string" }, "messages_count": { "type": "integer" }, "msg_edit_window_mins": { "type": "integer" }, "name": { "type": "string" }, "over_integrations_limit": { "type": "boolean" }, "over_storage_limit": { "type": "boolean" }, "pay_prod_cur": { "type": "string" }, "plan": { "enum": [ "", "std", "plus", "compliance", "enterprise" ], "type": "string" }, "primary_owner": { "$ref": "#/definitions/objs_primary_owner" }, "sso_provider": { "properties": { "label": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } }, "required": [ "id", "name", "domain", "email_domain", "icon" ], "title": "Team Object", "type": "object" }, "objs_team_profile_field": { "additionalProperties": false, "properties": { "field_name": { "type": [ "null", "string" ] }, "hint": { "type": "string" }, "id": { "pattern": "^X[a-zA-Z0-9]{9,}$", "type": "string" }, "is_hidden": { "type": "boolean" }, "label": { "type": "string" }, "options": { "items": [ { "type": "null" }, { "$ref": "#/definitions/objs_team_profile_field_option" } ] }, "ordering": { "type": "number" }, "possible_values": { "items": { "type": "string" }, "type": [ "null", "array" ] }, "type": { "enum": [ "text", "date", "link", "mailto", "options_list", "user" ], "type": "string" } }, "required": [ "id", "ordering", "label", "hint", "type" ], "type": "object" }, "objs_team_profile_field_option": { "additionalProperties": false, "properties": { "is_custom": { "type": [ "null", "boolean" ] }, "is_multiple_entry": { "type": [ "null", "boolean" ] }, "is_protected": { "type": [ "null", "boolean" ] }, "is_scim": { "type": [ "null", "boolean" ] } }, "type": "object" }, "objs_user": { "items": [ { "additionalProperties": false, "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_forgotten": { "type": "boolean" }, "is_invited_user": { "type": "boolean" }, "is_owner": { "type": "boolean" }, "is_primary_owner": { "type": "boolean" }, "is_restricted": { "type": "boolean" }, "is_stranger": { "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_workspace_id" }, "team_id": { "$ref": "#/definitions/defs_workspace_id" }, "team_profile": { "additionalProperties": false, "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", "profile", "is_bot", "updated", "is_app_user" ], "type": "object" }, { "additionalProperties": false, "description": "enterprise user", "properties": { "color": { "description": "refercing to bug: https://jira.tinyspeck.com/browse/EVALUE-1559", "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_forgotten": { "type": "boolean" }, "is_owner": { "type": "boolean" }, "is_primary_owner": { "type": "boolean" }, "is_restricted": { "type": "boolean" }, "is_stranger": { "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_workspace_id" }, "team_profile": { "additionalProperties": false, "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", "profile", "is_bot", "updated", "is_app_user" ], "type": "object" } ] }, "objs_user_profile": { "additionalProperties": false, "properties": { "always_active": { "type": "boolean" }, "api_app_id": { "$ref": "#/definitions/defs_optional_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": [ "null", "string" ] }, "fields": { "items": { "type": "object" }, "type": [ "object", "null", "array" ] }, "first_name": { "type": [ "null", "string" ] }, "guest_expiration_ts": { "type": [ "null", "integer" ] }, "guest_invited_by": { "type": [ "null", "string" ] }, "image_1024": { "format": "uri", "type": [ "null", "string" ] }, "image_192": { "format": "uri", "type": [ "null", "string" ] }, "image_24": { "format": "uri", "type": [ "null", "string" ] }, "image_32": { "format": "uri", "type": [ "null", "string" ] }, "image_48": { "format": "uri", "type": [ "null", "string" ] }, "image_512": { "format": "uri", "type": [ "null", "string" ] }, "image_72": { "format": "uri", "type": [ "null", "string" ] }, "image_original": { "format": "uri", "type": [ "null", "string" ] }, "is_app_user": { "type": "boolean" }, "is_custom_image": { "type": "boolean" }, "is_restricted": { "type": [ "null", "boolean" ] }, "is_ultra_restricted": { "type": [ "null", "boolean" ] }, "last_avatar_image_hash": { "type": "string" }, "last_name": { "type": [ "null", "string" ] }, "memberships_count": { "type": "integer" }, "name": { "type": [ "null", "string" ] }, "phone": { "type": "string" }, "pronouns": { "type": "string" }, "real_name": { "type": "string" }, "real_name_normalized": { "type": "string" }, "skype": { "type": "string" }, "status_default_emoji": { "type": "string" }, "status_default_text": { "type": "string" }, "status_default_text_canonical": { "type": [ "null", "string" ] }, "status_emoji": { "type": "string" }, "status_expiration": { "type": "integer" }, "status_text": { "type": "string" }, "status_text_canonical": { "type": [ "null", "string" ] }, "team": { "$ref": "#/definitions/defs_workspace_id" }, "title": { "type": "string" }, "updated": { "type": "integer" }, "user_id": { "type": "string" }, "username": { "type": [ "null", "string" ] } }, "required": [ "real_name", "display_name", "avatar_hash", "real_name_normalized", "display_name_normalized", "title", "phone", "skype", "status_text", "status_emoji", "fields" ], "title": "User profile object", "type": "object" }, "objs_user_profile_short": { "additionalProperties": false, "properties": { "avatar_hash": { "type": "string" }, "display_name": { "type": "string" }, "display_name_normalized": { "type": "string" }, "first_name": { "type": [ "string", "null" ] }, "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.7.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": [ { "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" }, { "in": "formData", "name": "team_id", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "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" }, { "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", "in": "query", "name": "cursor", "type": "string" }, { "in": "query", "name": "team_id", "type": "string" }, { "in": "query", "name": "enterprise_id", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "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" }, { "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", "in": "query", "name": "cursor", "type": "string" }, { "in": "query", "name": "team_id", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ { "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" }, { "in": "formData", "name": "team_id", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "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" }, { "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", "in": "query", "name": "cursor", "type": "string" }, { "in": "query", "name": "team_id", "type": "string" }, { "in": "query", "name": "enterprise_id", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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.archive": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Archive a public or private channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.archive" }, "operationId": "admin_conversations_archive", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The channel to archive.", "in": "formData", "name": "channel_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.archive", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "admin.conversations.archive schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.archive", "properties": { "error": { "enum": [ "feature_not_enabled", "channel_not_found", "channel_type_not_supported", "default_org_wide_channel", "already_archived", "cant_archive_general", "restricted_action", "could_not_archive_channel" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.archive error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:write" ] } ], "tags": [ "admin.conversations", "admin" ] } }, "/admin.conversations.convertToPrivate": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Convert a public channel to a private channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.convertToPrivate" }, "operationId": "admin_conversations_convertToPrivate", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The channel to convert to private.", "in": "formData", "name": "channel_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.convertToPrivate", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "admin.conversations.convertToPrivate schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.convertToPrivate", "properties": { "error": { "enum": [ "feature_not_enabled", "restricted_action", "name_taken", "channel_not_found", "channel_type_not_supported", "default_org_wide_channel", "method_not_supported_for_channel_type", "could_not_convert_channel", "external_channel_migrating" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.convertToPrivate error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:write" ] } ], "tags": [ "admin.conversations", "admin" ] } }, "/admin.conversations.create": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Create a public or private channel-based conversation.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.create" }, "operationId": "admin_conversations_create", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Name of the public or private channel to create.", "in": "formData", "name": "name", "required": true, "type": "string" }, { "description": "Description of the public or private channel to create.", "in": "formData", "name": "description", "type": "string" }, { "description": "When `true`, creates a private channel instead of a public channel", "in": "formData", "name": "is_private", "required": true, "type": "boolean" }, { "description": "When `true`, the channel will be available org-wide. Note: if the channel is not `org_wide=true`, you must specify a `team_id` for this channel", "in": "formData", "name": "org_wide", "type": "boolean" }, { "description": "The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`.", "in": "formData", "name": "team_id", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.create", "properties": { "channel_id": { "$ref": "#/definitions/defs_channel_id" }, "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "admin.conversations.create schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.create", "properties": { "error": { "enum": [ "feature_not_enabled", "name_taken", "restricted_action", "team_not_found", "invalid_team", "invalid_name", "could_not_create_channel", "team_id_or_org_required" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.create error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:write" ] } ], "tags": [ "admin.conversations", "admin" ] } }, "/admin.conversations.delete": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Delete a public or private channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.delete" }, "operationId": "admin_conversations_delete", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The channel to delete.", "in": "formData", "name": "channel_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.delete", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "admin.conversations.delete schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.delete", "properties": { "error": { "enum": [ "feature_not_enabled", "not_an_admin", "channel_not_found", "channel_type_not_supported", "default_org_wide_channel", "restricted_action", "could_not_delete_channel", "missing_scope" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.delete error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:write" ] } ], "tags": [ "admin.conversations", "admin" ] } }, "/admin.conversations.disconnectShared": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Disconnect a connected channel from one or more workspaces.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.disconnectShared" }, "operationId": "admin_conversations_disconnectShared", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The channel to be disconnected from some workspaces.", "in": "formData", "name": "channel_id", "required": true, "type": "string" }, { "description": "The team to be removed from the channel. Currently only a single team id can be specified.", "in": "formData", "name": "leaving_team_ids", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.disconnectShared", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "admin.conversations.rename schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.disconnectShared", "properties": { "error": { "enum": [ "feature_not_enabled", "not_an_admin", "not_an_enterprise", "channel_not_found", "not_supported", "team_not_found", "restricted_action", "missing_scope", "leaving_team_not_in_channel", "no_teams_to_disconnect", "leaving_team_required", "cannot_kick_team", "cannot_kick_home_team" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.disconnectShared error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:write" ] } ], "tags": [ "admin.conversations", "admin" ] } }, "/admin.conversations.ekm.listOriginalConnectedChannelInfo": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "List all disconnected channels\u2014i.e., channels that were once connected to other workspaces and then disconnected\u2014and the corresponding original channel IDs for key revocation with EKM.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo" }, "operationId": "admin_conversations_ekm_listOriginalConnectedChannelInfo", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "A comma-separated list of channels to filter to.", "in": "query", "name": "channel_ids", "type": "string" }, { "description": "A comma-separated list of the workspaces to which the channels you would like returned belong.", "in": "query", "name": "team_ids", "type": "string" }, { "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", "in": "query", "name": "limit", "type": "integer" }, { "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", "in": "query", "name": "cursor", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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:read" ] } ], "tags": [ "admin.conversations.ekm", "admin" ] } }, "/admin.conversations.getConversationPrefs": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Get conversation preferences for a public or private channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.getConversationPrefs" }, "operationId": "admin_conversations_getConversationPrefs", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:read`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The channel to get preferences for.", "in": "query", "name": "channel_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.getConversationPrefs", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "prefs": { "properties": { "can_thread": { "properties": { "type": { "items": { "type": "string" }, "type": "array" }, "user": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "who_can_post": { "properties": { "type": { "items": { "type": "string" }, "type": "array" }, "user": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "type": "object" } }, "required": [ "ok" ], "title": "admin.conversations.getConversationPrefs schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.getConversationPrefs", "properties": { "error": { "enum": [ "feature_not_enabled", "not_an_admin", "not_an_enterprise", "restricted_action", "missing_scope", "channel_not_found", "channel_type_not_supported", "could_not_get_conversation_prefs" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.unarchive error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:read" ] } ], "tags": [ "admin.conversations", "admin" ] } }, "/admin.conversations.getTeams": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Get all the workspaces a given public or private channel is connected to within this Enterprise org.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.getTeams" }, "operationId": "admin_conversations_getTeams", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:read`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The channel to determine connected workspaces within the organization for.", "in": "query", "name": "channel_id", "required": true, "type": "string" }, { "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": "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", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.getTeams", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "response_metadata": { "additionalProperties": false, "properties": { "next_cursor": { "type": "string" } }, "required": [ "next_cursor" ], "type": "object" }, "team_ids": { "items": { "$ref": "#/definitions/defs_team" }, "type": "array" } }, "required": [ "ok", "team_ids" ], "title": "admin.conversations.getTeams schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.getTeams", "properties": { "error": { "enum": [ "feature_not_enabled", "channel_not_found", "channel_type_not_supported", "unsupported_team_type", "restricted_action", "could_not_get_teams", "invalid_cursor", "invalid_limit" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.getTeams error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:read" ] } ], "tags": [ "admin.conversations", "admin" ] } }, "/admin.conversations.invite": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Invite a user to a public or private channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.invite" }, "operationId": "admin_conversations_invite", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The users to invite.", "in": "formData", "name": "user_ids", "required": true, "type": "string" }, { "description": "The channel that the users will be invited to.", "in": "formData", "name": "channel_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.invite", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "admin.conversations.invite schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": true, "description": "Schema for error response from admin.conversations.invite", "properties": { "error": { "enum": [ "feature_not_enabled", "channel_not_found", "channel_type_not_supported", "default_org_wide_channel", "restricted_action", "user_must_be_admin", "failed_for_some_users" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.invite error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:write" ] } ], "tags": [ "admin.conversations", "admin" ] } }, "/admin.conversations.rename": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Rename a public or private channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.rename" }, "operationId": "admin_conversations_rename", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The channel to rename.", "in": "formData", "name": "channel_id", "required": true, "type": "string" }, { "in": "formData", "name": "name", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.rename", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "admin.conversations.rename schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.rename", "properties": { "error": { "enum": [ "feature_not_enabled", "channel_not_found", "channel_type_not_supported", "restricted_action", "could_not_rename_channel", "default_org_wide_channel", "name_taken" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.unarchive error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:write" ] } ], "tags": [ "admin.conversations", "admin" ] } }, "/admin.conversations.restrictAccess.addGroup": { "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Add an allowlist of IDP groups for accessing a channel", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup" }, "operationId": "admin_conversations_restrictAccess_addGroup", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "formData", "name": "token", "required": true, "type": "string" }, { "description": "The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.", "in": "formData", "name": "team_id", "type": "string" }, { "description": "The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to be an allowlist for the private channel.", "in": "formData", "name": "group_id", "required": true, "type": "string" }, { "description": "The channel to link this group to.", "in": "formData", "name": "channel_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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.restrictAccess", "admin" ] } }, "/admin.conversations.restrictAccess.listGroups": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "List all IDP Groups linked to a channel", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups" }, "operationId": "admin_conversations_restrictAccess_listGroups", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "in": "query", "name": "channel_id", "required": true, "type": "string" }, { "description": "The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.", "in": "query", "name": "team_id", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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:read" ] } ], "tags": [ "admin.conversations.restrictAccess", "admin" ] } }, "/admin.conversations.restrictAccess.removeGroup": { "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Remove a linked IDP group linked from a private channel", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup" }, "operationId": "admin_conversations_restrictAccess_removeGroup", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "formData", "name": "token", "required": true, "type": "string" }, { "description": "The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.", "in": "formData", "name": "team_id", "required": true, "type": "string" }, { "description": "The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to remove from the private channel.", "in": "formData", "name": "group_id", "required": true, "type": "string" }, { "description": "The channel to remove the linked group from.", "in": "formData", "name": "channel_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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.restrictAccess", "admin" ] } }, "/admin.conversations.search": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Search for public or private channels in an Enterprise organization.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.search" }, "operationId": "admin_conversations_search", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:read`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Comma separated string of team IDs, signifying the workspaces to search through.", "in": "query", "name": "team_ids", "type": "string" }, { "description": "Name of the the channel to query by.", "in": "query", "name": "query", "type": "string" }, { "description": "Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.", "in": "query", "name": "limit", "type": "integer" }, { "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": "The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types).", "in": "query", "name": "search_channel_types", "type": "string" }, { "description": "Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted ", "in": "query", "name": "sort", "type": "string" }, { "description": "Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)", "in": "query", "name": "sort_dir", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.search", "properties": { "channels": { "items": { "$ref": "#/definitions/objs_channel" }, "type": "array" }, "next_cursor": { "type": "string" } }, "required": [ "channels", "next_cursor" ], "title": "admin.conversations.search schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.search", "properties": { "error": { "enum": [ "feature_not_enabled", "not_an_admin", "not_an_enterprise", "team_not_found", "not_allowed", "invalid_auth", "invalid_cursor", "invalid_search_channel_type", "invalid_sort", "invalid_sort_dir" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.search error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:read" ] } ], "tags": [ "admin.conversations", "admin" ] } }, "/admin.conversations.setConversationPrefs": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Set the posting permissions for a public or private channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.setConversationPrefs" }, "operationId": "admin_conversations_setConversationPrefs", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The channel to set the prefs for", "in": "formData", "name": "channel_id", "required": true, "type": "string" }, { "description": "The prefs for this channel in a stringified JSON format.", "in": "formData", "name": "prefs", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.setConversationPrefs", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "admin.conversations.setConversationPrefs schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.setConversationPrefs", "properties": { "error": { "enum": [ "feature_not_enabled", "not_an_admin", "channel_not_found", "channel_type_not_supported", "restricted_action", "missing_scope", "could_not_set_channel_pref", "default_org_wide_channel" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.setConversationPrefs error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin.conversations:write" ] } ], "tags": [ "admin.conversations", "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 public or private channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.setTeams" }, "operationId": "admin_conversations_setTeams", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The encoded `channel_id` to add or remove to workspaces.", "in": "formData", "name": "channel_id", "required": true, "type": "string" }, { "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": "A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.", "in": "formData", "name": "target_team_ids", "type": "string" }, { "description": "True if channel has to be converted to an org channel", "in": "formData", "name": "org_channel", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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.conversations.unarchive": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Unarchive a public or private channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.conversations.unarchive" }, "operationId": "admin_conversations_unarchive", "parameters": [ { "description": "Authentication token. Requires scope: `admin.conversations:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The channel to unarchive.", "in": "formData", "name": "channel_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of admin.conversations.unarchive", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "admin.conversations.unarchive schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from admin.conversations.unarchive", "properties": { "error": { "enum": [ "feature_not_enabled", "channel_not_found", "channel_not_archived", "channel_type_not_supported", "restricted_action", "could_not_unarchive_channel", "default_org_wide_channel", "missing_scope" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "admin.conversations.unarchive error schema", "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": "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" }, { "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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", "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", "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": "Authentication token. Requires scope: `admin.teams:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "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": "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", "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", "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", "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", "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": "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" }, { "description": "The new name of the emoji.", "in": "formData", "name": "new_name", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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", "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", "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": "Authentication token. Requires scope: `admin.invites:read`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "ID for the workspace where the invite requests were made.", "in": "query", "name": "team_id", "type": "string" }, { "description": "Value of the `next_cursor` field sent as part of the previous API response", "in": "query", "name": "cursor", "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Authentication token. Requires scope: `admin.invites:read`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "ID for the workspace where the invite requests were made.", "in": "query", "name": "team_id", "type": "string" }, { "description": "Value of the `next_cursor` field sent as part of the previous api response", "in": "query", "name": "cursor", "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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", "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", "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": "Authentication token. Requires scope: `admin.invites:read`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "ID for the workspace where the invite requests were made.", "in": "query", "name": "team_id", "type": "string" }, { "description": "Value of the `next_cursor` field sent as part of the previous API response", "in": "query", "name": "cursor", "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "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" }, { "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", "in": "query", "name": "cursor", "type": "string" }, { "in": "query", "name": "team_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Authentication token. Requires scope: `admin.teams:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Team domain (for example, slacksoftballteam).", "in": "formData", "name": "team_domain", "required": true, "type": "string" }, { "description": "Team name (for example, Slack Softball Team).", "in": "formData", "name": "team_name", "required": true, "type": "string" }, { "description": "Description for the team.", "in": "formData", "name": "team_description", "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", "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", "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": "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" }, { "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", "in": "query", "name": "cursor", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Authentication token. Requires scope: `admin.teams:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "in": "query", "name": "team_id", "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" }, { "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", "in": "query", "name": "cursor", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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", "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", "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": "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" }, { "description": "An array of channel IDs.", "in": "formData", "name": "channel_ids", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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.usergroups.addChannels": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Add one or more default channels to an IDP group.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.usergroups.addChannels" }, "operationId": "admin_usergroups_addChannels", "parameters": [ { "description": "Authentication token. Requires scope: `admin.usergroups:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "ID of the IDP group to add default channels for.", "in": "formData", "name": "usergroup_id", "required": true, "type": "string" }, { "description": "The workspace to add default channels in.", "in": "formData", "name": "team_id", "type": "string" }, { "description": "Comma separated string of channel IDs.", "in": "formData", "name": "channel_ids", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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 if the token provided is not associated with an Org Admin or Owner", "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.usergroups:write" ] } ], "tags": [ "admin.usergroups", "admin" ] } }, "/admin.usergroups.addTeams": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Associate one or more default workspaces with an organization-wide IDP group.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.usergroups.addTeams" }, "operationId": "admin_usergroups_addTeams", "parameters": [ { "description": "Authentication token. Requires scope: `admin.teams:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "An encoded usergroup (IDP Group) ID.", "in": "formData", "name": "usergroup_id", "required": true, "type": "string" }, { "description": "A comma separated list of encoded team (workspace) IDs. Each workspace *MUST* belong to the organization associated with the token.", "in": "formData", "name": "team_ids", "required": true, "type": "string" }, { "description": "When `true`, this method automatically creates new workspace accounts for the IDP group members.", "in": "formData", "name": "auto_provision", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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.usergroups", "admin" ] } }, "/admin.usergroups.listChannels": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "List the channels linked to an org-level IDP group (user group).", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.usergroups.listChannels" }, "operationId": "admin_usergroups_listChannels", "parameters": [ { "description": "Authentication token. Requires scope: `admin.usergroups:read`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "ID of the IDP group to list default channels for.", "in": "query", "name": "usergroup_id", "required": true, "type": "string" }, { "description": "ID of the the workspace.", "in": "query", "name": "team_id", "type": "string" }, { "description": "Flag to include or exclude the count of members per channel.", "in": "query", "name": "include_num_members", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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 if the token provided is not associated with an Org Admin or Owner", "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.usergroups:read" ] } ], "tags": [ "admin.usergroups", "admin" ] } }, "/admin.usergroups.removeChannels": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Remove one or more default channels from an org-level IDP group (user group).", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.usergroups.removeChannels" }, "operationId": "admin_usergroups_removeChannels", "parameters": [ { "description": "Authentication token. Requires scope: `admin.usergroups:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "ID of the IDP Group", "in": "formData", "name": "usergroup_id", "required": true, "type": "string" }, { "description": "Comma-separated string of channel IDs", "in": "formData", "name": "channel_ids", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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 if the token provided is not associated with an Org Admin or Owner", "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.usergroups:write" ] } ], "tags": [ "admin.usergroups", "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": "Authentication token. Requires scope: `admin.users:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The ID (`T1234`) of the workspace.", "in": "formData", "name": "team_id", "required": true, "type": "string" }, { "description": "The ID of the user to add to the workspace.", "in": "formData", "name": "user_id", "required": true, "type": "string" }, { "description": "True if user should be added to the workspace as a guest.", "in": "formData", "name": "is_restricted", "type": "boolean" }, { "description": "True if user should be added to the workspace as a single-channel guest.", "in": "formData", "name": "is_ultra_restricted", "type": "boolean" }, { "description": "Comma separated values of channel IDs to add user in the new workspace.", "in": "formData", "name": "channel_ids", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Authentication token. Requires scope: `admin.users:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The ID (`T1234`) of the workspace.", "in": "formData", "name": "team_id", "required": true, "type": "string" }, { "description": "The email address of the person to invite.", "in": "formData", "name": "email", "required": true, "type": "string" }, { "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": "An optional message to send to the user in the invite email.", "in": "formData", "name": "custom_message", "type": "string" }, { "description": "Full name of the user.", "in": "formData", "name": "real_name", "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" }, { "description": "Is this user a multi-channel guest user? (default: false)", "in": "formData", "name": "is_restricted", "type": "boolean" }, { "description": "Is this user a single channel guest user? (default: false)", "in": "formData", "name": "is_ultra_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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Authentication token. Requires scope: `admin.users:read`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The ID (`T1234`) of the workspace.", "in": "query", "name": "team_id", "required": true, "type": "string" }, { "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": "Limit for how many users to be retrieved per page", "in": "query", "name": "limit", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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 (`T1234`) of the workspace.", "in": "formData", "name": "team_id", "required": true, "type": "string" }, { "description": "The ID of the user to remove.", "in": "formData", "name": "user_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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.invalidate": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Invalidate a single session for a user by session_id", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.users.session.invalidate" }, "operationId": "admin_users_session_invalidate", "parameters": [ { "description": "Authentication token. Requires scope: `admin.users:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "ID of the team that the session belongs to", "in": "formData", "name": "team_id", "required": true, "type": "string" }, { "in": "formData", "name": "session_id", "required": true, "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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.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": "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 mobile sessions (default: false)", "in": "formData", "name": "mobile_only", "type": "boolean" }, { "description": "Only expire web sessions (default: false)", "in": "formData", "name": "web_only", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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 (`T1234`) of the workspace.", "in": "formData", "name": "team_id", "required": true, "type": "string" }, { "description": "The ID of the user to designate as an admin.", "in": "formData", "name": "user_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Authentication token. Requires scope: `admin.users:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The ID (`T1234`) of the workspace.", "in": "formData", "name": "team_id", "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": "Timestamp when guest account should be disabled.", "in": "formData", "name": "expiration_ts", "required": true, "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "The ID (`T1234`) of the workspace.", "in": "formData", "name": "team_id", "required": true, "type": "string" }, { "description": "Id of the user to promote to owner.", "in": "formData", "name": "user_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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 (`T1234`) of the workspace.", "in": "formData", "name": "team_id", "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Error response to return", "in": "query", "name": "error", "type": "string" }, { "description": "example property to return", "in": "query", "name": "foo", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Standard success response", "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", "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.event.authorizations.list": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/apps.event.authorizations.list" }, "operationId": "apps_event_authorizations_list", "parameters": [ { "description": "Authentication token. Requires scope: `authorizations:read`", "in": "header", "name": "token", "required": true, "type": "string" }, { "in": "query", "name": "event_context", "required": true, "type": "string" }, { "in": "query", "name": "cursor", "type": "string" }, { "in": "query", "name": "limit", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "authorizations:read" ] } ], "tags": [ "apps.event.authorizations", "apps" ] } }, "/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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from apps.permissions.info method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `none`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "A comma separated list of scopes to request for", "in": "query", "name": "scopes", "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from apps.permissions.request method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `none`", "in": "query", "name": "token", "required": true, "type": "string" }, { "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": "The maximum number of items to return.", "in": "query", "name": "limit", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical successful paginated response", "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": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from apps.permissions.resources.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "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", "schema": { "additionalProperties": false, "description": "Schema for error response from apps.permissions.scopes.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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.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": "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" }, { "description": "Issued when you created your application.", "in": "query", "name": "client_secret", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from apps.uninstall method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `none`", "in": "query", "name": "token", "required": true, "type": "string" }, { "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from auth.revoke method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "schema": { "additionalProperties": false, "description": "Schema for successful response auth.test method", "properties": { "bot_id": { "$ref": "#/definitions/defs_bot_id" }, "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", "schema": { "additionalProperties": false, "description": "Schema for error response auth.test method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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.", "schema": { "additionalProperties": false, "description": "Schema for successful response from bots.info method", "properties": { "bot": { "additionalProperties": false, "properties": { "app_id": { "$ref": "#/definitions/defs_app_id" }, "deleted": { "type": "boolean" }, "icons": { "additionalProperties": false, "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.", "schema": { "additionalProperties": false, "description": "Schema for error response from bots.info method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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" ] } }, "/calls.add": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Registers a new Call.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/calls.add" }, "operationId": "calls_add", "parameters": [ { "description": "Authentication token. Requires scope: `calls:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.", "in": "formData", "name": "external_unique_id", "required": true, "type": "string" }, { "description": "An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.", "in": "formData", "name": "external_display_id", "type": "string" }, { "description": "The URL required for a client to join the Call.", "in": "formData", "name": "join_url", "required": true, "type": "string" }, { "description": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.", "in": "formData", "name": "desktop_app_join_url", "type": "string" }, { "description": "Call start time in UTC UNIX timestamp format", "in": "formData", "name": "date_start", "type": "integer" }, { "description": "The name of the Call.", "in": "formData", "name": "title", "type": "string" }, { "description": "The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required.", "in": "formData", "name": "created_by", "type": "string" }, { "description": "The list of users to register as participants in the Call. [Read more on how to specify users here](/apis/calls#users).", "in": "formData", "name": "users", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "calls:write" ] } ], "tags": [ "calls" ] } }, "/calls.end": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Ends a Call.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/calls.end" }, "operationId": "calls_end", "parameters": [ { "description": "Authentication token. Requires scope: `calls:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "`id` returned when registering the call using the [`calls.add`](/methods/calls.add) method.", "in": "formData", "name": "id", "required": true, "type": "string" }, { "description": "Call duration in seconds", "in": "formData", "name": "duration", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "calls:write" ] } ], "tags": [ "calls" ] } }, "/calls.info": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Returns information about a Call.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/calls.info" }, "operationId": "calls_info", "parameters": [ { "description": "Authentication token. Requires scope: `calls:read`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "`id` of the Call returned by the [`calls.add`](/methods/calls.add) method.", "in": "query", "name": "id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "calls:read" ] } ], "tags": [ "calls" ] } }, "/calls.participants.add": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Registers new participants added to a Call.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/calls.participants.add" }, "operationId": "calls_participants_add", "parameters": [ { "description": "Authentication token. Requires scope: `calls:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "`id` returned by the [`calls.add`](/methods/calls.add) method.", "in": "formData", "name": "id", "required": true, "type": "string" }, { "description": "The list of users to add as participants in the Call. [Read more on how to specify users here](/apis/calls#users).", "in": "formData", "name": "users", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "calls:write" ] } ], "tags": [ "calls.participants", "calls" ] } }, "/calls.participants.remove": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Registers participants removed from a Call.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/calls.participants.remove" }, "operationId": "calls_participants_remove", "parameters": [ { "description": "Authentication token. Requires scope: `calls:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "`id` returned by the [`calls.add`](/methods/calls.add) method.", "in": "formData", "name": "id", "required": true, "type": "string" }, { "description": "The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users).", "in": "formData", "name": "users", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "calls:write" ] } ], "tags": [ "calls.participants", "calls" ] } }, "/calls.update": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Updates information about a Call.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/calls.update" }, "operationId": "calls_update", "parameters": [ { "description": "Authentication token. Requires scope: `calls:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "`id` returned by the [`calls.add`](/methods/calls.add) method.", "in": "formData", "name": "id", "required": true, "type": "string" }, { "description": "The name of the Call.", "in": "formData", "name": "title", "type": "string" }, { "description": "The URL required for a client to join the Call.", "in": "formData", "name": "join_url", "type": "string" }, { "description": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.", "in": "formData", "name": "desktop_app_join_url", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "calls:write" ] } ], "tags": [ "calls" ] } }, "/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": "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" }, { "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from chat.delete method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "message_not_found", "channel_not_found", "cant_delete_message", "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": "Authentication token. Requires scope: `chat:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "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": "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from chat.deleteScheduledMessage method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "The ID of the conversation or channel containing the message", "in": "query", "name": "channel", "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Standard success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from chat.getPermalink method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `chat:write`", "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" }, { "description": "Text of the message to send.", "in": "formData", "name": "text", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from chat.meMessage method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "chat:write:bot" ] } ], "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": "Authentication token. Requires scope: `chat:write`", "in": "header", "name": "token", "required": true, "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": "A JSON-based array of structured attachments, presented as a URL-encoded string.", "in": "formData", "name": "attachments", "type": "string" }, { "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", "in": "formData", "name": "blocks", "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" }, { "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": "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": "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": "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": "`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": "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from chat.postEphemeral method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `chat:write`", "in": "header", "name": "token", "required": true, "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": "A JSON-based array of structured attachments, presented as a URL-encoded string.", "in": "formData", "name": "attachments", "type": "string" }, { "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", "in": "formData", "name": "blocks", "type": "string" }, { "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": "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": "Find and link channel names and usernames.", "in": "formData", "name": "link_names", "type": "boolean" }, { "description": "Disable Slack markup parsing by setting to `false`. Enabled by default.", "in": "formData", "name": "mrkdwn", "type": "boolean" }, { "description": "Change how messages are treated. Defaults to `none`. See [below](#formatting).", "in": "formData", "name": "parse", "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" }, { "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": "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": "Pass true to enable unfurling of primarily text-based content.", "in": "formData", "name": "unfurl_links", "type": "boolean" }, { "description": "Pass false to disable unfurling of media content.", "in": "formData", "name": "unfurl_media", "type": "boolean" }, { "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response chat.postMessage method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `chat:write`", "in": "header", "name": "token", "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": "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": "Unix EPOCH timestamp of time in future to send the message.", "in": "formData", "name": "post_at", "type": "string" }, { "description": "Change how messages are treated. Defaults to `none`. See [chat.postMessage](chat.postMessage#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 [chat.postMessage](chat.postMessage#authorship).", "in": "formData", "name": "as_user", "type": "boolean" }, { "description": "Find and link channel names and usernames.", "in": "formData", "name": "link_names", "type": "boolean" }, { "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", "in": "formData", "name": "attachments", "type": "string" }, { "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", "in": "formData", "name": "blocks", "type": "string" }, { "description": "Pass true to enable unfurling of primarily text-based content.", "in": "formData", "name": "unfurl_links", "type": "boolean" }, { "description": "Pass false to disable unfurling of media content.", "in": "formData", "name": "unfurl_media", "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": "number" }, { "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", "schema": { "additionalProperties": false, "description": "Schema for successful response of chat.scheduleMessage method", "properties": { "channel": { "$ref": "#/definitions/defs_channel" }, "message": { "additionalProperties": false, "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)", "schema": { "additionalProperties": false, "description": "Schema for error response chat.scheduleMessage method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `none`", "in": "header", "name": "token", "type": "string" }, { "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" }, { "description": "A UNIX timestamp of the oldest value in the time range", "in": "query", "name": "oldest", "type": "number" }, { "description": "Maximum number of original entries to return.", "in": "query", "name": "limit", "type": "integer" }, { "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from chat.scheduledMessages.list method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "response_metadata": { "additionalProperties": false, "properties": { "next_cursor": { "type": "string" } }, "required": [ "next_cursor" ], "type": "object" }, "scheduled_messages": { "items": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from chat.scheduledMessages.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "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" }, { "description": "Timestamp of the message to add unfurl behavior to.", "in": "formData", "name": "ts", "required": true, "type": "string" }, { "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": "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": "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical, minimal success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from chat.unfurl method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `chat:write`", "in": "header", "name": "token", "required": true, "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": "A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting `text`. If you don't include this field, the message's previous `attachments` will be retained. To remove previous `attachments`, include an empty array for this field.", "in": "formData", "name": "attachments", "type": "string" }, { "description": "A JSON-based array of [structured blocks](/block-kit/building), presented as a URL-encoded string. If you don't include this field, the message's previous `blocks` will be retained. To remove previous `blocks`, include an empty array for this field.", "in": "formData", "name": "blocks", "type": "string" }, { "description": "Channel containing the message to be updated.", "in": "formData", "name": "channel", "required": true, "type": "string" }, { "description": "Find and link channel names and usernames. Defaults to `none`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `none`.", "in": "formData", "name": "link_names", "type": "string" }, { "description": "Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. Accepts either `none` or `full`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `client`.", "in": "formData", "name": "parse", "type": "string" }, { "description": "New text for the message, using the [default formatting rules](/reference/surfaces/formatting). It's not required when presenting `blocks` or `attachments`.", "in": "formData", "name": "text", "type": "string" }, { "description": "Timestamp of the message to be updated.", "in": "formData", "name": "ts", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response of chat.update method", "properties": { "channel": { "type": "string" }, "message": { "properties": { "attachments": { "items": { "type": "object" }, "type": "array" }, "blocks": { "type": "object" }, "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", "schema": { "additionalProperties": false, "description": "Schema for error response chat.update method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.archive method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.close method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `conversations:write`", "in": "header", "name": "token", "type": "string" }, { "description": "Name of the public or private channel to create", "in": "formData", "name": "name", "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)", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.create method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `conversations:history`", "in": "query", "name": "token", "type": "string" }, { "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" }, { "description": "Start of time range of messages to include in results.", "in": "query", "name": "oldest", "type": "number" }, { "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", "in": "query", "name": "inclusive", "type": "boolean" }, { "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": "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response containing a channel's messages", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.history method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "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" }, { "description": "Set to `true` to include the member count for the specified conversation. Defaults to `false`", "in": "query", "name": "include_num_members", "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.)", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.info method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "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" }, { "description": "A comma separated list of user IDs. Up to 1000 users may be listed.", "in": "formData", "name": "users", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response when an invitation is extended", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.invite method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.join method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "ID of conversation to remove user from.", "in": "formData", "name": "channel", "type": "string" }, { "description": "User ID to be removed.", "in": "formData", "name": "user", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response conversations.kick method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.leave method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `conversations:read`", "in": "query", "name": "token", "type": "string" }, { "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" }, { "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": "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response with only public channels", "schema": { "additionalProperties": false, "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": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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.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/conversations.mark" }, "operationId": "conversations_mark", "parameters": [ { "description": "Authentication token. Requires scope: `conversations:write`", "in": "header", "name": "token", "type": "string" }, { "description": "Channel or conversation to set the read cursor for.", "in": "formData", "name": "channel", "type": "string" }, { "description": "Unique identifier of message you want marked as most recently seen in this conversation.", "in": "formData", "name": "ts", "type": "number" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response conversations.mark method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.mark success schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.mark method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "method_not_supported_for_channel_type", "missing_scope", "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", "not_allowed_token_type" ], "type": "string" }, "needed": { "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" }, "provided": { "type": "string" } }, "required": [ "ok", "error" ], "title": "conversations.mark error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "channels:write", "groups:write", "im:write", "mpim:write" ] } ], "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": "Authentication token. Requires scope: `conversations:read`", "in": "query", "name": "token", "type": "string" }, { "description": "ID of the conversation to retrieve members for", "in": "query", "name": "channel", "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": "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical paginated success response", "schema": { "additionalProperties": false, "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": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response conversations.members method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "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" }, { "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": "Boolean, indicates you want the full IM channel definition in the response.", "in": "formData", "name": "return_im", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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" }, { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.open method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "invalid_user_combination", "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": "ID of conversation to rename", "in": "formData", "name": "channel", "type": "string" }, { "description": "New name for conversation.", "in": "formData", "name": "name", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.rename method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `conversations:history`", "in": "query", "name": "token", "type": "string" }, { "description": "Conversation ID to fetch thread from.", "in": "query", "name": "channel", "type": "string" }, { "description": "Unique identifier of a thread's parent message. `ts` must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by `ts` will return - it is just an ordinary, unthreaded message.", "in": "query", "name": "ts", "type": "number" }, { "description": "End of time range of messages to include in results.", "in": "query", "name": "latest", "type": "number" }, { "description": "Start of time range of messages to include in results.", "in": "query", "name": "oldest", "type": "number" }, { "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", "in": "query", "name": "inclusive", "type": "boolean" }, { "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": "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from conversations.replies method", "properties": { "has_more": { "type": "boolean" }, "messages": { "items": { "items": [ { "additionalProperties": false, "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" }, { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.replies method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Conversation to set the purpose of", "in": "formData", "name": "channel", "type": "string" }, { "description": "A new, specialer purpose", "in": "formData", "name": "purpose", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.setPurpose method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "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" }, { "description": "The new topic string. Does not support formatting or linkification.", "in": "formData", "name": "topic", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.setTopic method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from conversations.unarchive method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "The dialog definition. This must be a JSON-encoded string.", "in": "query", "name": "dialog", "required": true, "type": "string" }, { "description": "Exchange a trigger to post to the user.", "in": "query", "name": "trigger_id", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response is quite minimal.", "schema": { "additionalProperties": false, "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.", "schema": { "additionalProperties": false, "description": "Schema for error response from dialog.open method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from dnd.endDnd method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from dnd.endSnooze method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "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", "schema": { "additionalProperties": false, "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" ], "title": "dnd.info schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from dnd.info method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "Authentication token. Requires scope: `dnd:write`", "in": "formData", "name": "token", "required": true, "type": "string" }, { "description": "Number of minutes, from now, to snooze until.", "in": "formData", "name": "num_minutes", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from dnd.setSnooze method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "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", "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": [ "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", "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", "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": "File to delete a comment from.", "in": "formData", "name": "file", "type": "string" }, { "description": "The comment to delete.", "in": "formData", "name": "id", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Standard success response is very simple", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response files.comments.delete method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response files.delete method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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 file.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/files.info" }, "operationId": "files_info", "parameters": [ { "description": "Authentication token. Requires scope: `files:read`", "in": "query", "name": "token", "type": "string" }, { "description": "Specify a file by providing its ID.", "in": "query", "name": "file", "type": "string" }, { "in": "query", "name": "count", "type": "string" }, { "in": "query", "name": "page", "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": "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from files.info method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "List for a team, in a channel, or from a user with applied filters.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/files.list" }, "operationId": "files_list", "parameters": [ { "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": "Filter files appearing in a specific channel, indicated by its ID.", "in": "query", "name": "channel", "type": "string" }, { "description": "Filter files created after this timestamp (inclusive).", "in": "query", "name": "ts_from", "type": "number" }, { "description": "Filter files created before this timestamp (inclusive).", "in": "query", "name": "ts_to", "type": "number" }, { "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" }, { "in": "query", "name": "count", "type": "string" }, { "in": "query", "name": "page", "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from files.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "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": "Title of the file being shared.", "in": "formData", "name": "title", "type": "string" }, { "description": "type of file", "in": "formData", "name": "filetype", "type": "string" }, { "description": "URL of the remote file.", "in": "formData", "name": "external_url", "type": "string" }, { "description": "Preview of the document via `multipart/form-data`.", "in": "formData", "name": "preview_image", "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Specify a file by providing its ID.", "in": "query", "name": "file", "type": "string" }, { "description": "Creator defined GUID for the file.", "in": "query", "name": "external_id", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Authentication token. Requires scope: `remote_files:read`", "in": "query", "name": "token", "type": "string" }, { "description": "Filter files appearing in a specific channel, indicated by its ID.", "in": "query", "name": "channel", "type": "string" }, { "description": "Filter files created after this timestamp (inclusive).", "in": "query", "name": "ts_from", "type": "number" }, { "description": "Filter files created before this timestamp (inclusive).", "in": "query", "name": "ts_to", "type": "number" }, { "description": "The maximum number of items to return.", "in": "query", "name": "limit", "type": "integer" }, { "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Specify a file by providing its ID.", "in": "formData", "name": "file", "type": "string" }, { "description": "Creator defined GUID for the file.", "in": "formData", "name": "external_id", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "Authentication token. Requires scope: `remote_files:share`", "in": "query", "name": "token", "type": "string" }, { "description": "Specify a file registered with Slack by providing its ID. Either this field or `external_id` or both are required.", "in": "query", "name": "file", "type": "string" }, { "description": "The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or `file` or both are required.", "in": "query", "name": "external_id", "type": "string" }, { "description": "Comma-separated list of channel IDs where the file will be shared.", "in": "query", "name": "channels", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": "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": "Creator defined GUID for the file.", "in": "formData", "name": "external_id", "type": "string" }, { "description": "Title of the file being shared.", "in": "formData", "name": "title", "type": "string" }, { "description": "type of file", "in": "formData", "name": "filetype", "type": "string" }, { "description": "URL of the remote file.", "in": "formData", "name": "external_url", "type": "string" }, { "description": "Preview of the document via `multipart/form-data`.", "in": "formData", "name": "preview_image", "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from files.revokePublicURL method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response from files.sharedPublicURL method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "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": "File contents via a POST variable. If omitting this parameter, you must provide a `file`.", "in": "formData", "name": "content", "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": "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": "Comma-separated list of channel names or IDs where the file will be shared.", "in": "formData", "name": "channels", "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", "schema": { "additionalProperties": false, "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", "schema": { "additionalProperties": false, "description": "Schema for error response files.upload method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "posting_to_general_channel_denied", "invalid_channel", "file_uploads_disabled", "file_upload_size_restricted", "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" ] } }, "/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": "A comma-separated list of user ids, up to 400 per request", "in": "query", "name": "users", "required": true, "type": "string" }, { "description": "Specify team_id starts with `T` in case of Org Token", "in": "query", "name": "team_id", "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response when mappings exist for the specified user IDs", "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" }, "invalid_user_ids": { "items": { "type": "string" }, "title": "A list of User IDs that cannot be mapped or found", "type": "array" }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "team_id": { "$ref": "#/definitions/defs_team" }, "user_id_map": { "additionalProperties": true, "title": "A mapping of provided user IDs with mapped user IDs", "type": "object" } }, "required": [ "ok", "team_id", "enterprise_id" ], "title": "migration.exchange success schema", "type": "object" } }, "default": { "description": "Typical error response when there are no mappings to provide", "schema": { "additionalProperties": false, "description": "Schema for error response from migration.exchange method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "not_enterprise_team", "too_many_users", "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": "migration.exchange error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "tokens.basic" ] } ], "tags": [ "migration" ] } }, "/oauth.access": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Exchanges a temporary OAuth verifier code for an access token.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/oauth.access" }, "operationId": "oauth_access", "parameters": [ { "description": "Issued when you created your application.", "in": "query", "name": "client_id", "type": "string" }, { "description": "Issued when you created your application.", "in": "query", "name": "client_secret", "type": "string" }, { "description": "The `code` param returned via the OAuth callback.", "in": "query", "name": "code", "type": "string" }, { "description": "This must match the originally submitted URI (if one was sent).", "in": "query", "name": "redirect_uri", "type": "string" }, { "description": "Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps).", "in": "query", "name": "single_channel", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful user token negotiation for a single scope", "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", "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": [ "oauth" ] } }, "/oauth.token": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Exchanges a temporary OAuth verifier code for a workspace token.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/oauth.token" }, "operationId": "oauth_token", "parameters": [ { "description": "Issued when you created your application.", "in": "query", "name": "client_id", "type": "string" }, { "description": "Issued when you created your application.", "in": "query", "name": "client_secret", "type": "string" }, { "description": "The `code` param returned via the OAuth callback.", "in": "query", "name": "code", "type": "string" }, { "description": "This must match the originally submitted URI (if one was sent).", "in": "query", "name": "redirect_uri", "type": "string" }, { "description": "Request the user to add your app only to a single channel.", "in": "query", "name": "single_channel", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success example using a workspace app produces a very different kind of response", "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", "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": [ "oauth" ] } }, "/oauth.v2.access": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Exchanges a temporary OAuth verifier code for an access token.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/oauth.v2.access" }, "operationId": "oauth_v2_access", "parameters": [ { "description": "Issued when you created your application.", "in": "query", "name": "client_id", "type": "string" }, { "description": "Issued when you created your application.", "in": "query", "name": "client_secret", "type": "string" }, { "description": "The `code` param returned via the OAuth callback.", "in": "query", "name": "code", "required": true, "type": "string" }, { "description": "This must match the originally submitted URI (if one was sent).", "in": "query", "name": "redirect_uri", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Successful token request with scopes for both a bot user and a user token", "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", "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": [ "oauth.v2", "oauth" ] } }, "/pins.add": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Pins an item to a channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/pins.add" }, "operationId": "pins_add", "parameters": [ { "description": "Authentication token. Requires scope: `pins:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Channel to pin the item in.", "in": "formData", "name": "channel", "required": true, "type": "string" }, { "description": "Timestamp of the message to pin.", "in": "formData", "name": "timestamp", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from pins.add method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "pins.add schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from pins.add method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "bad_timestamp", "message_not_found", "channel_not_found", "no_item_specified", "already_pinned", "permission_denied", "file_not_shared", "not_pinnable", "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": "pins.add error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "pins:write" ] } ], "tags": [ "pins" ] } }, "/pins.list": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Lists items pinned to a channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/pins.list" }, "operationId": "pins_list", "parameters": [ { "description": "Authentication token. Requires scope: `pins:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Channel to get pinned items for.", "in": "query", "name": "channel", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "description": "Schema for successful response from pins.list method", "items": [ { "additionalProperties": false, "properties": { "items": { "items": [ { "additionalProperties": false, "properties": { "created": { "type": "integer" }, "created_by": { "$ref": "#/definitions/defs_user_id" }, "file": { "$ref": "#/definitions/objs_file" }, "type": { "enum": [ "file" ], "type": "string" } }, "title": "File Pin", "type": "object" }, { "additionalProperties": false, "properties": { "channel": { "$ref": "#/definitions/defs_channel" }, "created": { "type": "integer" }, "created_by": { "$ref": "#/definitions/defs_user_id" }, "message": { "$ref": "#/definitions/objs_message" }, "type": { "enum": [ "message" ], "type": "string" } }, "title": "Message Pin", "type": "object" } ], "type": "array", "uniqueItems": true }, "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok", "items" ], "type": "object" }, { "additionalProperties": false, "properties": { "count": { "type": "integer" }, "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok", "count" ], "type": "object" } ], "title": "pins.list success schema" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from pins.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "channel_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", "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": "pins.list error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "pins:read" ] } ], "tags": [ "pins" ] } }, "/pins.remove": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Un-pins an item from a channel.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/pins.remove" }, "operationId": "pins_remove", "parameters": [ { "description": "Authentication token. Requires scope: `pins:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Channel where the item is pinned to.", "in": "formData", "name": "channel", "required": true, "type": "string" }, { "description": "Timestamp of the message to un-pin.", "in": "formData", "name": "timestamp", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from pins.remove method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "pins.remove schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from pins.remove method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "bad_timestamp", "file_not_found", "file_comment_not_found", "message_not_found", "no_item_specified", "not_pinned", "permission_denied", "not_authed", "invalid_auth", "account_inactive", "no_permission", "invalid_arg_name", "invalid_array_arg", "invalid_charset", "invalid_form_data", "invalid_post_typ", "missing_post_typ", "team_added_to_org", "invalid_json", "json_not_object", "request_timeou", "upgrade_required" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "pins.remove error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "pins:write" ] } ], "tags": [ "pins" ] } }, "/reactions.add": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Adds a reaction to an item.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/reactions.add" }, "operationId": "reactions_add", "parameters": [ { "description": "Channel where the message to add reaction to was posted.", "in": "formData", "name": "channel", "required": true, "type": "string" }, { "description": "Reaction (emoji) name.", "in": "formData", "name": "name", "required": true, "type": "string" }, { "description": "Timestamp of the message to add reaction to.", "in": "formData", "name": "timestamp", "required": true, "type": "string" }, { "description": "Authentication token. Requires scope: `reactions:write`", "in": "header", "name": "token", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from reactions.add method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "reactions.add schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from reactions.add method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "bad_timestamp", "message_not_found", "no_item_specified", "invalid_name", "already_reacted", "too_many_emoji", "too_many_reactions", "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": "reactions.add error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "reactions:write" ] } ], "tags": [ "reactions" ] } }, "/reactions.get": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Gets reactions for an item.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/reactions.get" }, "operationId": "reactions_get", "parameters": [ { "description": "Authentication token. Requires scope: `reactions:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Channel where the message to get reactions for was posted.", "in": "query", "name": "channel", "type": "string" }, { "description": "File to get reactions for.", "in": "query", "name": "file", "type": "string" }, { "description": "File comment to get reactions for.", "in": "query", "name": "file_comment", "type": "string" }, { "description": "If true always return the complete reaction list.", "in": "query", "name": "full", "type": "boolean" }, { "description": "Timestamp of the message to get reactions for.", "in": "query", "name": "timestamp", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "description": "Schema for successful response from reactions.get method", "items": [ { "additionalProperties": false, "properties": { "channel": { "$ref": "#/definitions/defs_channel" }, "message": { "$ref": "#/definitions/objs_message" }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "type": { "enum": [ "message" ], "type": "string" } }, "required": [ "ok", "type", "channel", "message" ] }, { "additionalProperties": false, "properties": { "file": { "$ref": "#/definitions/objs_file" }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "type": { "enum": [ "file" ], "type": "string" } }, "required": [ "ok", "type", "file" ] }, { "additionalProperties": false, "properties": { "comment": { "$ref": "#/definitions/objs_comment" }, "file": { "$ref": "#/definitions/objs_file" }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "type": { "enum": [ "file_comment" ], "type": "string" } }, "required": [ "ok", "type", "file", "comment" ] } ], "title": "reactions.get success schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from reactions.get method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "bad_timestamp", "file_not_found", "file_comment_not_found", "message_not_found", "no_item_specified", "not_authed", "invalid_auth", "account_inactive", "no_permission", "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": "reactions.get error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "reactions:read" ] } ], "tags": [ "reactions" ] } }, "/reactions.list": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Lists reactions made by a user.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/reactions.list" }, "operationId": "reactions_list", "parameters": [ { "description": "Authentication token. Requires scope: `reactions:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Show reactions made by this user. Defaults to the authed user.", "in": "query", "name": "user", "type": "string" }, { "description": "If true always return the complete reaction list.", "in": "query", "name": "full", "type": "boolean" }, { "in": "query", "name": "count", "type": "integer" }, { "in": "query", "name": "page", "type": "integer" }, { "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": "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from reactions.list method", "properties": { "items": { "items": { "items": [ { "additionalProperties": false, "properties": { "channel": { "$ref": "#/definitions/defs_channel" }, "message": { "$ref": "#/definitions/objs_message" }, "type": { "enum": [ "message" ], "type": "string" } }, "required": [ "type", "channel", "message" ], "type": "object" }, { "additionalProperties": false, "properties": { "file": { "$ref": "#/definitions/objs_file" }, "type": { "enum": [ "file" ], "type": "string" } }, "required": [ "type", "file" ], "type": "object" }, { "additionalProperties": false, "properties": { "comment": { "$ref": "#/definitions/objs_comment" }, "file": { "$ref": "#/definitions/objs_file" }, "type": { "enum": [ "file_comment" ], "type": "string" } }, "required": [ "type", "file", "comment" ], "type": "object" } ] }, "type": "array" }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "paging": { "$ref": "#/definitions/objs_paging" }, "response_metadata": { "$ref": "#/definitions/objs_response_metadata" } }, "required": [ "ok", "items" ], "title": "reactions.list schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from reactions.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "user_not_found", "not_authed", "invalid_auth", "account_inactiv", "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": "reactions.list error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "reactions:read" ] } ], "tags": [ "reactions" ] } }, "/reactions.remove": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Removes a reaction from an item.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/reactions.remove" }, "operationId": "reactions_remove", "parameters": [ { "description": "Authentication token. Requires scope: `reactions:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Reaction (emoji) name.", "in": "formData", "name": "name", "required": true, "type": "string" }, { "description": "File to remove reaction from.", "in": "formData", "name": "file", "type": "string" }, { "description": "File comment to remove reaction from.", "in": "formData", "name": "file_comment", "type": "string" }, { "description": "Channel where the message to remove reaction from was posted.", "in": "formData", "name": "channel", "type": "string" }, { "description": "Timestamp of the message to remove reaction from.", "in": "formData", "name": "timestamp", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from reactions.remove method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "reactions.remove schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from reactions.remove method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "bad_timestamp", "file_not_found", "file_comment_not_found", "message_not_found", "no_item_specified", "invalid_name", "no_reaction", "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", "fatal_error" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "reactions.remove error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "reactions:write" ] } ], "tags": [ "reactions" ] } }, "/reminders.add": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Creates a reminder.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/reminders.add" }, "operationId": "reminders_add", "parameters": [ { "description": "Authentication token. Requires scope: `reminders:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "The content of the reminder", "in": "formData", "name": "text", "required": true, "type": "string" }, { "description": "When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. \"in 15 minutes,\" or \"every Thursday\")", "in": "formData", "name": "time", "required": true, "type": "string" }, { "description": "The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.", "in": "formData", "name": "user", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from reminders.add method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "reminder": { "$ref": "#/definitions/objs_reminder" } }, "required": [ "ok", "reminder" ], "title": "reminders.add schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from reminders.add method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "cannot_parse", "user_not_found", "cannot_add_bot", "cannot_add_slackbot", "cannot_add_others", "cannot_add_others_recurring", "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": "reminders.add error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "reminders:write" ] } ], "tags": [ "reminders" ] } }, "/reminders.complete": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Marks a reminder as complete.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/reminders.complete" }, "operationId": "reminders_complete", "parameters": [ { "description": "Authentication token. Requires scope: `reminders:write`", "in": "header", "name": "token", "type": "string" }, { "description": "The ID of the reminder to be marked as complete", "in": "formData", "name": "reminder", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from reminders.complete method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "reminders.complete schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from reminders.complete method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "not_found", "cannot_complete_recurring", "cannot_complete_others", "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": "reminders.complete error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "reminders:write" ] } ], "tags": [ "reminders" ] } }, "/reminders.delete": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Deletes a reminder.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/reminders.delete" }, "operationId": "reminders_delete", "parameters": [ { "description": "Authentication token. Requires scope: `reminders:write`", "in": "header", "name": "token", "type": "string" }, { "description": "The ID of the reminder", "in": "formData", "name": "reminder", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from reminders.delete method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "reminders.delete schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from reminders.delete method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "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": "reminders.delete error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "reminders:write" ] } ], "tags": [ "reminders" ] } }, "/reminders.info": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Gets information about a reminder.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/reminders.info" }, "operationId": "reminders_info", "parameters": [ { "description": "Authentication token. Requires scope: `reminders:read`", "in": "query", "name": "token", "type": "string" }, { "description": "The ID of the reminder", "in": "query", "name": "reminder", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from reminders.info method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "reminder": { "$ref": "#/definitions/objs_reminder" } }, "required": [ "ok", "reminder" ], "title": "reminders.info schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from reminders.info method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "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": "reminders.info error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "reminders:read" ] } ], "tags": [ "reminders" ] } }, "/reminders.list": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Lists all reminders created by or for a given user.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/reminders.list" }, "operationId": "reminders_list", "parameters": [ { "description": "Authentication token. Requires scope: `reminders:read`", "in": "query", "name": "token", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from reminders.list method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "reminders": { "items": { "$ref": "#/definitions/objs_reminder" }, "type": "array" } }, "required": [ "ok", "reminders" ], "title": "reminders.list schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from reminders.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "reminders.list error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "reminders:read" ] } ], "tags": [ "reminders" ] } }, "/rtm.connect": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Starts a Real Time Messaging session.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/rtm.connect" }, "operationId": "rtm_connect", "parameters": [ { "description": "Authentication token. Requires scope: `rtm:stream`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching).", "in": "query", "name": "batch_presence_aware", "type": "boolean" }, { "description": "Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions).", "in": "query", "name": "presence_sub", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from rtm.connect method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "self": { "additionalProperties": false, "properties": { "id": { "$ref": "#/definitions/defs_user_id" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "team": { "additionalProperties": false, "properties": { "domain": { "type": "string" }, "id": { "$ref": "#/definitions/defs_team" }, "name": { "type": "string" } }, "required": [ "id", "name", "domain" ], "type": "object" }, "url": { "format": "uri", "type": "string" } }, "required": [ "ok", "url", "team", "self" ], "title": "rtm.connect schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from rtm.connect method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "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": "rtm.connect error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "rtm:stream" ] } ], "tags": [ "rtm" ] } }, "/search.messages": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Searches for messages matching a query.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/search.messages" }, "operationId": "search_messages", "parameters": [ { "description": "Authentication token. Requires scope: `search:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Pass the number of results you want per \"page\". Maximum of `100`.", "in": "query", "name": "count", "type": "integer" }, { "description": "Pass a value of `true` to enable query highlight markers (see below).", "in": "query", "name": "highlight", "type": "boolean" }, { "in": "query", "name": "page", "type": "integer" }, { "description": "Search query.", "in": "query", "name": "query", "required": true, "type": "string" }, { "description": "Return matches sorted by either `score` or `timestamp`.", "in": "query", "name": "sort", "type": "string" }, { "description": "Change sort direction to ascending (`asc`) or descending (`desc`).", "in": "query", "name": "sort_dir", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "search:read" ] } ], "tags": [ "search" ] } }, "/stars.add": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Adds a star to an item.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/stars.add" }, "operationId": "stars_add", "parameters": [ { "description": "Authentication token. Requires scope: `stars:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`).", "in": "formData", "name": "channel", "type": "string" }, { "description": "File to add star to.", "in": "formData", "name": "file", "type": "string" }, { "description": "File comment to add star to.", "in": "formData", "name": "file_comment", "type": "string" }, { "description": "Timestamp of the message to add star to.", "in": "formData", "name": "timestamp", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from stars.add method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "stars.add schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from stars.add method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "bad_timestamp", "message_not_found", "file_not_found", "file_comment_not_found", "channel_not_found", "no_item_specified", "already_starred", "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": "stars.add error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "stars:write" ] } ], "tags": [ "stars" ] } }, "/stars.list": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Lists stars for a user.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/stars.list" }, "operationId": "stars_list", "parameters": [ { "description": "Authentication token. Requires scope: `stars:read`", "in": "query", "name": "token", "type": "string" }, { "in": "query", "name": "count", "type": "string" }, { "in": "query", "name": "page", "type": "string" }, { "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": "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from stars.list method", "properties": { "items": { "items": { "items": [ { "additionalProperties": false, "properties": { "channel": { "$ref": "#/definitions/defs_channel" }, "date_create": { "type": "integer" }, "message": { "$ref": "#/definitions/objs_message" }, "type": { "enum": [ "message" ], "type": "string" } }, "required": [ "type", "channel", "message", "date_create" ], "type": "object" }, { "additionalProperties": false, "properties": { "date_create": { "type": "integer" }, "file": { "$ref": "#/definitions/objs_file" }, "type": { "enum": [ "file" ], "type": "string" } }, "required": [ "type", "file", "date_create" ], "type": "object" }, { "additionalProperties": false, "properties": { "comment": { "$ref": "#/definitions/objs_comment" }, "date_create": { "type": "integer" }, "file": { "$ref": "#/definitions/objs_file" }, "type": { "enum": [ "file_comment" ], "type": "string" } }, "required": [ "type", "file", "comment", "date_create" ], "type": "object" }, { "additionalProperties": false, "properties": { "channel": { "$ref": "#/definitions/defs_channel" }, "date_create": { "type": "integer" }, "type": { "enum": [ "channel" ], "type": "string" } }, "required": [ "type", "channel", "date_create" ], "type": "object" }, { "additionalProperties": false, "properties": { "channel": { "$ref": "#/definitions/defs_dm_id" }, "date_create": { "type": "integer" }, "type": { "enum": [ "im" ], "type": "string" } }, "required": [ "type", "channel", "date_create" ], "type": "object" }, { "additionalProperties": false, "properties": { "channel": { "$ref": "#/definitions/defs_group_id" }, "date_create": { "type": "integer" }, "type": { "enum": [ "group" ], "type": "string" } }, "required": [ "type", "channel", "date_create" ], "type": "object" } ] }, "type": "array" }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "paging": { "$ref": "#/definitions/objs_paging" } }, "required": [ "ok", "items" ], "title": "stars.list schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from stars.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "stars.list error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "stars:read" ] } ], "tags": [ "stars" ] } }, "/stars.remove": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Removes a star from an item.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/stars.remove" }, "operationId": "stars_remove", "parameters": [ { "description": "Authentication token. Requires scope: `stars:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`).", "in": "formData", "name": "channel", "type": "string" }, { "description": "File to remove star from.", "in": "formData", "name": "file", "type": "string" }, { "description": "File comment to remove star from.", "in": "formData", "name": "file_comment", "type": "string" }, { "description": "Timestamp of the message to remove star from.", "in": "formData", "name": "timestamp", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from stars.remove method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "stars.remove schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from stars.remove method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "bad_timestamp", "message_not_found", "file_not_found", "file_comment_not_found", "channel_not_found", "no_item_specified", "not_starred", "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": "stars.remove error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "stars:write" ] } ], "tags": [ "stars" ] } }, "/team.accessLogs": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Gets the access logs for the current team.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/team.accessLogs" }, "operationId": "team_accessLogs", "parameters": [ { "description": "Authentication token. Requires scope: `admin`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "End of time range of logs to include in results (inclusive).", "in": "query", "name": "before", "type": "string" }, { "in": "query", "name": "count", "type": "string" }, { "in": "query", "name": "page", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "This response demonstrates pagination and two access log entries.", "schema": { "additionalProperties": false, "description": "Schema for successful response from team.accessLogs method", "properties": { "logins": { "items": { "additionalProperties": false, "properties": { "count": { "type": "integer" }, "country": { "type": [ "string", "null" ] }, "date_first": { "type": "integer" }, "date_last": { "type": "integer" }, "ip": { "type": [ "string", "null" ] }, "isp": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] }, "user_agent": { "type": "string" }, "user_id": { "$ref": "#/definitions/defs_user_id" }, "username": { "type": "string" } }, "required": [ "user_id", "username", "date_first", "date_last", "count", "ip", "user_agent", "isp", "country", "region" ], "type": "object" }, "minItems": 1, "type": "array", "uniqueItems": true }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "paging": { "$ref": "#/definitions/objs_paging" } }, "required": [ "ok", "logins", "paging" ], "title": "team.accessLogs schema", "type": "object" } }, "default": { "description": "A workspace must be on a paid plan to use this method, otherwise the `paid_only` error is thrown:", "schema": { "additionalProperties": false, "description": "Schema for error response from team.accessLogs method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "paid_only", "over_pagination_limit", "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": "team.accessLogs error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin" ] } ], "tags": [ "team" ] } }, "/team.billableInfo": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Gets billable users information for the current team.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/team.billableInfo" }, "operationId": "team_billableInfo", "parameters": [ { "description": "Authentication token. Requires scope: `admin`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "A user to retrieve the billable information for. Defaults to all users.", "in": "query", "name": "user", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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" ] } ], "tags": [ "team" ] } }, "/team.info": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Gets information about the current team.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/team.info" }, "operationId": "team_info", "parameters": [ { "description": "Authentication token. Requires scope: `team:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Team to get info on, if omitted, will return information about the current team. Team to get info about; if omitted, will return information about the current team.", "in": "query", "name": "team", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from team.info method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "team": { "$ref": "#/definitions/objs_team" } }, "required": [ "ok", "team" ], "title": "team.info schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from team.info method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "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": "team.info error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "team:read" ] } ], "tags": [ "team" ] } }, "/team.integrationLogs": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Gets the integration logs for the current team.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/team.integrationLogs" }, "operationId": "team_integrationLogs", "parameters": [ { "description": "Authentication token. Requires scope: `admin`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Filter logs to this Slack app. Defaults to all logs.", "in": "query", "name": "app_id", "type": "string" }, { "description": "Filter logs with this change type. Defaults to all logs.", "in": "query", "name": "change_type", "type": "string" }, { "in": "query", "name": "count", "type": "string" }, { "in": "query", "name": "page", "type": "string" }, { "description": "Filter logs to this service. Defaults to all logs.", "in": "query", "name": "service_id", "type": "string" }, { "description": "Filter logs generated by this user\u2019s actions. Defaults to all logs.", "in": "query", "name": "user", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from team.integrationLogs method", "properties": { "logs": { "items": { "additionalProperties": false, "properties": { "admin_app_id": { "$ref": "#/definitions/defs_app_id" }, "app_id": { "$ref": "#/definitions/defs_app_id" }, "app_type": { "type": "string" }, "change_type": { "type": "string" }, "channel": { "$ref": "#/definitions/defs_channel" }, "date": { "type": "string" }, "scope": { "type": "string" }, "service_id": { "type": "string" }, "service_type": { "type": "string" }, "user_id": { "$ref": "#/definitions/defs_user_id" }, "user_name": { "type": "string" } }, "required": [ "user_id", "user_name", "date", "change_type", "app_type", "app_id", "scope" ], "type": "object" }, "minItems": 1, "type": "array", "uniqueItems": true }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "paging": { "$ref": "#/definitions/objs_paging" } }, "required": [ "ok", "logs", "paging" ], "title": "team.integrationLogs schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from team.integrationLogs method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "team.integrationLogs error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "admin" ] } ], "tags": [ "team" ] } }, "/team.profile.get": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Retrieve a team's profile.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/team.profile.get" }, "operationId": "team_profile_get", "parameters": [ { "description": "Authentication token. Requires scope: `users.profile:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Filter by visibility.", "in": "query", "name": "visibility", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from team.profile.get method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "profile": { "additionalProperties": false, "properties": { "fields": { "items": { "$ref": "#/definitions/objs_team_profile_field" }, "type": "array", "uniqueItems": true } }, "required": [ "fields" ], "type": "object" } }, "required": [ "ok", "profile" ], "title": "team.profile.get success schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from team.profile.get method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "not_authed", "invalid_auth", "account_inactive", "no_permission", "user_is_bot", "invalid_arg_name", "invalid_array_arg", "invalid_charset", "invalid_form_data", "invalid_post_typ", "missing_post_type", "team_added_to_org", "invalid_json", "json_not_object", "request_timeou", "upgrade_required" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "team.profile.get error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users.profile:read" ] } ], "tags": [ "team.profile", "team" ] } }, "/usergroups.create": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Create a User Group", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/usergroups.create" }, "operationId": "usergroups_create", "parameters": [ { "description": "Authentication token. Requires scope: `usergroups:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "A comma separated string of encoded channel IDs for which the User Group uses as a default.", "in": "formData", "name": "channels", "type": "string" }, { "description": "A short description of the User Group.", "in": "formData", "name": "description", "type": "string" }, { "description": "A mention handle. Must be unique among channels, users and User Groups.", "in": "formData", "name": "handle", "type": "string" }, { "description": "Include the number of users in each User Group.", "in": "formData", "name": "include_count", "type": "boolean" }, { "description": "A name for the User Group. Must be unique among User Groups.", "in": "formData", "name": "name", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from usergroups.create method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "usergroup": { "$ref": "#/definitions/objs_subteam" } }, "required": [ "ok", "usergroup" ], "title": "usergroups.create schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from usergroups.create method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "permission_denied", "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": "usergroups.create error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "usergroups:write" ] } ], "tags": [ "usergroups" ] } }, "/usergroups.disable": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Disable an existing User Group", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/usergroups.disable" }, "operationId": "usergroups_disable", "parameters": [ { "description": "Authentication token. Requires scope: `usergroups:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Include the number of users in the User Group.", "in": "formData", "name": "include_count", "type": "boolean" }, { "description": "The encoded ID of the User Group to disable.", "in": "formData", "name": "usergroup", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from usergroups.disable method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "usergroup": { "$ref": "#/definitions/objs_subteam" } }, "required": [ "ok", "usergroup" ], "title": "usergroups.disable schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from usergroups.disable method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "permission_denied", "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": "usergroups.disable error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "usergroups:write" ] } ], "tags": [ "usergroups" ] } }, "/usergroups.enable": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Enable a User Group", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/usergroups.enable" }, "operationId": "usergroups_enable", "parameters": [ { "description": "Authentication token. Requires scope: `usergroups:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Include the number of users in the User Group.", "in": "formData", "name": "include_count", "type": "boolean" }, { "description": "The encoded ID of the User Group to enable.", "in": "formData", "name": "usergroup", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from usergroups.enable method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "usergroup": { "$ref": "#/definitions/objs_subteam" } }, "required": [ "ok", "usergroup" ], "title": "usergroups.enable schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from usergroups.enable method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "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_require", "fatal_error", "missing_charset", "superfluous_charset" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "usergroups.enable error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "usergroups:write" ] } ], "tags": [ "usergroups" ] } }, "/usergroups.list": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "List all User Groups for a team", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/usergroups.list" }, "operationId": "usergroups_list", "parameters": [ { "description": "Include the list of users for each User Group.", "in": "query", "name": "include_users", "type": "boolean" }, { "description": "Authentication token. Requires scope: `usergroups:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Include the number of users in each User Group.", "in": "query", "name": "include_count", "type": "boolean" }, { "description": "Include disabled User Groups.", "in": "query", "name": "include_disabled", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from usergroups.list method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "usergroups": { "items": { "$ref": "#/definitions/objs_subteam" }, "type": "array" } }, "required": [ "ok", "usergroups" ], "title": "usergroups.list schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from usergroups.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "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_require", "fatal_error", "missing_charset", "superfluous_charset" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "usergroups.list error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "usergroups:read" ] } ], "tags": [ "usergroups" ] } }, "/usergroups.update": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Update an existing User Group", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/usergroups.update" }, "operationId": "usergroups_update", "parameters": [ { "description": "A mention handle. Must be unique among channels, users and User Groups.", "in": "formData", "name": "handle", "type": "string" }, { "description": "A short description of the User Group.", "in": "formData", "name": "description", "type": "string" }, { "description": "A comma separated string of encoded channel IDs for which the User Group uses as a default.", "in": "formData", "name": "channels", "type": "string" }, { "description": "Authentication token. Requires scope: `usergroups:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Include the number of users in the User Group.", "in": "formData", "name": "include_count", "type": "boolean" }, { "description": "The encoded ID of the User Group to update.", "in": "formData", "name": "usergroup", "required": true, "type": "string" }, { "description": "A name for the User Group. Must be unique among User Groups.", "in": "formData", "name": "name", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from usergroups.update method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "usergroup": { "$ref": "#/definitions/objs_subteam" } }, "required": [ "ok", "usergroup" ], "title": "usergroups.update schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from usergroups.update method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "permission_denied", "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_require", "fatal_error", "missing_charset", "superfluous_charset" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "usergroups.update error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "usergroups:write" ] } ], "tags": [ "usergroups" ] } }, "/usergroups.users.list": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "List all users in a User Group", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/usergroups.users.list" }, "operationId": "usergroups_users_list", "parameters": [ { "description": "Authentication token. Requires scope: `usergroups:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Allow results that involve disabled User Groups.", "in": "query", "name": "include_disabled", "type": "boolean" }, { "description": "The encoded ID of the User Group to update.", "in": "query", "name": "usergroup", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Standard success response when used with a user token", "schema": { "additionalProperties": false, "description": "Schema for successful response from usergroups.users.list method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "users": { "items": { "$ref": "#/definitions/defs_user_id" }, "type": "array" } }, "required": [ "ok", "users" ], "title": "usergroups.users.list schema", "type": "object" } }, "default": { "description": "Standard failure response when used with an invalid token", "schema": { "additionalProperties": false, "description": "Schema for error response from usergroups.users.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "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_require", "fatal_error", "missing_charset", "superfluous_charset" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "usergroups.users.list error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "usergroups:read" ] } ], "tags": [ "usergroups.users", "usergroups" ] } }, "/usergroups.users.update": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Update the list of users for a User Group", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/usergroups.users.update" }, "operationId": "usergroups_users_update", "parameters": [ { "description": "Authentication token. Requires scope: `usergroups:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Include the number of users in the User Group.", "in": "formData", "name": "include_count", "type": "boolean" }, { "description": "The encoded ID of the User Group to update.", "in": "formData", "name": "usergroup", "required": true, "type": "string" }, { "description": "A comma separated string of encoded user IDs that represent the entire list of users for the User Group.", "in": "formData", "name": "users", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from usergroups.users.update method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "usergroup": { "$ref": "#/definitions/objs_subteam" } }, "required": [ "ok", "usergroup" ], "title": "usergroups.users.update schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from usergroups.users.update method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "permission_denied", "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_require", "fatal_error", "missing_charset", "superfluous_charset" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "usergroups.users.update error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "usergroups:write" ] } ], "tags": [ "usergroups.users", "usergroups" ] } }, "/users.conversations": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "List conversations the calling user may access.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.conversations" }, "operationId": "users_conversations", "parameters": [ { "description": "Authentication token. Requires scope: `conversations:read`", "in": "query", "name": "token", "type": "string" }, { "description": "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.", "in": "query", "name": "user", "type": "string" }, { "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" }, { "description": "Set to `true` to exclude archived channels from the list", "in": "query", "name": "exclude_archived", "type": "boolean" }, { "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": "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" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response with only public channels. Note how `num_members` and `is_member` are not returned like typical `conversations` objects.", "schema": { "additionalProperties": true, "description": "Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member`", "properties": { "channels": { "items": { "$ref": "#/definitions/objs_conversation" }, "type": "array", "uniqueItems": true }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "response_metadata": { "additionalProperties": false, "properties": { "next_cursor": { "type": "string" } }, "required": [ "next_cursor" ], "type": "object" } }, "required": [ "ok", "channels" ], "title": "users.conversations success schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.conversations method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "method_not_supported_for_channel_type", "missing_scope", "invalid_types", "invalid_cursor", "invalid_limit", "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": "users.conversations error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "channels:read", "groups:read", "im:read", "mpim:read" ] } ], "tags": [ "users" ] } }, "/users.deletePhoto": { "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Delete the user profile photo", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.deletePhoto" }, "operationId": "users_deletePhoto", "parameters": [ { "description": "Authentication token. Requires scope: `users.profile:write`", "in": "formData", "name": "token", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from users.deletePhoto method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "users.deletePhoto schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.deletePhoto method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "users.deletePhoto error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users.profile:write" ] } ], "tags": [ "users" ] } }, "/users.getPresence": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Gets user presence information.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.getPresence" }, "operationId": "users_getPresence", "parameters": [ { "description": "Authentication token. Requires scope: `users:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "User to get presence info on. Defaults to the authed user.", "in": "query", "name": "user", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "When requesting information for a different user, this method just returns the current presence (either `active` or `away`).", "schema": { "additionalProperties": true, "description": "Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65", "properties": { "auto_away": { "type": "boolean" }, "connection_count": { "type": "integer" }, "last_activity": { "type": "integer" }, "manual_away": { "type": "boolean" }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "online": { "type": "boolean" }, "presence": { "type": "string" } }, "required": [ "ok", "presence" ], "title": "API method: users.getPresence", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": { "type": "object" }, "description": "Schema for error response users.getPresence method", "properties": { "error": { "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "users.counts error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users:read" ] } ], "tags": [ "users" ] } }, "/users.identity": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Get a user's identity.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.identity" }, "operationId": "users_identity", "parameters": [ { "description": "Authentication token. Requires scope: `identity.basic`", "in": "query", "name": "token", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "You will receive at a minimum the following information:", "schema": { "description": "Schema for successful response from users.identity method", "items": [ { "additionalProperties": false, "description": "Schema for 'identity.basic' scope", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "team": { "additionalProperties": false, "properties": { "id": { "$ref": "#/definitions/defs_team" } }, "required": [ "id" ], "type": "object" }, "user": { "additionalProperties": false, "properties": { "id": { "$ref": "#/definitions/defs_user_id" }, "name": { "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "ok", "user", "team" ], "type": "object" }, { "additionalProperties": false, "description": "Schema for 'identity.basic,identity.email' scopes", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "team": { "additionalProperties": false, "properties": { "id": { "$ref": "#/definitions/defs_team" } }, "required": [ "id" ], "type": "object" }, "user": { "additionalProperties": false, "properties": { "email": { "format": "email", "type": "string" }, "id": { "$ref": "#/definitions/defs_user_id" }, "name": { "type": "string" } }, "required": [ "name", "id", "email" ], "type": "object" } }, "required": [ "ok", "user", "team" ], "type": "object" }, { "additionalProperties": false, "description": "Schema for 'identity.basic,identity.avatar' scopes", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "team": { "additionalProperties": false, "properties": { "id": { "$ref": "#/definitions/defs_team" } }, "required": [ "id" ], "type": "object" }, "user": { "additionalProperties": false, "properties": { "id": { "$ref": "#/definitions/defs_user_id" }, "image_192": { "format": "url", "type": "string" }, "image_24": { "format": "url", "type": "string" }, "image_32": { "format": "url", "type": "string" }, "image_48": { "format": "url", "type": "string" }, "image_512": { "format": "url", "type": "string" }, "image_72": { "format": "url", "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "id", "image_24", "image_32", "image_48", "image_72", "image_192", "image_512" ], "type": "object" } }, "required": [ "ok", "user", "team" ], "type": "object" }, { "additionalProperties": false, "description": "Schema for 'identity.basic,identity.team' scopes", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "team": { "additionalProperties": false, "properties": { "domain": { "type": "string" }, "id": { "$ref": "#/definitions/defs_team" }, "image_102": { "format": "url", "type": "string" }, "image_132": { "format": "url", "type": "string" }, "image_230": { "format": "url", "type": "string" }, "image_34": { "format": "url", "type": "string" }, "image_44": { "format": "url", "type": "string" }, "image_68": { "format": "url", "type": "string" }, "image_88": { "format": "url", "type": "string" }, "image_default": { "type": "boolean" }, "name": { "type": "string" } }, "required": [ "id", "name", "domain", "image_34", "image_44", "image_68", "image_88", "image_102", "image_132", "image_230", "image_default" ], "type": "object" }, "user": { "additionalProperties": false, "properties": { "id": { "$ref": "#/definitions/defs_user_id" }, "name": { "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "ok", "user", "team" ], "type": "object" } ], "title": "users.identity schema" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.identity method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "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": "users.identity error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "identity.basic" ] } ], "tags": [ "users" ] } }, "/users.info": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Gets information about a user.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.info" }, "operationId": "users_info", "parameters": [ { "description": "Authentication token. Requires scope: `users:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Set this to `true` to receive the locale for this user. Defaults to `false`", "in": "query", "name": "include_locale", "type": "boolean" }, { "description": "User to get info on", "in": "query", "name": "user", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": true, "description": "Schema for successful response from users.info method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "user": { "$ref": "#/definitions/objs_user" } }, "required": [ "ok", "user" ], "title": "users.info success schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.info method", "properties": { "callstack": { "type": "string" }, "error": { "enum": [ "user_not_found", "user_not_visible", "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": "users.info error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users:read" ] } ], "tags": [ "users" ] } }, "/users.list": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Lists all users in a Slack team.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.list" }, "operationId": "users_list", "parameters": [ { "description": "Authentication token. Requires scope: `users: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. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors.", "in": "query", "name": "limit", "type": "integer" }, { "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": "Set this to `true` to receive the locale for users. Defaults to `false`", "in": "query", "name": "include_locale", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from users.list method", "properties": { "cache_ts": { "type": "integer" }, "members": { "items": { "$ref": "#/definitions/objs_user" }, "minItems": 1, "type": "array", "uniqueItems": true }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "response_metadata": { "$ref": "#/definitions/objs_response_metadata" } }, "required": [ "ok", "members", "cache_ts" ], "title": "users.list schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.list method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "limit_required", "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", "fatal_error" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "users.list error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users:read" ] } ], "tags": [ "users" ] } }, "/users.lookupByEmail": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Find a user with an email address.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.lookupByEmail" }, "operationId": "users_lookupByEmail", "parameters": [ { "description": "Authentication token. Requires scope: `users:read.email`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "An email address belonging to a user in the workspace", "in": "query", "name": "email", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": true, "description": "Schema for successful response from users.lookupByEmail method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "user": { "$ref": "#/definitions/objs_user" } }, "required": [ "ok", "user" ], "title": "users.lookupByEmail success schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.lookupByEmail method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "users_not_found", "enterprise_is_restricted", "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", "fatal_error" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "users.lookupByEmail error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users:read.email" ] } ], "tags": [ "users" ] } }, "/users.profile.get": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Retrieves a user's profile information.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.profile.get" }, "operationId": "users_profile_get", "parameters": [ { "description": "Authentication token. Requires scope: `users.profile:read`", "in": "query", "name": "token", "required": true, "type": "string" }, { "description": "Include labels for each ID in custom profile fields", "in": "query", "name": "include_labels", "type": "boolean" }, { "description": "User to retrieve profile info for", "in": "query", "name": "user", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from users.profile.get method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "profile": { "$ref": "#/definitions/objs_user_profile" } }, "required": [ "ok", "profile" ], "title": "users.profile.get schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.profile.get method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "user_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": "users.profile.get error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users.profile:read" ] } ], "tags": [ "users.profile", "users" ] } }, "/users.profile.set": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Set the profile information for a user.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.profile.set" }, "operationId": "users_profile_set", "parameters": [ { "description": "Authentication token. Requires scope: `users.profile:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Name of a single key to set. Usable only if `profile` is not passed.", "in": "formData", "name": "name", "type": "string" }, { "description": "Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.", "in": "formData", "name": "profile", "type": "string" }, { "description": "ID of user to change. This argument may only be specified by team admins on paid teams.", "in": "formData", "name": "user", "type": "string" }, { "description": "Value to set a single key to. Usable only if `profile` is not passed.", "in": "formData", "name": "value", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from users.profile.set method", "properties": { "email_pending": { "format": "email", "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_true" }, "profile": { "$ref": "#/definitions/objs_user_profile" }, "username": { "type": "string" } }, "required": [ "ok", "username", "profile" ], "title": "users.profile.set schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.profile.set method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "reserved_name", "invalid_profile", "profile_set_failed", "not_admin", "not_app_admin", "cannot_update_admin_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": "users.profile.set error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users.profile:write" ] } ], "tags": [ "users.profile", "users" ] } }, "/users.setActive": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Marked a user as active. Deprecated and non-functional.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.setActive" }, "operationId": "users_setActive", "parameters": [ { "description": "Authentication token. Requires scope: `users:write`", "in": "header", "name": "token", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from users.setActive method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "users.setActive schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.setActive method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "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", "internal_error" ], "type": "string" }, "ok": { "$ref": "#/definitions/defs_ok_false" } }, "required": [ "ok", "error" ], "title": "users.setActive error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users:write" ] } ], "tags": [ "users" ] } }, "/users.setPhoto": { "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Set the user profile photo", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.setPhoto" }, "operationId": "users_setPhoto", "parameters": [ { "description": "Authentication token. Requires scope: `users.profile:write`", "in": "formData", "name": "token", "required": true, "type": "string" }, { "description": "Width/height of crop box (always square)", "in": "formData", "name": "crop_w", "type": "string" }, { "description": "X coordinate of top-left corner of crop box", "in": "formData", "name": "crop_x", "type": "string" }, { "description": "Y coordinate of top-left corner of crop box", "in": "formData", "name": "crop_y", "type": "string" }, { "description": "File contents via `multipart/form-data`.", "in": "formData", "name": "image", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from users.setPhoto method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" }, "profile": { "additionalProperties": false, "properties": { "avatar_hash": { "pattern": "^[0-9a-f]{12}$", "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" } }, "required": [ "image_24", "image_32", "image_48", "image_72", "image_192", "image_512", "image_1024", "image_original", "avatar_hash" ], "type": "object" } }, "required": [ "ok", "profile" ], "title": "users.setPhoto schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.setPhoto method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "debug_step": { "description": "possibly DEV/QA only", "type": "string" }, "dims": { "description": "possibly DEV/QA only", "type": "string" }, "error": { "enum": [ "bad_image", "too_large", "too_many_frames", "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" }, "time_ident": { "description": "possibly DEV/QA only", "type": "integer" } }, "required": [ "ok", "error" ], "title": "users.setPhoto error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users.profile:write" ] } ], "tags": [ "users" ] } }, "/users.setPresence": { "post": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Manually sets user presence.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/users.setPresence" }, "operationId": "users_setPresence", "parameters": [ { "description": "Authentication token. Requires scope: `users:write`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Either `auto` or `away`", "in": "formData", "name": "presence", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "schema": { "additionalProperties": false, "description": "Schema for successful response from users.setPresence method", "properties": { "ok": { "$ref": "#/definitions/defs_ok_true" } }, "required": [ "ok" ], "title": "users.setPresence schema", "type": "object" } }, "default": { "description": "Typical error response", "schema": { "additionalProperties": false, "description": "Schema for error response from users.setPresence method", "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", "type": "string" }, "error": { "enum": [ "invalid_presence", "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": "users.setPresence error schema", "type": "object" } } }, "security": [ { "slackAuth": [ "users:write" ] } ], "tags": [ "users" ] } }, "/views.open": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Open a view for a user.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/views.open" }, "operationId": "views_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": "A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.", "in": "query", "name": "view", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response includes the opened view payload.", "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, before getting to any possible validation errors.", "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": [ "views" ] } }, "/views.publish": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Publish a static view for a User.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/views.publish" }, "operationId": "views_publish", "parameters": [ { "description": "Authentication token. Requires scope: `none`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "`id` of the user you want publish a view to.", "in": "query", "name": "user_id", "required": true, "type": "string" }, { "description": "A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.", "in": "query", "name": "view", "required": true, "type": "string" }, { "description": "A string that represents view state to protect against possible race conditions.", "in": "query", "name": "hash", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response includes the published view payload.", "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, before getting to any possible validation errors.", "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": [ "views" ] } }, "/views.push": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Push a view onto the stack of a root view.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/views.push" }, "operationId": "views_push", "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": "A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.", "in": "query", "name": "view", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response includes the pushed view payload.", "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.", "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": [ "views" ] } }, "/views.update": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Update an existing view.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/views.update" }, "operationId": "views_update", "parameters": [ { "description": "Authentication token. Requires scope: `none`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "A unique identifier of the view to be updated. Either `view_id` or `external_id` is required.", "in": "query", "name": "view_id", "type": "string" }, { "description": "A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required.", "in": "query", "name": "external_id", "type": "string" }, { "description": "A [view object](/reference/surfaces/views). This must be a JSON-encoded string.", "in": "query", "name": "view", "type": "string" }, { "description": "A string that represents view state to protect against possible race conditions.", "in": "query", "name": "hash", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response includes the updated view payload.", "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.", "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": [ "views" ] } }, "/workflows.stepCompleted": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Indicate that an app's step in a workflow completed execution.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/workflows.stepCompleted" }, "operationId": "workflows_stepCompleted", "parameters": [ { "description": "Authentication token. Requires scope: `workflow.steps:execute`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Context identifier that maps to the correct workflow step execution.", "in": "query", "name": "workflow_step_execute_id", "required": true, "type": "string" }, { "description": "Key-value object of outputs from your step. Keys of this object reflect the configured `key` properties of your [`outputs`](/reference/workflows/workflow_step#output) array from your `workflow_step` object.", "in": "query", "name": "outputs", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "workflow.steps:execute" ] } ], "tags": [ "workflows" ] } }, "/workflows.stepFailed": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Indicate that an app's step in a workflow failed to execute.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/workflows.stepFailed" }, "operationId": "workflows_stepFailed", "parameters": [ { "description": "Authentication token. Requires scope: `workflow.steps:execute`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "Context identifier that maps to the correct workflow step execution.", "in": "query", "name": "workflow_step_execute_id", "required": true, "type": "string" }, { "description": "A JSON-based object with a `message` property that should contain a human readable error message.", "in": "query", "name": "error", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "workflow.steps:execute" ] } ], "tags": [ "workflows" ] } }, "/workflows.updateStep": { "get": { "consumes": [ "application/x-www-form-urlencoded", "application/json" ], "description": "Update the configuration for a workflow extension step.", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/workflows.updateStep" }, "operationId": "workflows_updateStep", "parameters": [ { "description": "Authentication token. Requires scope: `workflow.steps:execute`", "in": "header", "name": "token", "required": true, "type": "string" }, { "description": "A context identifier provided with `view_submission` payloads used to call back to `workflows.updateStep`.", "in": "query", "name": "workflow_step_edit_id", "required": true, "type": "string" }, { "description": "A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. **Please note**: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. [Read more about variables in workflow steps here](/workflows/steps#variables).", "in": "query", "name": "inputs", "type": "string" }, { "description": "An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.", "in": "query", "name": "outputs", "type": "string" }, { "description": "An optional field that can be used to override the step name that is shown in the Workflow Builder.", "in": "query", "name": "step_name", "type": "string" }, { "description": "An optional field that can be used to override app image that is shown in the Workflow Builder.", "in": "query", "name": "step_image_url", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Typical success response", "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", "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": [ "workflow.steps:execute" ] } ], "tags": [ "workflows" ] } } }, "schemes": [ "https" ], "securityDefinitions": { "slackAuth": { "authorizationUrl": "https://slack.com/oauth/authorize", "flow": "accessCode", "scopes": { "admin": "admin", "admin.apps:read": "admin.apps:read", "admin.apps:write": "admin.apps:write", "admin.conversations:read": "admin.conversations:read", "admin.conversations:write": "admin.conversations:write", "admin.invites:read": "admin.invites:read", "admin.invites:write": "admin.invites:write", "admin.teams:read": "admin.teams:read", "admin.teams:write": "admin.teams:write", "admin.usergroups:read": "admin.usergroups:read", "admin.usergroups:write": "admin.usergroups:write", "admin.users:read": "admin.users:read", "admin.users:write": "admin.users:write", "authorizations:read": "authorizations:read", "bot": "Bot user scope", "calls:read": "calls:read", "calls:write": "calls:write", "channels:history": "channels:history", "channels:manage": "channels:manage", "channels:read": "channels:read", "channels:write": "channels:write", "chat:write": "chat:write", "chat:write:bot": "Author messages as a bot", "chat:write:user": "Author messages as a user", "conversations:history": "conversations:history", "conversations:read": "conversations:read", "conversations:write": "conversations:write", "dnd:read": "dnd:read", "dnd:write": "dnd:write", "emoji:read": "emoji:read", "files:read": "files:read", "files:write:user": "files:write:user", "groups:history": "groups:history", "groups:read": "groups:read", "groups:write": "groups:write", "identity.basic": "identity.basic", "im:history": "im:history", "im:read": "im:read", "im:write": "im:write", "links:write": "links:write", "mpim:history": "mpim:history", "mpim:read": "mpim:read", "mpim:write": "mpim:write", "none": "No scope required", "pins:read": "pins:read", "pins:write": "pins:write", "reactions:read": "reactions:read", "reactions:write": "reactions:write", "reminders:read": "reminders:read", "reminders:write": "reminders:write", "remote_files:read": "remote_files:read", "remote_files:share": "remote_files:share", "remote_files:write": "remote_files:write", "rtm:stream": "rtm:stream", "search:read": "search:read", "stars:read": "stars:read", "stars:write": "stars:write", "team:read": "team:read", "tokens.basic": "tokens.basic", "usergroups:read": "usergroups:read", "usergroups:write": "usergroups:write", "users.profile:read": "users.profile:read", "users.profile:write": "users.profile:write", "users:read": "users:read", "users:read.email": "users:read.email", "users:write": "users:write", "workflow.steps:execute": "workflow.steps:execute" }, "tokenUrl": "https://slack.com/api/oauth.access", "type": "oauth2" } }, "swagger": "2.0", "tags": [] }