{ "components": { "schemas": { "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" } }, "type": "object" }, "title": "Block Kit blocks", "type": "array" }, "defs_app_id": { "title": "App ID", "type": "string" }, "defs_bot_id": { "title": "Bot User ID", "type": "string" }, "defs_channel": { "title": "Channel-like conversation ID", "type": "string" }, "defs_channel_id": { "title": "Channel ID", "type": "string" }, "defs_channel_name": { "title": "Name of a channel", "type": "string" }, "defs_comment_id": { "title": "File Comment ID", "type": "string" }, "defs_dm_id": { "title": "Direct Message Channel ID", "type": "string" }, "defs_enterprise_id": { "title": "Enterprise ID", "type": "string" }, "defs_enterprise_name": { "title": "Name of the enterprise org", "type": "string" }, "defs_enterprise_user_id": { "title": "Enterprise User ID", "type": "string" }, "defs_file_id": { "title": "File ID", "type": "string" }, "defs_group_id": { "title": "Private Channel ID", "type": "string" }, "defs_ok_false": { "enum": [ false ], "title": "default failure response", "type": "boolean" }, "defs_ok_true": { "const": true, "title": "default success response", "type": "boolean" }, "defs_optional_app_id": { "title": "App ID or empty string", "type": "string" }, "defs_pinned_info": { "title": "Info for a pinned item", "type": "object" }, "defs_reminder_id": { "title": "Reminder ID", "type": "string" }, "defs_subteam_id": { "title": "Subteam ID", "type": "string" }, "defs_team": { "title": "Team ID", "type": "string" }, "defs_topic_purpose_creator": { "title": "User ID or empty string, used for topic and purpose creation", "type": "string" }, "defs_ts": { "title": "Timestamp in format 0123456789.012345", "type": "string" }, "defs_user_id": { "title": "User ID", "type": "string" }, "defs_workspace_id": { "title": "Team or Enterprise ID", "type": "string" }, "objs_bot_profile": { "properties": { "app_id": { "$ref": "#/components/schemas/defs_app_id" }, "deleted": { "type": "boolean" }, "icons": { "properties": { "image_36": { "format": "uri", "type": "string" }, "image_48": { "format": "uri", "type": "string" }, "image_72": { "format": "uri", "type": "string" } }, "type": "object" }, "id": { "$ref": "#/components/schemas/defs_bot_id" }, "name": { "type": "string" }, "team_id": { "$ref": "#/components/schemas/defs_team" }, "updated": { "type": "integer" } }, "title": "Bot Profile Object", "type": "object" }, "objs_channel": { "properties": { "accepted_user": { "$ref": "#/components/schemas/defs_user_id" }, "created": { "type": "integer" }, "creator": { "$ref": "#/components/schemas/defs_user_id" }, "id": { "$ref": "#/components/schemas/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": "#/components/schemas/defs_ts" }, "latest": { "anyOf": [ { "$ref": "#/components/schemas/objs_message" }, { "type": "null" } ] }, "members": { "items": { "$ref": "#/components/schemas/defs_user_id" }, "type": "array" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "num_members": { "type": "integer" }, "pending_shared": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" }, "previous_names": { "items": { "$ref": "#/components/schemas/defs_channel_name" }, "type": "array" }, "priority": { "type": "number" }, "purpose": { "properties": { "creator": { "$ref": "#/components/schemas/defs_topic_purpose_creator" }, "last_set": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "topic": { "properties": { "creator": { "$ref": "#/components/schemas/defs_topic_purpose_creator" }, "last_set": { "type": "integer" }, "value": { "type": "string" } }, "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" } }, "title": "Channel Object", "type": "object" }, "objs_comment": { "properties": { "comment": { "type": "string" }, "created": { "type": "integer" }, "id": { "$ref": "#/components/schemas/defs_comment_id" }, "is_intro": { "type": "boolean" }, "is_starred": { "type": "boolean" }, "num_stars": { "type": "integer" }, "pinned_info": { "$ref": "#/components/schemas/defs_pinned_info" }, "pinned_to": { "items": { "$ref": "#/components/schemas/defs_channel" }, "type": "array" }, "reactions": { "items": { "$ref": "#/components/schemas/objs_reaction" }, "type": "array" }, "timestamp": { "type": "integer" }, "user": { "$ref": "#/components/schemas/defs_user_id" } }, "title": "File Comment Object", "type": "object" }, "objs_comments": { "items": {}, "title": "file comments object", "type": "array" }, "objs_conversation": { "anyOf": [ { "properties": { "accepted_user": { "$ref": "#/components/schemas/defs_user_id" }, "connected_team_ids": { "items": { "$ref": "#/components/schemas/defs_workspace_id" }, "type": "array" }, "conversation_host_id": { "$ref": "#/components/schemas/defs_workspace_id" }, "created": { "type": "integer" }, "creator": { "$ref": "#/components/schemas/defs_user_id" }, "display_counts": { "properties": { "display_counts": { "type": "integer" }, "guest_counts": { "type": "integer" } }, "type": "object" }, "enterprise_id": { "$ref": "#/components/schemas/defs_enterprise_id" }, "has_pins": { "type": "boolean" }, "id": { "$ref": "#/components/schemas/defs_channel" }, "internal_team_ids": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" }, "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": "#/components/schemas/defs_ts" }, "latest": { "anyOf": [ { "$ref": "#/components/schemas/objs_message" }, { "type": "null" } ] }, "members": { "items": { "$ref": "#/components/schemas/defs_user_id" }, "type": "array" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "num_members": { "type": "integer" }, "parent_conversation": { "anyOf": [ { "$ref": "#/components/schemas/defs_channel" }, { "type": "null" } ] }, "pending_connected_team_ids": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" }, "pending_shared": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" }, "pin_count": { "type": "integer" }, "previous_names": { "items": { "$ref": "#/components/schemas/defs_channel_name" }, "type": "array" }, "priority": { "type": "number" }, "purpose": { "properties": { "creator": { "$ref": "#/components/schemas/defs_topic_purpose_creator" }, "last_set": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "shared_team_ids": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" }, "shares": { "items": { "properties": { "accepted_user": { "$ref": "#/components/schemas/defs_user_id" }, "is_active": { "type": "boolean" }, "team": { "$ref": "#/components/schemas/objs_team" }, "user": { "$ref": "#/components/schemas/defs_user_id" } }, "type": "object" }, "type": "array" }, "timezone_count": { "type": "integer" }, "topic": { "properties": { "creator": { "$ref": "#/components/schemas/defs_topic_purpose_creator" }, "last_set": { "type": "integer" }, "value": { "type": "string" } }, "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": "#/components/schemas/defs_user_id" }, "version": { "type": "integer" } }, "title": "Conversation object", "type": "object" }, { "properties": { "accepted_user": { "$ref": "#/components/schemas/defs_user_id" }, "connected_team_ids": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" }, "conversation_host_id": { "$ref": "#/components/schemas/defs_workspace_id" }, "created": { "type": "integer" }, "creator": { "$ref": "#/components/schemas/defs_user_id" }, "display_counts": { "properties": { "display_counts": { "type": "integer" }, "guest_counts": { "type": "integer" } }, "type": "object" }, "id": { "$ref": "#/components/schemas/defs_channel" }, "internal_team_ids": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" }, "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": "#/components/schemas/defs_ts" }, "latest": { "anyOf": [ { "$ref": "#/components/schemas/objs_message" }, { "type": "null" } ] }, "members": { "items": { "$ref": "#/components/schemas/defs_user_id" }, "type": "array" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "num_members": { "type": "integer" }, "parent_conversation": { "anyOf": [ { "$ref": "#/components/schemas/defs_channel" }, { "type": "null" } ] }, "pending_connected_team_ids": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" }, "pending_shared": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" }, "pin_count": { "type": "integer" }, "previous_names": { "items": { "$ref": "#/components/schemas/defs_channel_name" }, "type": "array" }, "priority": { "type": "number" }, "purpose": { "properties": { "creator": { "$ref": "#/components/schemas/defs_topic_purpose_creator" }, "last_set": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "shared_team_ids": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" }, "shares": { "items": { "properties": { "accepted_user": { "$ref": "#/components/schemas/defs_user_id" }, "is_active": { "type": "boolean" }, "team": { "$ref": "#/components/schemas/objs_team" }, "user": { "$ref": "#/components/schemas/defs_user_id" } }, "type": "object" }, "type": "array" }, "timezone_count": { "type": "integer" }, "topic": { "properties": { "creator": { "$ref": "#/components/schemas/defs_topic_purpose_creator" }, "last_set": { "type": "integer" }, "value": { "type": "string" } }, "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": "#/components/schemas/defs_user_id" }, "version": { "type": "integer" } }, "title": "Conversation MPIM Object", "type": "object" }, { "properties": { "created": { "type": "integer" }, "has_pins": { "type": "boolean" }, "id": { "$ref": "#/components/schemas/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": "#/components/schemas/defs_ts" }, "latest": { "anyOf": [ { "$ref": "#/components/schemas/objs_message" }, { "type": "null" } ] }, "parent_conversation": { "anyOf": [ { "$ref": "#/components/schemas/defs_channel" }, { "type": "null" } ] }, "pin_count": { "type": "integer" }, "priority": { "type": "number" }, "shares": { "items": { "properties": { "date_create": { "type": "integer" }, "id": { "$ref": "#/components/schemas/defs_team" }, "is_active": { "type": "boolean" }, "name": { "type": "string" }, "team": { "$ref": "#/components/schemas/objs_team" } }, "type": "object" }, "type": "array" }, "unread_count": { "type": "integer" }, "unread_count_display": { "type": "integer" }, "user": { "$ref": "#/components/schemas/defs_user_id" }, "version": { "type": "integer" } }, "title": "Conversation IM Channel Object from conversations.* methods", "type": "object" } ] }, "objs_enterprise_user": { "properties": { "enterprise_id": { "$ref": "#/components/schemas/defs_enterprise_id" }, "enterprise_name": { "$ref": "#/components/schemas/defs_enterprise_name" }, "id": { "$ref": "#/components/schemas/defs_enterprise_user_id" }, "is_admin": { "type": "boolean" }, "is_owner": { "type": "boolean" }, "teams": { "items": { "$ref": "#/components/schemas/defs_team" }, "type": "array" } }, "type": "object" }, "objs_external_org_migrations": { "properties": { "current": { "items": { "properties": { "date_started": { "type": "integer" }, "team_id": { "type": "string" } }, "type": "object" }, "type": "array" }, "date_updated": { "type": "integer" } }, "title": "External Org Migrations", "type": "object" }, "objs_file": { "properties": { "channels": { "items": { "$ref": "#/components/schemas/defs_channel_id" }, "type": "array" }, "comments_count": { "type": "integer" }, "created": { "type": "integer" }, "date_delete": { "type": "integer" }, "display_as_bot": { "type": "boolean" }, "editable": { "type": "boolean" }, "editor": { "$ref": "#/components/schemas/defs_user_id" }, "external_id": { "type": "string" }, "external_type": { "type": "string" }, "external_url": { "format": "uri", "type": "string" }, "filetype": { "type": "string" }, "groups": { "items": { "$ref": "#/components/schemas/defs_group_id" }, "type": "array" }, "has_rich_preview": { "type": "boolean" }, "id": { "$ref": "#/components/schemas/defs_file_id" }, "image_exif_rotation": { "type": "integer" }, "ims": { "items": { "$ref": "#/components/schemas/defs_dm_id" }, "type": "array" }, "is_external": { "type": "boolean" }, "is_public": { "type": "boolean" }, "is_starred": { "type": "boolean" }, "is_tombstoned": { "type": "boolean" }, "last_editor": { "$ref": "#/components/schemas/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": "#/components/schemas/defs_pinned_info" }, "pinned_to": { "items": { "$ref": "#/components/schemas/defs_channel" }, "type": "array" }, "pretty_type": { "type": "string" }, "preview": { "type": "string" }, "public_url_shared": { "type": "boolean" }, "reactions": { "items": { "$ref": "#/components/schemas/objs_reaction" }, "type": "array" }, "shares": { "properties": { "private": {}, "public": {} }, "type": "object" }, "size": { "type": "integer" }, "source_team": { "$ref": "#/components/schemas/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": "#/components/schemas/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": { "properties": { "attachments": { "items": { "properties": { "fallback": { "type": "string" }, "id": { "type": "integer" }, "image_bytes": { "type": "integer" }, "image_height": { "type": "integer" }, "image_url": { "type": "string" }, "image_width": { "type": "integer" } }, "type": "object" }, "type": "array" }, "blocks": { "$ref": "#/components/schemas/blocks" }, "bot_id": { "anyOf": [ { "$ref": "#/components/schemas/defs_bot_id" }, { "title": "Nil bot_id set when display_as_bot is false", "type": "null" } ] }, "bot_profile": { "$ref": "#/components/schemas/objs_bot_profile" }, "client_msg_id": { "type": "string" }, "comment": { "$ref": "#/components/schemas/objs_comment" }, "display_as_bot": { "type": "boolean" }, "file": { "$ref": "#/components/schemas/objs_file" }, "files": { "items": { "$ref": "#/components/schemas/objs_file" }, "type": "array" }, "icons": { "properties": { "emoji": { "type": "string" }, "image_64": { "format": "uri", "type": "string" } }, "type": "object" }, "inviter": { "$ref": "#/components/schemas/defs_user_id" }, "is_delayed_message": { "type": "boolean" }, "is_intro": { "type": "boolean" }, "is_starred": { "type": "boolean" }, "last_read": { "$ref": "#/components/schemas/defs_ts" }, "latest_reply": { "$ref": "#/components/schemas/defs_ts" }, "name": { "type": "string" }, "old_name": { "type": "string" }, "parent_user_id": { "$ref": "#/components/schemas/defs_user_id" }, "permalink": { "format": "uri", "type": "string" }, "pinned_to": { "items": { "$ref": "#/components/schemas/defs_channel" }, "type": "array" }, "purpose": { "type": "string" }, "reactions": { "items": { "$ref": "#/components/schemas/objs_reaction" }, "type": "array" }, "reply_count": { "type": "integer" }, "reply_users": { "items": { "$ref": "#/components/schemas/defs_user_id" }, "type": "array" }, "reply_users_count": { "type": "integer" }, "source_team": { "$ref": "#/components/schemas/defs_workspace_id" }, "subscribed": { "type": "boolean" }, "subtype": { "type": "string" }, "team": { "$ref": "#/components/schemas/defs_workspace_id" }, "text": { "type": "string" }, "thread_ts": { "$ref": "#/components/schemas/defs_ts" }, "topic": { "type": "string" }, "ts": { "$ref": "#/components/schemas/defs_ts" }, "type": { "type": "string" }, "unread_count": { "type": "integer" }, "upload": { "type": "boolean" }, "user": { "$ref": "#/components/schemas/defs_user_id" }, "user_profile": { "$ref": "#/components/schemas/objs_user_profile_short" }, "user_team": { "$ref": "#/components/schemas/defs_workspace_id" }, "username": { "type": "string" } }, "title": "Message object", "type": "object" }, "objs_paging": { "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "pages": { "type": "integer" }, "per_page": { "type": "integer" }, "spill": { "type": "integer" }, "total": { "type": "integer" } }, "title": "paging object", "type": "object" }, "objs_primary_owner": { "properties": { "email": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "objs_reaction": { "additionalProperties": true, "properties": { "count": { "type": "integer" }, "name": { "type": "string" }, "users": { "items": { "$ref": "#/components/schemas/defs_user_id" }, "type": "array" } }, "title": "Reaction object", "type": "object" }, "objs_reminder": { "properties": { "complete_ts": { "type": "integer" }, "creator": { "$ref": "#/components/schemas/defs_user_id" }, "id": { "$ref": "#/components/schemas/defs_reminder_id" }, "recurring": { "type": "boolean" }, "text": { "type": "string" }, "time": { "type": "integer" }, "user": { "$ref": "#/components/schemas/defs_user_id" } }, "type": "object" }, "objs_resources": { "properties": { "excluded_ids": { "items": { "anyOf": [ { "$ref": "#/components/schemas/defs_channel" }, { "$ref": "#/components/schemas/defs_team" } ] }, "type": "array" }, "ids": { "items": { "anyOf": [ { "$ref": "#/components/schemas/defs_channel" }, { "$ref": "#/components/schemas/defs_team" } ] }, "type": "array" }, "wildcard": { "type": "boolean" } }, "title": "resources in info from apps.permissions.info", "type": "object" }, "objs_response_metadata": { "anyOf": [ { "properties": { "next_cursor": { "type": "string" } }, "title": "new paging style", "type": "object" }, { "properties": { "messages": { "items": { "type": "string" }, "type": "array" }, "warnings": { "items": { "enum": [ "method_deprecated" ], "type": "string" }, "type": "array" } }, "title": "deprecation_warning", "type": "object" }, { "properties": { "messages": { "items": { "type": "string" }, "type": "array" }, "next_cursor": { "type": "string" }, "warnings": { "items": { "enum": [ "method_deprecated" ], "type": "string" }, "type": "array" } }, "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": { "properties": { "auto_provision": { "type": "boolean" }, "auto_type": { "anyOf": [ { "type": "null" }, { "enum": [ "owner", "admin" ], "type": "string" } ] }, "channel_count": { "type": "integer" }, "created_by": { "$ref": "#/components/schemas/defs_user_id" }, "date_create": { "type": "integer" }, "date_delete": { "type": "integer" }, "date_update": { "type": "integer" }, "deleted_by": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/defs_user_id" } ] }, "description": { "type": "string" }, "enterprise_subteam_id": { "type": "string" }, "handle": { "type": "string" }, "id": { "$ref": "#/components/schemas/defs_subteam_id" }, "is_external": { "type": "boolean" }, "is_subteam": { "type": "boolean" }, "is_usergroup": { "type": "boolean" }, "name": { "type": "string" }, "prefs": { "properties": { "channels": { "items": { "$ref": "#/components/schemas/defs_channel_id" }, "type": "array" }, "groups": { "items": { "$ref": "#/components/schemas/defs_group_id" }, "type": "array" } }, "type": "object" }, "team_id": { "$ref": "#/components/schemas/defs_team" }, "updated_by": { "$ref": "#/components/schemas/defs_user_id" }, "user_count": { "type": "integer" }, "users": { "items": { "$ref": "#/components/schemas/defs_user_id" }, "type": "array" } }, "title": "Subteam/Usergroup Object", "type": "object" }, "objs_team": { "properties": { "archived": { "type": "boolean" }, "avatar_base_url": { "format": "uri", "type": "string" }, "created": { "type": "integer" }, "date_create": { "type": "integer" }, "deleted": { "type": "boolean" }, "description": { "type": [ "null", "string" ] }, "discoverable": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "domain": { "type": "string" }, "email_domain": { "type": "string" }, "enterprise_id": { "$ref": "#/components/schemas/defs_enterprise_id" }, "enterprise_name": { "$ref": "#/components/schemas/defs_enterprise_name" }, "external_org_migrations": { "$ref": "#/components/schemas/objs_external_org_migrations" }, "has_compliance_export": { "type": "boolean" }, "icon": { "$ref": "#/components/schemas/objs_icon" }, "id": { "$ref": "#/components/schemas/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": "#/components/schemas/objs_primary_owner" }, "sso_provider": { "properties": { "label": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } }, "title": "Team Object", "type": "object" }, "objs_team_profile_field": { "properties": { "field_name": { "type": [ "null", "string" ] }, "hint": { "type": "string" }, "id": { "type": "string" }, "is_hidden": { "type": "boolean" }, "label": { "type": "string" }, "options": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/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" } }, "type": "object" }, "objs_team_profile_field_option": { "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": { "anyOf": [ { "description": "user object for non enterprise type", "properties": { "color": { "type": "string" }, "deleted": { "type": "boolean" }, "enterprise_user": { "$ref": "#/components/schemas/objs_enterprise_user" }, "has_2fa": { "type": "boolean" }, "id": { "$ref": "#/components/schemas/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": "#/components/schemas/objs_user_profile" }, "real_name": { "type": "string" }, "team": { "$ref": "#/components/schemas/defs_workspace_id" }, "team_id": { "$ref": "#/components/schemas/defs_workspace_id" }, "team_profile": { "properties": { "fields": { "items": { "$ref": "#/components/schemas/objs_team_profile_field" }, "type": "array" } }, "type": "object" }, "two_factor_type": { "type": "string" }, "tz": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "tz_label": { "type": "string" }, "tz_offset": { "type": "number" }, "updated": { "type": "number" } }, "type": "object" }, { "description": "enterprise user", "properties": { "color": { "description": "refercing to bug: https://jira.tinyspeck.com/browse/EVALUE-1559", "type": "string" }, "deleted": { "type": "boolean" }, "enterprise_user": { "$ref": "#/components/schemas/objs_enterprise_user" }, "has_2fa": { "type": "boolean" }, "id": { "$ref": "#/components/schemas/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": "#/components/schemas/objs_user_profile" }, "real_name": { "type": "string" }, "team_id": { "$ref": "#/components/schemas/defs_workspace_id" }, "team_profile": { "properties": { "fields": { "items": { "$ref": "#/components/schemas/objs_team_profile_field" }, "type": "array" } }, "type": "object" }, "teams": { "items": { "$ref": "#/components/schemas/defs_workspace_id" }, "type": "array" }, "two_factor_type": { "type": "string" }, "tz": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "tz_label": { "type": "string" }, "tz_offset": { "type": "number" }, "updated": { "type": "number" } }, "type": "object" } ] }, "objs_user_profile": { "properties": { "always_active": { "type": "boolean" }, "api_app_id": { "$ref": "#/components/schemas/defs_optional_app_id" }, "avatar_hash": { "type": "string" }, "bot_id": { "$ref": "#/components/schemas/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": "#/components/schemas/defs_workspace_id" }, "title": { "type": "string" }, "updated": { "type": "integer" }, "user_id": { "type": "string" }, "username": { "type": [ "null", "string" ] } }, "title": "User profile object", "type": "object" }, "objs_user_profile_short": { "properties": { "avatar_hash": { "type": "string" }, "display_name": { "type": "string" }, "display_name_normalized": { "type": "string" }, "first_name": { "type": [ "string", "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": "#/components/schemas/defs_workspace_id" } }, "type": "object" } }, "securitySchemes": { "slackAuth": { "flows": { "authorizationCode": { "authorizationUrl": "https://slack.com/oauth/v2/authorize", "scopes": { "calls:read": "calls:read", "calls:write": "calls:write", "channels:history": "channels:history", "channels:join": "channels:join", "channels:manage": "channels:manage", "channels:read": "channels:read", "channels:write.invites": "channels:write.invites", "channels:write.topic": "channels:write.topic", "chat:write": "chat:write", "dnd:read": "dnd:read", "emoji:read": "emoji:read", "files:read": "files:read", "files:write": "files:write", "groups:history": "groups:history", "groups:read": "groups:read", "groups:write": "groups:write", "groups:write.invites": "groups:write.invites", "groups:write.topic": "groups:write.topic", "im:history": "im:history", "im:read": "im:read", "im:write": "im:write", "im:write.topic": "im:write.topic", "links:write": "links:write", "mpim:history": "mpim:history", "mpim:read": "mpim:read", "mpim:write": "mpim:write", "mpim:write.topic": "mpim:write.topic", "pins:read": "pins:read", "pins:write": "pins:write", "reactions:read": "reactions:read", "reactions:write": "reactions:write", "remote_files:read": "remote_files:read", "remote_files:share": "remote_files:share", "remote_files:write": "remote_files:write", "team:read": "team:read", "tokens.basic": "tokens.basic", "usergroups:read": "usergroups:read", "usergroups:write": "usergroups:write", "users.profile:read": "users.profile:read", "users:read": "users:read", "users:read.email": "users:read.email", "users:write": "users:write" }, "tokenUrl": "https://slack.com/api/oauth.v2.access" } }, "type": "oauth2" } } }, "externalDocs": { "description": "Learn more about the Slack Web API", "url": "https://api.slack.com/web" }, "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" }, "openapi": "3.1.0", "paths": { "/api.test": { "get": { "description": "Checks API calling code.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/api.test" }, "operationId": "api_test", "parameters": [ { "description": "Error response to return", "in": "query", "name": "error", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "description": "Schema for successful response api.test method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "api.test success schema", "type": "object" } } }, "description": "Standard success response" }, "default": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "description": "Schema for error response api.test method", "properties": { "error": { "type": "string" }, "ok": { "$ref": "#/components/schemas/defs_ok_false" } }, "title": "api.test error schema", "type": "object" } } }, "description": "Artificial error response" } }, "security": [], "summary": "Checks API calling code", "tags": [ "api" ] } }, "/auth.test": { "get": { "description": "Checks authentication & identity.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/auth.test" }, "operationId": "auth_test", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response auth.test method", "properties": { "bot_id": { "$ref": "#/components/schemas/defs_bot_id" }, "is_enterprise_install": { "type": "boolean" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "team": { "type": "string" }, "team_id": { "$ref": "#/components/schemas/defs_team" }, "url": { "type": "string" }, "user": { "type": "string" }, "user_id": { "$ref": "#/components/schemas/defs_user_id" } }, "required": [ "ok" ], "title": "auth.test success schema", "type": "object" } } }, "description": "Standard success response when used with a user token" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "auth.test error schema", "type": "object" } } }, "description": "Standard failure response when used with an invalid token" } }, "security": [], "summary": "Checks authentication & identity", "tags": [ "auth" ] } }, "/bots.info": { "get": { "description": "Gets information about a bot user.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/bots.info" }, "operationId": "bots_info", "parameters": [ { "description": "Bot user to get info on", "in": "query", "name": "bot", "required": false, "schema": { "type": "string" } }, { "description": "encoded team id or enterprise id where the bot exists, required if org token is used", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from bots.info method", "properties": { "bot": { "properties": { "app_id": { "$ref": "#/components/schemas/defs_app_id" }, "deleted": { "type": "boolean" }, "icons": { "properties": { "image_36": { "format": "uri", "type": "string" }, "image_48": { "format": "uri", "type": "string" }, "image_72": { "format": "uri", "type": "string" } }, "type": "object" }, "id": { "$ref": "#/components/schemas/defs_bot_id" }, "name": { "type": "string" }, "updated": { "type": "integer" }, "user_id": { "$ref": "#/components/schemas/defs_user_id" } }, "type": "object" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "bots.info schema", "type": "object" } } }, "description": "When successful, returns bot info by bot ID." }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "bots.info error schema", "type": "object" } } }, "description": "When no bot can be found, it returns an error." } }, "security": [ { "slackAuth": [ "users:read" ] } ], "summary": "Gets information about a bot user", "tags": [ "bots" ] } }, "/calls.add": { "post": { "description": "Registers a new Call.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/calls.add" }, "operationId": "calls_add", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "created_by": { "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.", "type": "string" }, "date_start": { "description": "Unix timestamp of the call start time", "type": "integer" }, "desktop_app_join_url": { "description": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.", "type": "string" }, "external_display_id": { "description": "An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.", "type": "string" }, "external_unique_id": { "description": "An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.", "type": "string" }, "join_url": { "description": "The URL required for a client to join the Call.", "type": "string" }, "title": { "description": "The name of the Call.", "type": "string" }, "users": { "description": "The list of users to register as participants in the Call. Read more on how to specify users here.", "type": "string" } }, "required": [ "external_unique_id", "join_url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "calls:write" ] } ], "summary": "Registers a new Call", "tags": [ "calls" ] } }, "/calls.end": { "post": { "description": "Ends a Call.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/calls.end" }, "operationId": "calls_end", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "duration": { "description": "Call duration in seconds", "type": "integer" }, "id": { "description": "`id` returned when registering the call using the `calls.add` method.", "type": "string" } }, "required": [ "id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "calls:write" ] } ], "summary": "Ends a Call", "tags": [ "calls" ] } }, "/calls.info": { "get": { "description": "Returns information about a Call.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/calls.info" }, "operationId": "calls_info", "parameters": [ { "description": "`id` of the Call returned by the `calls.add` method.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "calls:read" ] } ], "summary": "Returns information about a Call", "tags": [ "calls" ] } }, "/calls.participants.add": { "post": { "description": "Registers new participants added to a Call.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/calls.participants.add" }, "operationId": "calls_participants_add", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "id": { "description": "`id` returned by the `calls.add` method.", "type": "string" }, "users": { "description": "The list of users to add as participants in the Call. Read more on how to specify users here.", "type": "string" } }, "required": [ "id", "users" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "calls:write" ] } ], "summary": "Registers new participants added to a Call", "tags": [ "calls.participants", "calls" ] } }, "/calls.participants.remove": { "post": { "description": "Registers participants removed from a Call.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/calls.participants.remove" }, "operationId": "calls_participants_remove", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "id": { "description": "`id` returned by the `calls.add` method.", "type": "string" }, "users": { "description": "The list of users to remove as participants in the Call. Read more on how to specify users here.", "type": "string" } }, "required": [ "id", "users" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "calls:write" ] } ], "summary": "Registers participants removed from a Call", "tags": [ "calls.participants", "calls" ] } }, "/calls.update": { "post": { "description": "Updates information about a Call.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/calls.update" }, "operationId": "calls_update", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "desktop_app_join_url": { "description": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.", "type": "string" }, "id": { "description": "`id` returned by the `calls.add` method.", "type": "string" }, "join_url": { "description": "The URL required for a client to join the Call.", "type": "string" }, "title": { "description": "The name of the Call.", "type": "string" } }, "required": [ "id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "calls:write" ] } ], "summary": "Updates information about a Call", "tags": [ "calls" ] } }, "/chat.delete": { "post": { "description": "Deletes a message.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/chat.delete" }, "operationId": "chat_delete", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "as_user": { "description": "(Legacy) Pass true to delete the message as the authed user with `chat:write:user` scope. Bot users in this context are considered authed users.", "type": "boolean" }, "channel": { "description": "Channel containing the message to be deleted.", "type": "string" }, "ts": { "description": "Timestamp of the message to be deleted.", "type": "string" } }, "required": [ "channel", "ts" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response of chat.delete method", "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "ts": { "$ref": "#/components/schemas/defs_ts" } }, "required": [ "ok" ], "title": "chat.delete success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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", "compliance_exports_prevent_deletion", "not_authed", "invalid_auth", "account_inactive", "token_revoked", "no_permission", "invalid_arg_name", "invalid_array_arg", "invalid_charset", "invalid_form_data", "invalid_post_type", "missing_post_type", "team_added_to_org", "invalid_json", "json_not_object", "request_timeout", "upgrade_required", "fatal_error" ], "type": "string" }, "ok": { "$ref": "#/components/schemas/defs_ok_false" } }, "title": "chat.delete error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "chat:write" ] } ], "summary": "Deletes a message", "tags": [ "chat" ] } }, "/chat.deleteScheduledMessage": { "post": { "description": "Deletes a pending scheduled message from the queue.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/chat.deleteScheduledMessage" }, "operationId": "chat_deleteScheduledMessage", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "as_user": { "description": "Pass true to delete the message as the authed user with `chat:write:user` scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope.", "type": "boolean" }, "channel": { "description": "The channel the scheduled_message is posting to", "type": "string" }, "scheduled_message_id": { "description": "`scheduled_message_id` returned from call to chat.scheduleMessage", "type": "string" } }, "required": [ "channel", "scheduled_message_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from chat.deleteScheduledMessage method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "chat.deleteScheduledMessage schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "chat.deleteScheduledMessage error schema", "type": "object" } } }, "description": "Typical error response if no message is found" } }, "security": [ { "slackAuth": [ "chat:write" ] } ], "summary": "Deletes a pending scheduled message from the queue", "tags": [ "chat" ] } }, "/chat.getPermalink": { "get": { "description": "Retrieve a permalink URL for a specific extant message", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/chat.getPermalink" }, "operationId": "chat_getPermalink", "parameters": [ { "description": "The ID of the conversation or channel containing the message", "in": "query", "name": "channel", "required": true, "schema": { "type": "string" } }, { "description": "A message's `ts` value, uniquely identifying it within a channel", "in": "query", "name": "message_ts", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response chat.getPermalink", "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "permalink": { "format": "uri", "type": "string" } }, "required": [ "ok" ], "title": "chat.getPermalink success schema", "type": "object" } } }, "description": "Standard success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "chat.getPermalink error schema", "type": "object" } } }, "description": "Error response when channel cannot be found" } }, "security": [], "summary": "Retrieve a permalink URL for a specific extant message", "tags": [ "chat" ] } }, "/chat.meMessage": { "post": { "description": "Share a me message into a channel.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/chat.meMessage" }, "operationId": "chat_meMessage", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.", "type": "string" }, "text": { "description": "Text of the message to send.", "type": "string" } }, "required": [ "channel", "text" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from chat.meMessage method", "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "ts": { "$ref": "#/components/schemas/defs_ts" } }, "required": [ "ok" ], "title": "chat.meMessage schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "chat.meMessage error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "chat:write" ] } ], "summary": "Share a me message into a channel", "tags": [ "chat" ] } }, "/chat.postEphemeral": { "post": { "description": "Sends an ephemeral message to a user in a channel.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/chat.postEphemeral" }, "operationId": "chat_postEphemeral", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "as_user": { "description": "(Legacy) 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.", "type": "boolean" }, "attachments": { "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", "type": "string" }, "blocks": { "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", "type": "string" }, "channel": { "description": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.", "type": "string" }, "icon_emoji": { "description": "Emoji to use as the icon for this message. Overrides `icon_url`.", "type": "string" }, "icon_url": { "description": "URL to an image to use as the icon for this message.", "type": "string" }, "link_names": { "description": "Find and link channel names and usernames.", "type": "boolean" }, "markdown_text": { "description": "Accepts message text formatted in markdown. This argument should not be used in conjunction with `blocks` or `text`. Limit this field to 12,000 characters.", "type": "string" }, "metadata": { "description": "JSON object with an `entities` array of work object entity metadata, presented as a URL-encoded string. Only entity metadata is supported: ephemeral messages are not persisted and never dispatch `message_metadata_*` events, so `event_type`/`event_payload` message metadata is ignored here. Each entity requires `entity_type`, `entity_payload`, `external_ref`, and `url`.", "type": "string" }, "parse": { "description": "Change how messages are treated. Defaults to `none`.", "type": "string" }, "text": { "description": "How this field works and whether it is required depends on other fields you use in your API call.", "type": "string" }, "thread_ts": { "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.", "type": "string" }, "user": { "description": "`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.", "type": "string" }, "username": { "description": "Set your bot's user name.", "type": "string" } }, "required": [ "channel", "user" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from chat.postEphemeral method", "properties": { "message_ts": { "$ref": "#/components/schemas/defs_ts" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "chat.postEphemeral success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "chat.postEphemeral error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "chat:write" ] } ], "summary": "Sends an ephemeral message to a user in a channel", "tags": [ "chat" ] } }, "/chat.postMessage": { "post": { "description": "Sends a message to a channel.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/chat.postMessage" }, "operationId": "chat_postMessage", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "as_user": { "description": "(Legacy) Pass true to post the message as the authed user instead of as a bot. Defaults to false. Can only be used by classic apps.", "type": "boolean" }, "attachments": { "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", "type": "string" }, "blocks": { "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", "type": "string" }, "channel": { "description": "An encoded ID or channel name that represents a channel, private group, or IM channel to send the message to.", "type": "string" }, "current_draft_last_updated_ts": { "description": "This field represents the timestamp of the draft's last update at the time this API is called. If the current message is a draft, this field can be provided to ensure synchronization with the server.", "type": "string" }, "icon_emoji": { "description": "Emoji to use as the icon for this message. Overrides `icon_url`.", "type": "string" }, "icon_url": { "description": "URL to an image to use as the icon for this message.", "type": "string" }, "link_names": { "description": "Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.", "type": "boolean" }, "markdown_text": { "description": "Accepts message text formatted in markdown. This argument should not be used in conjunction with `blocks` or `text`. Limit this field to 12,000 characters.", "type": "string" }, "metadata": { "description": "JSON object with event_type and event_payload fields, presented as a URL-encoded string. You can also provide Work Object entity metadata using this parameter. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.", "type": "string" }, "mrkdwn": { "description": "Disable Slack markup parsing by setting to `false`. Enabled by default.", "type": "boolean" }, "parse": { "description": "Change how messages are treated.", "type": "string" }, "reply_broadcast": { "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`.", "type": "boolean" }, "text": { "description": "How this field works and whether it is required depends on other fields you use in your API call.", "type": "string" }, "thread_ts": { "description": "Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.", "type": "string" }, "unfurl_app_links": { "description": "Pass true to unfurl links from installed apps, or false to prevent app links from unfurling. When omitted, app links follow the `unfurl_links` setting.", "type": "boolean" }, "unfurl_links": { "description": "Pass true to enable unfurling of primarily text-based content.", "type": "boolean" }, "unfurl_media": { "description": "Pass false to disable unfurling of media content.", "type": "boolean" }, "username": { "description": "Set your bot's user name.", "type": "string" } }, "required": [ "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response of chat.postMessage method", "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" }, "message": { "$ref": "#/components/schemas/objs_message" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "ts": { "$ref": "#/components/schemas/defs_ts" } }, "required": [ "ok" ], "title": "chat.postMessage success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "chat.postMessage error schema", "type": "object" } } }, "description": "Typical error response if too many attachments are included" } }, "security": [ { "slackAuth": [ "chat:write" ] } ], "summary": "Sends a message to a channel", "tags": [ "chat" ] } }, "/chat.scheduleMessage": { "post": { "description": "Schedules a message to be sent to a channel.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/chat.scheduleMessage" }, "operationId": "chat_scheduleMessage", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "as_user": { "description": "Set to `true` to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See chat.postMessage.", "type": "boolean" }, "attachments": { "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", "type": "string" }, "blocks": { "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", "type": "string" }, "channel": { "description": "Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name.", "type": "string" }, "link_names": { "description": "Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.", "type": "boolean" }, "markdown_text": { "description": "Accepts message text formatted in markdown. This argument should not be used in conjunction with `blocks` or `text`. Limit this field to 12,000 characters.", "type": "string" }, "metadata": { "description": "JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.", "type": "string" }, "parse": { "description": "Change how messages are treated. See chat.postMessage.", "type": "string" }, "post_at": { "description": "Unix timestamp representing the future time the message should post to Slack.", "type": "integer" }, "reply_broadcast": { "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`.", "type": "boolean" }, "text": { "description": "How this field works and whether it is required depends on other fields you use in your API call.", "type": "string" }, "thread_ts": { "description": "Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.", "type": "string" }, "unfurl_links": { "description": "Pass true to enable unfurling of primarily text-based content.", "type": "boolean" }, "unfurl_media": { "description": "Pass false to disable unfurling of media content.", "type": "boolean" } }, "required": [ "channel", "post_at" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response of chat.scheduleMessage method", "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" }, "message": { "properties": { "bot_id": { "$ref": "#/components/schemas/defs_bot_id" }, "bot_profile": { "$ref": "#/components/schemas/objs_bot_profile" }, "team": { "$ref": "#/components/schemas/defs_team" }, "text": { "type": "string" }, "type": { "type": "string" }, "user": { "$ref": "#/components/schemas/defs_user_id" }, "username": { "type": "string" } }, "type": "object" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "post_at": { "type": "integer" }, "scheduled_message_id": { "title": "Scheduled Message ID", "type": "string" } }, "required": [ "ok" ], "title": "chat.scheduleMessage success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "chat.scheduleMessage error schema", "type": "object" } } }, "description": "Typical error response if the `post_at` is invalid (ex. in the past or too far into the future)" } }, "security": [ { "slackAuth": [ "chat:write" ] } ], "summary": "Schedules a message to be sent to a channel", "tags": [ "chat" ] } }, "/chat.scheduledMessages.list": { "get": { "description": "Returns a list of scheduled messages.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/chat.scheduledMessages.list" }, "operationId": "chat_scheduledMessages_list", "parameters": [ { "description": "The channel of the scheduled messages", "in": "query", "name": "channel", "required": false, "schema": { "type": "string" } }, { "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", "required": false, "schema": { "type": "string" } }, { "description": "A Unix timestamp of the latest value in the time range", "in": "query", "name": "latest", "required": false, "schema": { "type": "string" } }, { "description": "Maximum number of original entries to return.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "A Unix timestamp of the oldest value in the time range", "in": "query", "name": "oldest", "required": false, "schema": { "type": "string" } }, { "description": "encoded team id to list channels in, required if org token is used", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from chat.scheduledMessages.list method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "response_metadata": { "properties": { "next_cursor": { "type": "string" } }, "type": "object" }, "scheduled_messages": { "items": { "properties": { "channel_id": { "$ref": "#/components/schemas/defs_channel_id" }, "date_created": { "type": "integer" }, "id": { "type": "string" }, "post_at": { "type": "integer" }, "text": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "ok" ], "title": "chat.scheduledMessages.list schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "chat.scheduledMessages.list error schema", "type": "object" } } }, "description": "Typical error response if the channel passed is invalid" } }, "security": [], "summary": "Returns a list of scheduled messages", "tags": [ "chat.scheduledMessages", "chat" ] } }, "/chat.unfurl": { "post": { "description": "Provide custom unfurl behavior for user-posted URLs", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/chat.unfurl" }, "operationId": "chat_unfurl", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Channel ID of the message. Both `channel` and `ts` must be provided together, _or_ `unfurl_id` and `source` must be provided together. Required for public channels.", "type": "string" }, "source": { "description": "The source of the link to unfurl. The source may either be `composer`, when the link is inside the message composer, or `conversations_history`, when the link has been posted to a conversation.", "type": "string" }, "ts": { "description": "Timestamp of the message to add unfurl behavior to. Required for public channels.", "type": "string" }, "unfurl_id": { "description": "The ID of the link to unfurl. Both `unfurl_id` and `source` must be provided together, _or_ `channel` and `ts` must be provided together.", "type": "string" }, "unfurls": { "description": "URL-encoded JSON map with keys set to URLs featured in the message, pointing to their unfurl blocks or message attachments. Required for public channels.", "type": "string" }, "user_auth_blocks": { "description": "Provide a JSON based array of structured blocks presented as URL-encoded string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior", "type": "string" }, "user_auth_message": { "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. Provides two buttons, `Not now` or `Never ask me again`.", "type": "string" }, "user_auth_required": { "description": "Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain", "type": "boolean" }, "user_auth_url": { "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.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from chat.unfurl method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "chat.unfurl success schema", "type": "object" } } }, "description": "Typical, minimal success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "chat.unfurl error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "links:write" ] } ], "summary": "Provide custom unfurl behavior for user-posted URLs", "tags": [ "chat" ] } }, "/chat.update": { "post": { "description": "Updates a message.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/chat.update" }, "operationId": "chat_update", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "as_user": { "description": "Pass true to update the message as the authed user. Bot users in this context are considered authed users.", "type": "boolean" }, "attachments": { "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", "type": "string" }, "blocks": { "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", "type": "string" }, "channel": { "description": "Channel containing the message to be updated. For direct messages, ensure that this value is a DM ID (starts with `D`) instead of a User ID (starts with either `U` or `W`).", "type": "string" }, "file_ids": { "description": "Array of new file ids that will be sent with this message.", "type": "string" }, "link_names": { "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`.", "type": "boolean" }, "markdown_text": { "description": "Accepts message text formatted in markdown. This argument should not be used in conjunction with `blocks` or `text`. Limit this field to 12,000 characters.", "type": "string" }, "metadata": { "description": "JSON object with event_type and event_payload fields, presented as a URL-encoded string. If you don't include this field, the message's previous `metadata` will be retained. To remove previous `metadata`, include an empty object for this field. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.", "type": "string" }, "parse": { "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`.", "type": "string" }, "reply_broadcast": { "description": "Broadcast an existing thread reply to make it visible to everyone in the channel or conversation.", "type": "boolean" }, "text": { "description": "How this field works and whether it is required depends on other fields you use in your API call.", "type": "string" }, "ts": { "description": "Timestamp of the message to be updated.", "type": "string" }, "unfurled_attachments": { "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", "type": "string" } }, "required": [ "channel", "ts" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "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" } }, "title": "Message object", "type": "object" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "text": { "type": "string" }, "ts": { "type": "string" } }, "required": [ "ok" ], "title": "chat.update success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "chat.update error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "chat:write" ] } ], "summary": "Updates a message", "tags": [ "chat" ] } }, "/conversations.archive": { "post": { "description": "Archives a conversation.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.archive" }, "operationId": "conversations_archive", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "ID of conversation to archive", "type": "string" } }, "required": [ "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response conversations.archive method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.archive success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.archive error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:manage", "groups:write", "im:write", "mpim:write" ] } ], "summary": "Archives a conversation", "tags": [ "conversations" ] } }, "/conversations.close": { "post": { "description": "Closes a direct message or multi-person direct message.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.close" }, "operationId": "conversations_close", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Conversation to close.", "type": "string" } }, "required": [ "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response conversations.close method", "properties": { "already_closed": { "type": "boolean" }, "no_op": { "type": "boolean" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.close success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.close error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:manage", "groups:write", "im:write", "mpim:write" ] } ], "summary": "Closes a direct message or multi-person direct message", "tags": [ "conversations" ] } }, "/conversations.create": { "post": { "description": "Initiates a public or private channel-based conversation", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.create" }, "operationId": "conversations_create", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "is_private": { "description": "Create a private channel instead of a public one", "type": "boolean" }, "name": { "description": "Name of the public or private channel to create", "type": "string" }, "team_id": { "description": "encoded team id to create the channel in, required if org token is used", "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response conversations.create method", "properties": { "channel": { "$ref": "#/components/schemas/objs_conversation" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.create success schema", "type": "object" } } }, "description": "If successful, the command returns a rather stark [conversation object](/types/conversation)" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.create error schema", "type": "object" } } }, "description": "Typical error response when name already in use" } }, "security": [ { "slackAuth": [ "channels:manage", "groups:write", "im:write", "mpim:write" ] } ], "summary": "Initiates a public or private channel-based conversation", "tags": [ "conversations" ] } }, "/conversations.history": { "get": { "description": "Fetches a conversation's history of messages and events.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.history" }, "operationId": "conversations_history", "parameters": [ { "description": "Conversation ID to fetch history for.", "in": "query", "name": "channel", "required": true, "schema": { "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 for more detail.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return all metadata associated with this message.", "in": "query", "name": "include_all_metadata", "required": false, "schema": { "type": "boolean" } }, { "description": "Include messages with `oldest` or `latest` timestamps in results. Ignored unless either timestamp is specified.", "in": "query", "name": "inclusive", "required": false, "schema": { "type": "boolean" } }, { "description": "Only messages before this Unix timestamp will be included in results. Default is the current time.", "in": "query", "name": "latest", "required": false, "schema": { "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 conversation history hasn't been reached. Maximum of 999.", "in": "query", "name": "limit", "required": false, "schema": { "type": "number" } }, { "description": "Only messages after this Unix timestamp will be included in results.", "in": "query", "name": "oldest", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.history method", "properties": { "channel_actions_count": { "type": "integer" }, "channel_actions_ts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "has_more": { "type": "boolean" }, "messages": { "items": { "$ref": "#/components/schemas/objs_message" }, "type": "array" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "pin_count": { "type": "integer" } }, "required": [ "ok" ], "title": "conversations.history success schema", "type": "object" } } }, "description": "Typical success response containing a channel's messages" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.history error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:history", "groups:history", "im:history", "mpim:history" ] } ], "summary": "Fetches a conversation's history of messages and events", "tags": [ "conversations" ] } }, "/conversations.info": { "get": { "description": "Retrieve information about a conversation.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.info" }, "operationId": "conversations_info", "parameters": [ { "description": "Conversation ID to learn more about", "in": "query", "name": "channel", "required": true, "schema": { "type": "string" } }, { "description": "Set this to `true` to receive the locale for this conversation. Defaults to `false`", "in": "query", "name": "include_locale", "required": false, "schema": { "type": "boolean" } }, { "description": "Set to `true` to include the member count for the specified conversation. Defaults to `false`", "in": "query", "name": "include_num_members", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response conversations.info", "properties": { "channel": { "$ref": "#/components/schemas/objs_conversation" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.info success schema", "type": "object" } } }, "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.)" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.info error schema", "type": "object" } } }, "description": "Typical error response when a channel cannot be found" } }, "security": [ { "slackAuth": [ "channels:read", "groups:read", "im:read", "mpim:read" ] } ], "summary": "Retrieve information about a conversation", "tags": [ "conversations" ] } }, "/conversations.invite": { "post": { "description": "Invites users to a channel.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.invite" }, "operationId": "conversations_invite", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "The ID of the public or private channel to invite user(s) to.", "type": "string" }, "force": { "description": "When set to `true` and multiple user IDs are provided, continue inviting the valid ones while disregarding invalid IDs. Defaults to `false`.", "type": "boolean" }, "users": { "description": "A comma separated list of user IDs. Up to 1000 users may be listed.", "type": "string" } }, "required": [ "channel", "users" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.invite method", "properties": { "channel": { "$ref": "#/components/schemas/objs_conversation" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.invite error schema", "type": "object" } } }, "description": "Typical success response when an invitation is extended" }, "default": { "content": { "application/json": { "schema": { "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": { "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": "#/components/schemas/defs_ok_false" }, "user": { "$ref": "#/components/schemas/defs_user_id" } }, "type": "object" }, "title": "errors is returned when an error associates an user", "type": "array" }, "needed": { "type": "string" }, "ok": { "$ref": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.invite error schema", "type": "object" } } }, "description": "Typical error response when an invite is attempted on a conversation type that does not support it" } }, "security": [ { "slackAuth": [ "channels:manage", "channels:write.invites", "groups:write", "groups:write.invites", "im:write", "mpim:write" ] } ], "summary": "Invites users to a channel", "tags": [ "conversations" ] } }, "/conversations.join": { "post": { "description": "Joins an existing conversation.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.join" }, "operationId": "conversations_join", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "ID of conversation to join", "type": "string" } }, "required": [ "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.join method", "properties": { "channel": { "$ref": "#/components/schemas/objs_conversation" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "response_metadata": { "properties": { "warnings": { "items": { "type": "string" }, "type": "array" } }, "title": "Response metadata", "type": "object" }, "warning": { "type": "string" } }, "required": [ "ok" ], "title": "conversations.join success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.join error schema", "type": "object" } } }, "description": "Typical error response if the conversation is archived and cannot be joined" } }, "security": [ { "slackAuth": [ "channels:join" ] } ], "summary": "Joins an existing conversation", "tags": [ "conversations" ] } }, "/conversations.kick": { "post": { "description": "Removes a user from a conversation.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.kick" }, "operationId": "conversations_kick", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "ID of conversation to remove user from.", "type": "string" }, "user": { "description": "User ID to be removed.", "type": "string" } }, "required": [ "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response conversations.kick method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.kick success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.kick error schema", "type": "object" } } }, "description": "Typical error response when you attempt to kick yourself from a channel" } }, "security": [ { "slackAuth": [ "channels:manage", "groups:write" ] } ], "summary": "Removes a user from a conversation", "tags": [ "conversations" ] } }, "/conversations.leave": { "post": { "description": "Leaves a conversation.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.leave" }, "operationId": "conversations_leave", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Conversation to leave", "type": "string" } }, "required": [ "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.leave method", "properties": { "not_in_channel": { "enum": [ true ], "type": "boolean" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.leave success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.leave error schema", "type": "object" } } }, "description": "Typical error response when attempting to leave a workspace's \"general\" channel" } }, "security": [ { "slackAuth": [ "channels:manage", "groups:write", "im:write", "mpim:write" ] } ], "summary": "Leaves a conversation", "tags": [ "conversations" ] } }, "/conversations.list": { "get": { "description": "Lists all channels in a Slack team.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.list" }, "operationId": "conversations_list", "parameters": [ { "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Set to `true` to exclude archived channels from the list.", "in": "query", "name": "exclude_archived", "required": false, "schema": { "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 under 1000.", "in": "query", "name": "limit", "required": false, "schema": { "type": "number" } }, { "description": "encoded team id to list channels in, required if token belongs to org-wide app", "in": "query", "name": "team_id", "required": false, "schema": { "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", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.list method", "properties": { "channels": { "items": { "$ref": "#/components/schemas/objs_conversation" }, "type": "array" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "response_metadata": { "properties": { "next_cursor": { "type": "string" } }, "type": "object" } }, "required": [ "ok" ], "title": "conversations.list success schema", "type": "object" } } }, "description": "Typical success response with only public channels" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.list error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:read", "groups:read", "im:read", "mpim:read" ] } ], "summary": "Lists all channels in a Slack team", "tags": [ "conversations" ] } }, "/conversations.mark": { "post": { "description": "Sets the read cursor in a channel.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.mark" }, "operationId": "conversations_mark", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Channel or conversation to set the read cursor for.", "type": "string" }, "ts": { "description": "Unique identifier of message you want marked as most recently seen in this conversation.", "type": "string" } }, "required": [ "channel", "ts" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response conversations.mark method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.mark success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.mark error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:manage", "groups:write", "im:write", "mpim:write" ] } ], "summary": "Sets the read cursor in a channel", "tags": [ "conversations" ] } }, "/conversations.members": { "get": { "description": "Retrieve members of a conversation.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.members" }, "operationId": "conversations_members", "parameters": [ { "description": "ID of the conversation to retrieve members for", "in": "query", "name": "channel", "required": true, "schema": { "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 for more detail.", "in": "query", "name": "cursor", "required": false, "schema": { "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", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response conversations.members method", "properties": { "members": { "items": { "$ref": "#/components/schemas/defs_user_id" }, "type": "array" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "response_metadata": { "properties": { "next_cursor": { "type": "string" } }, "type": "object" } }, "required": [ "ok" ], "title": "conversations.members success schema", "type": "object" } } }, "description": "Typical paginated success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "conversations.members error schema", "type": "object" } } }, "description": "Typical error response when an invalid cursor is provided" } }, "security": [ { "slackAuth": [ "channels:read", "groups:read", "im:read", "mpim:read" ] } ], "summary": "Retrieve members of a conversation", "tags": [ "conversations" ] } }, "/conversations.open": { "post": { "description": "Opens or resumes a direct message or multi-person direct message.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.open" }, "operationId": "conversations_open", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.", "type": "string" }, "prevent_creation": { "description": "Do not create a direct message or multi-person direct message. This is used to see if there is an existing dm or mpdm.", "type": "boolean" }, "return_im": { "description": "Boolean, indicates you want the full IM channel definition in the response.", "type": "boolean" }, "users": { "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`.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.open method when opening channels, ims, mpims", "properties": { "already_open": { "type": "boolean" }, "channel": { "anyOf": [ { "$ref": "#/components/schemas/objs_conversation" }, { "properties": { "created": { "type": "string" }, "id": { "$ref": "#/components/schemas/defs_dm_id" }, "is_im": { "type": "boolean" }, "is_open": { "type": "boolean" }, "last_read": { "$ref": "#/components/schemas/defs_ts" }, "latest": { "$ref": "#/components/schemas/objs_message" }, "unread_count": { "type": "number" }, "unread_count_display": { "type": "number" }, "user": { "$ref": "#/components/schemas/defs_user_id" } }, "type": "object" } ] }, "no_op": { "type": "boolean" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.open success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "conversations.open error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:manage", "groups:write", "im:write", "mpim:write" ] } ], "summary": "Opens or resumes a direct message or multi-person direct message", "tags": [ "conversations" ] } }, "/conversations.rename": { "post": { "description": "Renames a conversation.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.rename" }, "operationId": "conversations_rename", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "ID of conversation to rename", "type": "string" }, "name": { "description": "New name for conversation.", "type": "string" } }, "required": [ "channel", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.rename method", "properties": { "channel": { "$ref": "#/components/schemas/objs_conversation" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.rename success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.rename error schema", "type": "object" } } }, "description": "Typical error response when the calling user is not a member of the conversation" } }, "security": [ { "slackAuth": [ "channels:manage", "groups:write", "im:write", "mpim:write" ] } ], "summary": "Renames a conversation", "tags": [ "conversations" ] } }, "/conversations.replies": { "get": { "description": "Retrieve a thread of messages posted to a conversation", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.replies" }, "operationId": "conversations_replies", "parameters": [ { "description": "Conversation ID to fetch thread from.", "in": "query", "name": "channel", "required": true, "schema": { "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 for more detail.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Return all metadata associated with this message.", "in": "query", "name": "include_all_metadata", "required": false, "schema": { "type": "boolean" } }, { "description": "Include messages with `oldest` or `latest` timestamps in results. Ignored unless either timestamp is specified.", "in": "query", "name": "inclusive", "required": false, "schema": { "type": "boolean" } }, { "description": "Only messages before this Unix timestamp will be included in results.", "in": "query", "name": "latest", "required": false, "schema": { "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", "required": false, "schema": { "type": "number" } }, { "description": "Only messages after this Unix timestamp will be included in results.", "in": "query", "name": "oldest", "required": false, "schema": { "type": "string" } }, { "description": "Unique identifier of either a thread’s parent message or a message in the thread. `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", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.replies method", "properties": { "has_more": { "type": "boolean" }, "messages": { "items": { "anyOf": [ { "properties": { "last_read": { "$ref": "#/components/schemas/defs_ts" }, "latest_reply": { "$ref": "#/components/schemas/defs_ts" }, "reply_count": { "type": "integer" }, "reply_users": { "items": { "$ref": "#/components/schemas/defs_user_id" }, "type": "array" }, "reply_users_count": { "type": "integer" }, "source_team": { "$ref": "#/components/schemas/defs_team" }, "subscribed": { "type": "boolean" }, "team": { "$ref": "#/components/schemas/defs_team" }, "text": { "type": "string" }, "thread_ts": { "$ref": "#/components/schemas/defs_ts" }, "ts": { "$ref": "#/components/schemas/defs_ts" }, "type": { "type": "string" }, "unread_count": { "type": "integer" }, "user": { "$ref": "#/components/schemas/defs_user_id" }, "user_profile": { "$ref": "#/components/schemas/objs_user_profile_short" }, "user_team": { "$ref": "#/components/schemas/defs_team" } }, "type": "object" }, { "properties": { "is_starred": { "type": "boolean" }, "parent_user_id": { "$ref": "#/components/schemas/defs_user_id" }, "source_team": { "$ref": "#/components/schemas/defs_team" }, "team": { "$ref": "#/components/schemas/defs_team" }, "text": { "type": "string" }, "thread_ts": { "$ref": "#/components/schemas/defs_ts" }, "ts": { "$ref": "#/components/schemas/defs_ts" }, "type": { "type": "string" }, "user": { "$ref": "#/components/schemas/defs_user_id" }, "user_profile": { "$ref": "#/components/schemas/objs_user_profile_short" }, "user_team": { "$ref": "#/components/schemas/defs_team" } }, "type": "object" } ] }, "type": "array" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.replies success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.replies error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:history", "groups:history", "im:history", "mpim:history" ] } ], "summary": "Retrieve a thread of messages posted to a conversation", "tags": [ "conversations" ] } }, "/conversations.setPurpose": { "post": { "description": "Sets the purpose for a conversation.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.setPurpose" }, "operationId": "conversations_setPurpose", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Channel to set the description of", "type": "string" }, "purpose": { "description": "The description", "type": "string" } }, "required": [ "channel", "purpose" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.setPurpose method", "properties": { "channel": { "$ref": "#/components/schemas/objs_conversation" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.setPurpose success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.setPurpose error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:manage", "channels:write.topic", "groups:write", "groups:write.topic", "im:write", "im:write.topic", "mpim:write", "mpim:write.topic" ] } ], "summary": "Sets the channel description", "tags": [ "conversations" ] } }, "/conversations.setTopic": { "post": { "description": "Sets the topic for a conversation.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.setTopic" }, "operationId": "conversations_setTopic", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Conversation to set the topic of", "type": "string" }, "topic": { "description": "The new topic string. Does not support formatting or linkification.", "type": "string" } }, "required": [ "channel", "topic" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.setTopic method", "properties": { "channel": { "$ref": "#/components/schemas/objs_conversation" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.setTopic success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.setTopic error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:manage", "channels:write.topic", "groups:write", "groups:write.topic", "im:write", "im:write.topic", "mpim:write", "mpim:write.topic" ] } ], "summary": "Sets the topic for a conversation", "tags": [ "conversations" ] } }, "/conversations.unarchive": { "post": { "description": "Reverses conversation archival.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/conversations.unarchive" }, "operationId": "conversations_unarchive", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "ID of conversation to unarchive", "type": "string" } }, "required": [ "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from conversations.unarchive method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "conversations.unarchive success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" }, "provided": { "type": "string" } }, "title": "conversations.unarchive error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:manage", "groups:write", "im:write", "mpim:write" ] } ], "summary": "Reverses conversation archival", "tags": [ "conversations" ] } }, "/dialog.open": { "post": { "description": "Open a dialog with a user", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/dialog.open" }, "operationId": "dialog_open", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "dialog": { "description": "The dialog definition. This must be a JSON-encoded string.", "type": "string" }, "trigger_id": { "description": "Exchange a trigger to post to the user.", "type": "string" } }, "required": [ "dialog", "trigger_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from dialog.open method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "dialog.open schema", "type": "object" } } }, "description": "Typical success response is quite minimal." }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "dialog.open error schema", "type": "object" } } }, "description": "Typical error response, before getting to any possible validation errors." } }, "security": [], "summary": "Open a dialog with a user", "tags": [ "dialog" ] } }, "/dnd.info": { "get": { "description": "Retrieves a user's current Do Not Disturb status.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/dnd.info" }, "operationId": "dnd_info", "parameters": [ { "description": "Encoded team id where passed in user param belongs, required if org token is used. If no user param is passed, then a team which has access to the app should be passed", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } }, { "description": "User to fetch status for (defaults to current user)", "in": "query", "name": "user", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from dnd.info method", "properties": { "dnd_enabled": { "type": "boolean" }, "next_dnd_end_ts": { "type": "integer" }, "next_dnd_start_ts": { "type": "integer" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "snooze_enabled": { "type": "boolean" }, "snooze_endtime": { "type": "integer" }, "snooze_remaining": { "type": "integer" } }, "required": [ "ok" ], "title": "dnd.info schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "dnd.info error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "dnd:read" ] } ], "summary": "Retrieves a user's current Do Not Disturb status", "tags": [ "dnd" ] } }, "/dnd.teamInfo": { "get": { "description": "Retrieves the Do Not Disturb status for up to 50 users on a team.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/dnd.teamInfo" }, "operationId": "dnd_teamInfo", "parameters": [ { "description": "Encoded team id where passed in users belong, required if org token is used", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } }, { "description": "Comma-separated list of users to fetch Do Not Disturb status for", "in": "query", "name": "users", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "dnd:read" ] } ], "summary": "Retrieves the Do Not Disturb status for up to 50 users on a team", "tags": [ "dnd" ] } }, "/emoji.list": { "get": { "description": "Lists custom emoji for a team.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/emoji.list" }, "operationId": "emoji_list", "parameters": [ { "description": "Include a list of categories for Unicode emoji and the emoji in each category", "in": "query", "name": "include_categories", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "emoji:read" ] } ], "summary": "Lists custom emoji for a team", "tags": [ "emoji" ] } }, "/files.comments.delete": { "post": { "description": "Deletes an existing comment on a file.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.comments.delete" }, "operationId": "files_comments_delete", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "file": { "description": "File to delete a comment from.", "type": "string" }, "id": { "description": "The comment to delete.", "type": "string" } }, "required": [ "file", "id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response files.comments.delete method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "files.comments.delete schema", "type": "object" } } }, "description": "Standard success response is very simple" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "files.comments.delete error schema", "type": "object" } } }, "description": "Standard failure response when used with an invalid token" } }, "security": [ { "slackAuth": [ "files:write" ] } ], "summary": "Deletes an existing comment on a file", "tags": [ "files.comments", "files" ] } }, "/files.delete": { "post": { "description": "Deletes a file.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.delete" }, "operationId": "files_delete", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "file": { "description": "ID of file to delete.", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response files.delete method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "files.delete schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "files.delete error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "files:write" ] } ], "summary": "Deletes a file", "tags": [ "files" ] } }, "/files.info": { "get": { "description": "Gets information about a file.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.info" }, "operationId": "files_info", "parameters": [ { "description": "_Default:_ `100`", "in": "query", "name": "count", "required": false, "schema": { "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 for more details.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Specify a file by providing its ID.", "in": "query", "name": "file", "required": true, "schema": { "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", "required": false, "schema": { "type": "integer" } }, { "description": "_Default:_ `1`", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from files.info method", "properties": { "comments": { "$ref": "#/components/schemas/objs_comments" }, "content_html": { "type": "null" }, "editor": { "$ref": "#/components/schemas/defs_user_id" }, "file": { "$ref": "#/components/schemas/objs_file" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "paging": { "$ref": "#/components/schemas/objs_paging" }, "response_metadata": { "$ref": "#/components/schemas/objs_response_metadata" } }, "required": [ "ok" ], "title": "files.info schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "files.info error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "files:read" ] } ], "summary": "Gets information about a file", "tags": [ "files" ] } }, "/files.list": { "get": { "description": "List for a team, in a channel, or from a user with applied filters.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.list" }, "operationId": "files_list", "parameters": [ { "description": "Filter files appearing in a specific channel, indicated by its ID.", "in": "query", "name": "channel", "required": false, "schema": { "type": "string" } }, { "description": "_Default:_ `100`", "in": "query", "name": "count", "required": false, "schema": { "type": "string" } }, { "description": "_Default:_ `1`", "in": "query", "name": "page", "required": false, "schema": { "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", "required": false, "schema": { "type": "boolean" } }, { "description": "encoded team id to list files in, required if org token is used", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } }, { "description": "Filter files created after this timestamp (inclusive).", "in": "query", "name": "ts_from", "required": false, "schema": { "type": "string" } }, { "description": "Filter files created before this timestamp (inclusive).", "in": "query", "name": "ts_to", "required": false, "schema": { "type": "string" } }, { "description": "Filter files by type (see below). 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", "required": false, "schema": { "type": "string" } }, { "description": "Filter files created by a single user.", "in": "query", "name": "user", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from files.list method", "properties": { "files": { "items": { "$ref": "#/components/schemas/objs_file" }, "type": "array" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "paging": { "$ref": "#/components/schemas/objs_paging" } }, "required": [ "ok" ], "title": "files.list schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "files.list error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "files:read" ] } ], "summary": "List for a team, in a channel, or from a user with applied filters", "tags": [ "files" ] } }, "/files.remote.add": { "post": { "description": "Adds a file from a remote service", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.remote.add" }, "operationId": "files_remote_add", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "external_id": { "description": "Creator defined GUID for the file.", "type": "string" }, "external_url": { "description": "URL of the remote file.", "type": "string" }, "filetype": { "description": "type of file", "type": "string" }, "indexable_file_contents": { "description": "A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.", "format": "binary", "type": "string" }, "preview_image": { "description": "Preview of the document via `multipart/form-data`.", "format": "binary", "type": "string" }, "title": { "description": "Title of the file being shared.", "type": "string" } }, "required": [ "external_id", "external_url", "title" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "remote_files:write" ] } ], "summary": "Adds a file from a remote service", "tags": [ "files.remote", "files" ] } }, "/files.remote.info": { "get": { "description": "Retrieve information about a remote file added to Slack", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.remote.info" }, "operationId": "files_remote_info", "parameters": [ { "description": "Creator defined GUID for the file.", "in": "query", "name": "external_id", "required": false, "schema": { "type": "string" } }, { "description": "Specify a file by providing its ID.", "in": "query", "name": "file", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "remote_files:read" ] } ], "summary": "Retrieve information about a remote file added to Slack", "tags": [ "files.remote", "files" ] } }, "/files.remote.list": { "get": { "description": "Retrieve information about a remote file added to Slack", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.remote.list" }, "operationId": "files_remote_list", "parameters": [ { "description": "Filter files appearing in a specific channel, indicated by its ID.", "in": "query", "name": "channel", "required": false, "schema": { "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 for more detail.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "The maximum number of items to return.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "Filter files created after this timestamp (inclusive).", "in": "query", "name": "ts_from", "required": false, "schema": { "type": "string" } }, { "description": "Filter files created before this timestamp (inclusive).", "in": "query", "name": "ts_to", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "remote_files:read" ] } ], "summary": "Retrieve information about a remote file added to Slack", "tags": [ "files.remote", "files" ] } }, "/files.remote.remove": { "post": { "description": "Remove a remote file.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.remote.remove" }, "operationId": "files_remote_remove", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "external_id": { "description": "Creator defined GUID for the file.", "type": "string" }, "file": { "description": "Specify a file by providing its ID.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "remote_files:write" ] } ], "summary": "Remove a remote file", "tags": [ "files.remote", "files" ] } }, "/files.remote.share": { "get": { "description": "Share a remote file into a channel.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.remote.share" }, "operationId": "files_remote_share", "parameters": [ { "description": "Comma-separated list of channel IDs where the file will be shared.", "in": "query", "name": "channels", "required": true, "schema": { "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", "required": false, "schema": { "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", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "remote_files:share" ] } ], "summary": "Share a remote file into a channel", "tags": [ "files.remote", "files" ] } }, "/files.remote.update": { "post": { "description": "Updates an existing remote file.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.remote.update" }, "operationId": "files_remote_update", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "external_id": { "description": "Creator defined GUID for the file.", "type": "string" }, "external_url": { "description": "URL of the remote file.", "type": "string" }, "file": { "description": "Specify a file by providing its ID.", "type": "string" }, "filetype": { "description": "type of file", "type": "string" }, "indexable_file_contents": { "description": "File containing contents that can be used to improve searchability for the remote file.", "format": "binary", "type": "string" }, "preview_image": { "description": "Preview of the document via `multipart/form-data`.", "format": "binary", "type": "string" }, "title": { "description": "Title of the file being shared.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "remote_files:write" ] } ], "summary": "Updates an existing remote file", "tags": [ "files.remote", "files" ] } }, "/files.revokePublicURL": { "post": { "description": "Revokes public/external sharing access for a file", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/files.revokePublicURL" }, "operationId": "files_revokePublicURL", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "file": { "description": "File to revoke", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from files.revokePublicURL method", "properties": { "file": { "$ref": "#/components/schemas/objs_file" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "files.revokePublicURL schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "files.revokePublicURL error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "files:write" ] } ], "summary": "Revokes public/external sharing access for a file", "tags": [ "files" ] } }, "/migration.exchange": { "get": { "description": "For Enterprise Grid workspaces, map local user IDs to global user IDs", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/migration.exchange" }, "operationId": "migration_exchange", "parameters": [ { "description": "Specify team_id starts with `T` in case of Org Token", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } }, { "description": "Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`.", "in": "query", "name": "to_old", "required": false, "schema": { "type": "boolean" } }, { "description": "A comma-separated list of user ids, up to 400 per request", "in": "query", "name": "users", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" }, "team_id": { "$ref": "#/components/schemas/defs_team" }, "user_id_map": { "additionalProperties": true, "title": "A mapping of provided user IDs with mapped user IDs", "type": "object" } }, "required": [ "ok" ], "title": "migration.exchange success schema", "type": "object" } } }, "description": "Typical success response when mappings exist for the specified user IDs" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "migration.exchange error schema", "type": "object" } } }, "description": "Typical error response when there are no mappings to provide" } }, "security": [ { "slackAuth": [ "tokens.basic" ] } ], "summary": "For Enterprise organization workspaces, map local user IDs to global user IDs", "tags": [ "migration" ] } }, "/pins.add": { "post": { "description": "Pins an item to a channel.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/pins.add" }, "operationId": "pins_add", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Channel to pin the messsage to. You must also include a `timestamp` when pinning messages.", "type": "string" }, "timestamp": { "description": "Timestamp of the message to pin. You must also include the `channel`.", "type": "string" } }, "required": [ "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from pins.add method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "pins.add schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "pins.add error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "pins:write" ] } ], "summary": "Pins an item to a channel", "tags": [ "pins" ] } }, "/pins.list": { "get": { "description": "Lists items pinned to a channel.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/pins.list" }, "operationId": "pins_list", "parameters": [ { "description": "Channel to get pinned items for.", "in": "query", "name": "channel", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "properties": { "items": { "items": { "anyOf": [ { "properties": { "created": { "type": "integer" }, "created_by": { "$ref": "#/components/schemas/defs_user_id" }, "file": { "$ref": "#/components/schemas/objs_file" }, "type": { "enum": [ "file" ], "type": "string" } }, "title": "File Pin", "type": "object" }, { "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" }, "created": { "type": "integer" }, "created_by": { "$ref": "#/components/schemas/defs_user_id" }, "message": { "$ref": "#/components/schemas/objs_message" }, "type": { "enum": [ "message" ], "type": "string" } }, "title": "Message Pin", "type": "object" } ] }, "type": "array" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "type": "object" }, { "properties": { "count": { "type": "integer" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "type": "object" } ], "description": "Schema for successful response from pins.list method", "title": "pins.list success schema" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "pins.list error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "pins:read" ] } ], "summary": "Lists items pinned to a channel", "tags": [ "pins" ] } }, "/pins.remove": { "post": { "description": "Un-pins an item from a channel.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/pins.remove" }, "operationId": "pins_remove", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Channel where the item is pinned to.", "type": "string" }, "timestamp": { "description": "Timestamp of the message to un-pin.", "type": "string" } }, "required": [ "channel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from pins.remove method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "pins.remove schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "pins.remove error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "pins:write" ] } ], "summary": "Un-pins an item from a channel", "tags": [ "pins" ] } }, "/reactions.add": { "post": { "description": "Adds a reaction to an item.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/reactions.add" }, "operationId": "reactions_add", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Channel where the message to add reaction to was posted.", "type": "string" }, "name": { "description": "Reaction (emoji) name", "type": "string" }, "timestamp": { "description": "Timestamp of the message to add reaction to.", "type": "string" } }, "required": [ "channel", "name", "timestamp" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from reactions.add method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "reactions.add schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "reactions.add error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "reactions:write" ] } ], "summary": "Adds a reaction to an item", "tags": [ "reactions" ] } }, "/reactions.get": { "get": { "description": "Gets reactions for an item.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/reactions.get" }, "operationId": "reactions_get", "parameters": [ { "description": "Channel where the message to get reactions for was posted.", "in": "query", "name": "channel", "required": false, "schema": { "type": "string" } }, { "description": "File to get reactions for.", "in": "query", "name": "file", "required": false, "schema": { "type": "string" } }, { "description": "File comment to get reactions for.", "in": "query", "name": "file_comment", "required": false, "schema": { "type": "string" } }, { "description": "If true always return the complete reaction list.", "in": "query", "name": "full", "required": false, "schema": { "type": "boolean" } }, { "description": "Timestamp of the message to get reactions for.", "in": "query", "name": "timestamp", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" }, "message": { "$ref": "#/components/schemas/objs_message" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "type": { "enum": [ "message" ], "type": "string" } } }, { "properties": { "file": { "$ref": "#/components/schemas/objs_file" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "type": { "enum": [ "file" ], "type": "string" } } }, { "properties": { "comment": { "$ref": "#/components/schemas/objs_comment" }, "file": { "$ref": "#/components/schemas/objs_file" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "type": { "enum": [ "file_comment" ], "type": "string" } } } ], "description": "Schema for successful response from reactions.get method", "title": "reactions.get success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "reactions.get error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "reactions:read" ] } ], "summary": "Gets reactions for an item", "tags": [ "reactions" ] } }, "/reactions.list": { "get": { "description": "Lists reactions made by a user.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/reactions.list" }, "operationId": "reactions_list", "parameters": [ { "description": "_Default:_ `100`", "in": "query", "name": "count", "required": false, "schema": { "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 for more details.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "If true always return the complete reaction list.", "in": "query", "name": "full", "required": false, "schema": { "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.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "_Default:_ `1`", "in": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "description": "encoded team id to list reactions in, required if org token is used", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } }, { "description": "Show reactions made by this user. Defaults to the authed user.", "in": "query", "name": "user", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from reactions.list method", "properties": { "items": { "items": { "anyOf": [ { "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" }, "message": { "$ref": "#/components/schemas/objs_message" }, "type": { "enum": [ "message" ], "type": "string" } }, "type": "object" }, { "properties": { "file": { "$ref": "#/components/schemas/objs_file" }, "type": { "enum": [ "file" ], "type": "string" } }, "type": "object" }, { "properties": { "comment": { "$ref": "#/components/schemas/objs_comment" }, "file": { "$ref": "#/components/schemas/objs_file" }, "type": { "enum": [ "file_comment" ], "type": "string" } }, "type": "object" } ] }, "type": "array" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "paging": { "$ref": "#/components/schemas/objs_paging" }, "response_metadata": { "$ref": "#/components/schemas/objs_response_metadata" } }, "required": [ "ok" ], "title": "reactions.list schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "reactions.list error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "reactions:read" ] } ], "summary": "Lists reactions made by a user", "tags": [ "reactions" ] } }, "/reactions.remove": { "post": { "description": "Removes a reaction from an item.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/reactions.remove" }, "operationId": "reactions_remove", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "channel": { "description": "Channel where the message to remove reaction from was posted.", "type": "string" }, "file": { "description": "File to remove reaction from.", "type": "string" }, "file_comment": { "description": "File comment to remove reaction from.", "type": "string" }, "name": { "description": "Reaction (emoji) name.", "type": "string" }, "timestamp": { "description": "Timestamp of the message to remove reaction from.", "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from reactions.remove method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "reactions.remove schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "reactions.remove error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "reactions:write" ] } ], "summary": "Removes a reaction from an item", "tags": [ "reactions" ] } }, "/team.info": { "get": { "description": "Gets information about the current team.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/team.info" }, "operationId": "team_info", "parameters": [ { "description": "Query by domain instead of team (only when team is null). This only works for domains in the same enterprise as the querying team token. This also expects the domain to belong to a team and not the enterprise itself. This is the value set up for the 'Joining This Workspace' workspace setting. If it contains more than one domain, the field will contain multiple comma-separated domain values. If no domain is set, the field is empty.", "in": "query", "name": "domain", "required": false, "schema": { "type": "string" } }, { "description": "Team to get info about; if omitted, will return information about the current team.", "in": "query", "name": "team", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from team.info method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "team": { "$ref": "#/components/schemas/objs_team" } }, "required": [ "ok" ], "title": "team.info schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "team.info error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "team:read" ] } ], "summary": "Gets information about the current team", "tags": [ "team" ] } }, "/team.profile.get": { "get": { "description": "Retrieve a team's profile.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/team.profile.get" }, "operationId": "team_profile_get", "parameters": [ { "description": "Filter by visibility.", "in": "query", "name": "visibility", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from team.profile.get method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "profile": { "properties": { "fields": { "items": { "$ref": "#/components/schemas/objs_team_profile_field" }, "type": "array" } }, "type": "object" } }, "required": [ "ok" ], "title": "team.profile.get success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "team.profile.get error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "users.profile:read" ] } ], "summary": "Retrieve a team's profile", "tags": [ "team.profile", "team" ] } }, "/usergroups.create": { "post": { "description": "Create a User Group", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/usergroups.create" }, "operationId": "usergroups_create", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "additional_channels": { "description": "A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.", "type": "string" }, "channels": { "description": "A comma separated string of encoded channel IDs for which the User Group uses as a default.", "type": "string" }, "description": { "description": "A short description of the User Group.", "type": "string" }, "enable_section": { "description": "Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.", "type": "boolean" }, "handle": { "description": "A mention handle. Must be unique among channels, users and User Groups.", "type": "string" }, "include_count": { "description": "Include the number of users in each User Group.", "type": "boolean" }, "name": { "description": "A name for the User Group. Must be unique among User Groups.", "type": "string" }, "team_id": { "description": "Encoded team id where the user group has to be created, required if org token is used.", "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from usergroups.create method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "usergroup": { "$ref": "#/components/schemas/objs_subteam" } }, "required": [ "ok" ], "title": "usergroups.create schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "usergroups.create error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "usergroups:write" ] } ], "summary": "Create a User Group", "tags": [ "usergroups" ] } }, "/usergroups.disable": { "post": { "description": "Disable an existing User Group", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/usergroups.disable" }, "operationId": "usergroups_disable", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "include_count": { "description": "Include the number of users in the User Group.", "type": "boolean" }, "team_id": { "description": "Encoded target team id where the user group is, required if org token is used.", "type": "string" }, "usergroup": { "description": "The encoded ID of the User Group to disable.", "type": "string" } }, "required": [ "usergroup" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from usergroups.disable method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "usergroup": { "$ref": "#/components/schemas/objs_subteam" } }, "required": [ "ok" ], "title": "usergroups.disable schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "usergroups.disable error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "usergroups:write" ] } ], "summary": "Disable an existing User Group", "tags": [ "usergroups" ] } }, "/usergroups.enable": { "post": { "description": "Enable a User Group", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/usergroups.enable" }, "operationId": "usergroups_enable", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "include_count": { "description": "Include the number of users in the User Group.", "type": "boolean" }, "team_id": { "description": "Encoded team id where the user group is, required if org token is used.", "type": "string" }, "usergroup": { "description": "The encoded ID of the User Group to enable.", "type": "string" } }, "required": [ "usergroup" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from usergroups.enable method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "usergroup": { "$ref": "#/components/schemas/objs_subteam" } }, "required": [ "ok" ], "title": "usergroups.enable schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "usergroups.enable error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "usergroups:write" ] } ], "summary": "Enable a User Group", "tags": [ "usergroups" ] } }, "/usergroups.list": { "get": { "description": "List all User Groups for a team", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/usergroups.list" }, "operationId": "usergroups_list", "parameters": [ { "description": "Include the number of users in each User Group.", "in": "query", "name": "include_count", "required": false, "schema": { "type": "boolean" } }, { "description": "Include results for disabled User Groups.", "in": "query", "name": "include_disabled", "required": false, "schema": { "type": "boolean" } }, { "description": "Include the list of users for each User Group.", "in": "query", "name": "include_users", "required": false, "schema": { "type": "boolean" } }, { "description": "The user group's encoded team ID. Required if org token is used.", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from usergroups.list method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "usergroups": { "items": { "$ref": "#/components/schemas/objs_subteam" }, "type": "array" } }, "required": [ "ok" ], "title": "usergroups.list schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "usergroups.list error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "usergroups:read" ] } ], "summary": "List all User Groups for a team", "tags": [ "usergroups" ] } }, "/usergroups.update": { "post": { "description": "Update an existing User Group", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/usergroups.update" }, "operationId": "usergroups_update", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "additional_channels": { "description": "A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.", "type": "string" }, "channels": { "description": "A comma separated string of encoded channel IDs for which the User Group uses as a default.", "type": "string" }, "description": { "description": "A short description of the User Group.", "type": "string" }, "enable_section": { "description": "Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.", "type": "boolean" }, "handle": { "description": "A mention handle. Must be unique among channels, users and User Groups.", "type": "string" }, "include_count": { "description": "Include the number of users in the User Group.", "type": "boolean" }, "name": { "description": "A name for the User Group. Must be unique among User Groups.", "type": "string" }, "team_id": { "description": "encoded team id where the user group exists, required if org token is used", "type": "string" }, "usergroup": { "description": "The encoded ID of the User Group to update.", "type": "string" } }, "required": [ "usergroup" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from usergroups.update method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "usergroup": { "$ref": "#/components/schemas/objs_subteam" } }, "required": [ "ok" ], "title": "usergroups.update schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "usergroups.update error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "usergroups:write" ] } ], "summary": "Update an existing User Group", "tags": [ "usergroups" ] } }, "/usergroups.users.list": { "get": { "description": "List all users in a User Group", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/usergroups.users.list" }, "operationId": "usergroups_users_list", "parameters": [ { "description": "Include results for disabled User Groups.", "in": "query", "name": "include_disabled", "required": false, "schema": { "type": "boolean" } }, { "description": "The user group's encoded team ID. Required if org token is used.", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } }, { "description": "The encoded ID of the User Group.", "in": "query", "name": "usergroup", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from usergroups.users.list method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "users": { "items": { "$ref": "#/components/schemas/defs_user_id" }, "type": "array" } }, "required": [ "ok" ], "title": "usergroups.users.list schema", "type": "object" } } }, "description": "Standard success response when used with a user token" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "usergroups.users.list error schema", "type": "object" } } }, "description": "Standard failure response when used with an invalid token" } }, "security": [ { "slackAuth": [ "usergroups:read" ] } ], "summary": "List all users in a User Group", "tags": [ "usergroups.users", "usergroups" ] } }, "/usergroups.users.update": { "post": { "description": "Update the list of users for a User Group", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/usergroups.users.update" }, "operationId": "usergroups_users_update", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "additional_channels": { "description": "A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.", "type": "string" }, "include_count": { "description": "Include the number of users in the user group.", "type": "boolean" }, "is_shared": { "description": "Boolean to identify if the API is getting called when a shared section is getting shared", "type": "boolean" }, "team_id": { "description": "encoded team id where the user group exists, required if org token is used", "type": "string" }, "usergroup": { "description": "The encoded ID of the user group to update.", "type": "string" }, "users": { "description": "A comma separated string of encoded user IDs that represent the entire list of users for the user group.", "type": "string" } }, "required": [ "usergroup", "users" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from usergroups.users.update method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "usergroup": { "$ref": "#/components/schemas/objs_subteam" } }, "required": [ "ok" ], "title": "usergroups.users.update schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "usergroups.users.update error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "usergroups:write" ] } ], "summary": "Update the list of users for a user group", "tags": [ "usergroups.users", "usergroups" ] } }, "/users.conversations": { "get": { "description": "List conversations the calling user may access.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/users.conversations" }, "operationId": "users_conversations", "parameters": [ { "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Set to `true` to exclude archived channels from the list", "in": "query", "name": "exclude_archived", "required": false, "schema": { "type": "boolean" } }, { "description": "Set to `true` to exclude muted channels from the list", "in": "query", "name": "exclude_muted", "required": false, "schema": { "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 with a max value of 999.", "in": "query", "name": "limit", "required": false, "schema": { "type": "number" } }, { "description": "encoded team id to list conversations in, required if org token is used", "in": "query", "name": "team_id", "required": false, "schema": { "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", "required": false, "schema": { "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", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/objs_conversation" }, "type": "array" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "response_metadata": { "properties": { "next_cursor": { "type": "string" } }, "type": "object" } }, "required": [ "ok" ], "title": "users.conversations success schema", "type": "object" } } }, "description": "Typical success response with only public channels. Note how `num_members` and `is_member` are not returned like typical `conversations` objects." }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "users.conversations error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "channels:read", "groups:read", "im:read", "mpim:read" ] } ], "summary": "List conversations the calling user is a member of", "tags": [ "users" ] } }, "/users.getPresence": { "get": { "description": "Gets user presence information.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/users.getPresence" }, "operationId": "users_getPresence", "parameters": [ { "description": "User to get presence info on. Defaults to the authed user.", "in": "query", "name": "user", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" }, "online": { "type": "boolean" }, "presence": { "type": "string" } }, "required": [ "ok" ], "title": "API method: users.getPresence", "type": "object" } } }, "description": "When requesting information for a different user, this method just returns the current presence (either `active` or `away`)." }, "default": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "object" }, "description": "Schema for error response users.getPresence method", "properties": { "error": { "type": "string" }, "ok": { "$ref": "#/components/schemas/defs_ok_false" } }, "title": "users.counts error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "users:read" ] } ], "summary": "Gets user presence information", "tags": [ "users" ] } }, "/users.info": { "get": { "description": "Gets information about a user.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/users.info" }, "operationId": "users_info", "parameters": [ { "description": "Set this to `true` to receive the locale for this user. Defaults to `false`", "in": "query", "name": "include_locale", "required": false, "schema": { "type": "boolean" } }, { "description": "User to get info on", "in": "query", "name": "user", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "Schema for successful response from users.info method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "user": { "$ref": "#/components/schemas/objs_user" } }, "required": [ "ok" ], "title": "users.info success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "users.info error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "users:read" ] } ], "summary": "Gets information about a user", "tags": [ "users" ] } }, "/users.list": { "get": { "description": "Lists all users in a Slack team.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/users.list" }, "operationId": "users_list", "parameters": [ { "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "description": "Set this to `true` to receive the locale for users. Defaults to `false`", "in": "query", "name": "include_locale", "required": false, "schema": { "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. 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", "required": false, "schema": { "type": "number" } }, { "description": "encoded team id to list users in, required if org token is used", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from users.list method", "properties": { "cache_ts": { "type": "integer" }, "members": { "items": { "$ref": "#/components/schemas/objs_user" }, "type": "array" }, "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "response_metadata": { "$ref": "#/components/schemas/objs_response_metadata" } }, "required": [ "ok" ], "title": "users.list schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "users.list error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "users:read" ] } ], "summary": "Lists all users in a Slack team", "tags": [ "users" ] } }, "/users.lookupByEmail": { "get": { "description": "Find a user with an email address.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/users.lookupByEmail" }, "operationId": "users_lookupByEmail", "parameters": [ { "description": "An email address belonging to a user in the workspace", "in": "query", "name": "email", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "Schema for successful response from users.lookupByEmail method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "user": { "$ref": "#/components/schemas/objs_user" } }, "required": [ "ok" ], "title": "users.lookupByEmail success schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "users.lookupByEmail error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "users:read.email" ] } ], "summary": "Find a user with an email address", "tags": [ "users" ] } }, "/users.profile.get": { "get": { "description": "Retrieves a user's profile information.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/users.profile.get" }, "operationId": "users_profile_get", "parameters": [ { "description": "Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.", "in": "query", "name": "include_labels", "required": false, "schema": { "type": "boolean" } }, { "description": "User to retrieve profile info for", "in": "query", "name": "user", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from users.profile.get method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" }, "profile": { "$ref": "#/components/schemas/objs_user_profile" } }, "required": [ "ok" ], "title": "users.profile.get schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "users.profile.get error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "users.profile:read" ] } ], "summary": "Retrieve a user's profile information, including their custom status", "tags": [ "users.profile", "users" ] } }, "/users.setPresence": { "post": { "description": "Manually sets user presence.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/users.setPresence" }, "operationId": "users_setPresence", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "presence": { "description": "Either `auto` or `away`", "type": "string" } }, "required": [ "presence" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Schema for successful response from users.setPresence method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "users.setPresence schema", "type": "object" } } }, "description": "Typical success response" }, "default": { "content": { "application/json": { "schema": { "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": "#/components/schemas/defs_ok_false" } }, "title": "users.setPresence error schema", "type": "object" } } }, "description": "Typical error response" } }, "security": [ { "slackAuth": [ "users:write" ] } ], "summary": "Manually sets user presence", "tags": [ "users" ] } }, "/views.open": { "post": { "description": "Open a view for a user.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/views.open" }, "operationId": "views_open", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "interactivity_pointer": { "description": "Exchange an interactivity pointer to post to the user.", "type": "string" }, "trigger_id": { "description": "Exchange a trigger to post to the user.", "type": "string" }, "view": { "description": "A view payload. This must be a JSON-encoded string.", "type": "string" } }, "required": [ "view" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response includes the opened view payload." }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response, before getting to any possible validation errors." } }, "security": [], "summary": "Open a view for a user", "tags": [ "views" ] } }, "/views.publish": { "post": { "description": "Publish a static view for a User.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/views.publish" }, "operationId": "views_publish", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "hash": { "description": "A string that represents view state to protect against possible race conditions.", "type": "string" }, "user_id": { "description": "`id` of the user you want publish a view to.", "type": "string" }, "view": { "description": "A view payload. This must be a JSON-encoded string.", "type": "string" } }, "required": [ "user_id", "view" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response includes the published view payload." }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response, before getting to any possible validation errors." } }, "security": [], "summary": "Publish a static view for a User", "tags": [ "views" ] } }, "/views.push": { "post": { "description": "Push a view onto the stack of a root view.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/views.push" }, "operationId": "views_push", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "interactivity_pointer": { "description": "Exchange an interactivity pointer to post to the user.", "type": "string" }, "trigger_id": { "description": "Exchange a trigger to post to the user.", "type": "string" }, "view": { "description": "A view payload. This must be a JSON-encoded string.", "type": "string" } }, "required": [ "view" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response includes the pushed view payload." }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response." } }, "security": [], "summary": "Push a view onto the stack of a root view", "tags": [ "views" ] } }, "/views.update": { "post": { "description": "Update an existing view.", "externalDocs": { "description": "API method documentation", "url": "https://docs.slack.dev/reference/methods/views.update" }, "operationId": "views_update", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "external_id": { "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.", "type": "string" }, "hash": { "description": "A string that represents view state to protect against possible race conditions.", "type": "string" }, "view": { "description": "A view object. This must be a JSON-encoded string.", "type": "string" }, "view_id": { "description": "A unique identifier of the view to be updated. Either `view_id` or `external_id` is required.", "type": "string" } }, "required": [ "view" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_true" } }, "required": [ "ok" ], "title": "Default success template", "type": "object" } } }, "description": "Typical success response includes the updated view payload." }, "default": { "content": { "application/json": { "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": "#/components/schemas/defs_ok_false" } }, "title": "Default error template", "type": "object" } } }, "description": "Typical error response." } }, "security": [], "summary": "Update an existing view", "tags": [ "views" ] } } }, "servers": [ { "url": "https://slack.com/api" } ], "tags": [] }