openapi: 3.1.0 info: version: '1.0' title: Slack Admin Access Post API description: "The Slack Admin API is a set of privileged endpoints\x14primarily under admin.* with related SCIM and Audit Logs APIs\x14that lets Enterprise Grid owners and admins automate organization\x11 wide management and governance. It covers user lifecycle (provision, suspend, assign roles), workspace and channel administration across workspaces (create, move, archive channels; manage membership and settings), app governance (approve/deny or allowlist/ban apps and install them to workspaces), invite request handling, and security/compliance controls such as information barriers, session and authentication policies, and org\x11level analytics exports. These APIs require elevated admin scopes and are commonly used to power automated onboarding/offboarding, centralized channel and app controls, and integrations with identity, ITSM, and compliance systems." tags: - name: Post paths: /admin.apps.approve: post: tags: - Post description: Approve an app for installation on a workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.apps.approve operationId: postAdminAppsApprove parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.apps:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: app_id: type: string description: The id of the app to approve. request_id: type: string description: The id of the request to approve. team_id: type: string application/json: schema: type: object properties: app_id: type: string description: The id of the app to approve. request_id: type: string description: The id of the request to approve. team_id: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.apps:write summary: Slack Post Admin Apps Approve x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.apps.restrict: post: tags: - Post description: Restrict an app for installation on a workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.apps.restrict operationId: postAdminAppsRestrict parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.apps:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: app_id: type: string description: The id of the app to restrict. request_id: type: string description: The id of the request to restrict. team_id: type: string application/json: schema: type: object properties: app_id: type: string description: The id of the app to restrict. request_id: type: string description: The id of the request to restrict. team_id: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.apps:write summary: Slack Post Admin Apps Restrict x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.archive: post: tags: - Post description: Archive a public or private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.archive operationId: postAdminConversationsArchive parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id type: object properties: channel_id: type: string description: The channel to archive. application/json: schema: required: - channel_id type: object properties: channel_id: type: string description: The channel to archive. required: true responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.archive schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response of admin.conversations.archive example: ok: true default: description: Typical error response content: application/json: schema: title: admin.conversations.archive error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - channel_not_found - channel_type_not_supported - default_org_wide_channel - already_archived - cant_archive_general - restricted_action - could_not_archive_channel ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.archive example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Archive x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.convertToPrivate: post: tags: - Post description: Convert a public channel to a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.convertToPrivate operationId: postAdminConversationsConverttoprivate parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id type: object properties: channel_id: type: string description: The channel to convert to private. application/json: schema: required: - channel_id type: object properties: channel_id: type: string description: The channel to convert to private. required: true responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.convertToPrivate schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response of admin.conversations.convertToPrivate example: ok: true default: description: Typical error response content: application/json: schema: title: admin.conversations.convertToPrivate error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - restricted_action - name_taken - channel_not_found - channel_type_not_supported - default_org_wide_channel - method_not_supported_for_channel_type - could_not_convert_channel - external_channel_migrating ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.convertToPrivate example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Converttoprivate x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.create: post: tags: - Post description: Create a public or private channel-based conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.create operationId: postAdminConversationsCreate parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - is_private - name type: object properties: name: type: string description: Name of the public or private channel to create. description: type: string description: Description of the public or private channel to create. is_private: type: boolean description: When `true`, creates a private channel instead of a public channel org_wide: type: boolean description: 'When `true`, the channel will be available org-wide. Note: if the channel is not `org_wide=true`, you must specify a `team_id` for this channel' team_id: type: string description: 'The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`.' application/json: schema: required: - is_private - name type: object properties: name: type: string description: Name of the public or private channel to create. description: type: string description: Description of the public or private channel to create. is_private: type: boolean description: When `true`, creates a private channel instead of a public channel org_wide: type: boolean description: 'When `true`, the channel will be available org-wide. Note: if the channel is not `org_wide=true`, you must specify a `team_id` for this channel' team_id: type: string description: 'The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`.' required: true responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.create schema required: - ok type: object properties: channel_id: $ref: '#/components/schemas/defs_channel_id' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response of admin.conversations.create example: channel_id: C12345 ok: true default: description: Typical error response content: application/json: schema: title: admin.conversations.create error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - name_taken - restricted_action - team_not_found - invalid_team - invalid_name - could_not_create_channel - team_id_or_org_required ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.create example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Create x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.delete: post: tags: - Post description: Delete a public or private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.delete operationId: postAdminConversationsDelete parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id type: object properties: channel_id: type: string description: The channel to delete. application/json: schema: required: - channel_id type: object properties: channel_id: type: string description: The channel to delete. required: true responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.delete schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response of admin.conversations.delete example: ok: true default: description: Typical error response content: application/json: schema: title: admin.conversations.delete error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - not_an_admin - channel_not_found - channel_type_not_supported - default_org_wide_channel - restricted_action - could_not_delete_channel - missing_scope ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.delete example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Delete x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.disconnectShared: post: tags: - Post description: Disconnect a connected channel from one or more workspaces. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.disconnectShared operationId: postAdminConversationsDisconnectshared parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id type: object properties: channel_id: type: string description: The channel to be disconnected from some workspaces. leaving_team_ids: type: string description: The team to be removed from the channel. Currently only a single team id can be specified. application/json: schema: required: - channel_id type: object properties: channel_id: type: string description: The channel to be disconnected from some workspaces. leaving_team_ids: type: string description: The team to be removed from the channel. Currently only a single team id can be specified. required: true responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.rename schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response of admin.conversations.disconnectShared example: ok: true default: description: Typical error response content: application/json: schema: title: admin.conversations.disconnectShared error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - not_an_admin - not_an_enterprise - channel_not_found - not_supported - team_not_found - restricted_action - missing_scope - leaving_team_not_in_channel - no_teams_to_disconnect - leaving_team_required - cannot_kick_team - cannot_kick_home_team ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.disconnectShared example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Disconnectshared x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.invite: post: tags: - Post description: Invite a user to a public or private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.invite operationId: postAdminConversationsInvite parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id - user_ids type: object properties: user_ids: type: string description: The users to invite. channel_id: type: string description: The channel that the users will be invited to. application/json: schema: required: - channel_id - user_ids type: object properties: user_ids: type: string description: The users to invite. channel_id: type: string description: The channel that the users will be invited to. required: true responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.invite schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response of admin.conversations.invite example: ok: true default: description: Typical error response content: application/json: schema: title: admin.conversations.invite error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - channel_not_found - channel_type_not_supported - default_org_wide_channel - restricted_action - user_must_be_admin - failed_for_some_users ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: Schema for error response from admin.conversations.invite example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Invite x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.rename: post: tags: - Post description: Rename a public or private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.rename operationId: postAdminConversationsRename parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id - name type: object properties: channel_id: type: string description: The channel to rename. name: type: string application/json: schema: required: - channel_id - name type: object properties: channel_id: type: string description: The channel to rename. name: type: string required: true responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.rename schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response of admin.conversations.rename example: ok: true default: description: Typical error response content: application/json: schema: title: admin.conversations.unarchive error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - channel_not_found - channel_type_not_supported - restricted_action - could_not_rename_channel - default_org_wide_channel - name_taken ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.rename example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Rename x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.restrictAccess.addGroup: post: tags: - Post description: Add an allowlist of IDP groups for accessing a channel externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup operationId: postAdminConversationsRestrictaccessAddgroup requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id - group_id - token type: object properties: token: type: string description: 'Authentication token. Requires scope: `admin.conversations:write`' team_id: type: string description: The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization. group_id: type: string description: The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to be an allowlist for the private channel. channel_id: type: string description: The channel to link this group to. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Restrictaccess Addgroup x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.restrictAccess.removeGroup: post: tags: - Post description: Remove a linked IDP group linked from a private channel externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup operationId: postAdminConversationsRestrictaccessRemovegroup requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id - group_id - team_id - token type: object properties: token: type: string description: 'Authentication token. Requires scope: `admin.conversations:write`' team_id: type: string description: The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization. group_id: type: string description: The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to remove from the private channel. channel_id: type: string description: The channel to remove the linked group from. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Restrictaccess Removegroup x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.setConversationPrefs: post: tags: - Post description: Set the posting permissions for a public or private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.setConversationPrefs operationId: postAdminConversationsSetconversationprefs parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id - prefs type: object properties: channel_id: type: string description: The channel to set the prefs for prefs: type: string description: The prefs for this channel in a stringified JSON format. application/json: schema: required: - channel_id - prefs type: object properties: channel_id: type: string description: The channel to set the prefs for prefs: type: string description: The prefs for this channel in a stringified JSON format. required: true responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.setConversationPrefs schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response of admin.conversations.setConversationPrefs example: ok: true default: description: Typical error response content: application/json: schema: title: admin.conversations.setConversationPrefs error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - not_an_admin - channel_not_found - channel_type_not_supported - restricted_action - missing_scope - could_not_set_channel_pref - default_org_wide_channel ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.setConversationPrefs example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Setconversationprefs x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.setTeams: post: tags: - Post description: Set the workspaces in an Enterprise grid org that connect to a public or private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.setTeams operationId: postAdminConversationsSetteams parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id type: object properties: channel_id: type: string description: The encoded `channel_id` to add or remove to workspaces. team_id: type: string description: The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel. target_team_ids: type: string description: A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide. org_channel: type: boolean description: True if channel has to be converted to an org channel application/json: schema: required: - channel_id type: object properties: channel_id: type: string description: The encoded `channel_id` to add or remove to workspaces. team_id: type: string description: The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel. target_team_ids: type: string description: A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide. org_channel: type: boolean description: True if channel has to be converted to an org channel required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Setteams x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.unarchive: post: tags: - Post description: Unarchive a public or private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.unarchive operationId: postAdminConversationsUnarchive parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_id type: object properties: channel_id: type: string description: The channel to unarchive. application/json: schema: required: - channel_id type: object properties: channel_id: type: string description: The channel to unarchive. required: true responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.unarchive schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response of admin.conversations.unarchive example: ok: true default: description: Typical error response content: application/json: schema: title: admin.conversations.unarchive error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - channel_not_found - channel_not_archived - channel_type_not_supported - restricted_action - could_not_unarchive_channel - default_org_wide_channel - missing_scope ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.unarchive example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:write summary: Slack Post Admin Conversations Unarchive x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.emoji.add: post: tags: - Post description: Add an emoji. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.emoji.add operationId: postAdminEmojiAdd requestBody: content: application/x-www-form-urlencoded: schema: required: - name - token - url type: object properties: token: type: string description: 'Authentication token. Requires scope: `admin.teams:write`' name: type: string description: The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included. url: type: string description: The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Emoji Add x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.emoji.addAlias: post: tags: - Post description: Add an emoji alias. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.emoji.addAlias operationId: postAdminEmojiAddalias requestBody: content: application/x-www-form-urlencoded: schema: required: - alias_for - name - token type: object properties: token: type: string description: 'Authentication token. Requires scope: `admin.teams:write`' name: type: string description: The name of the emoji to be aliased. Colons (`:myemoji:`) around the value are not required, although they may be included. alias_for: type: string description: The alias of the emoji. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Emoji Addalias x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.emoji.remove: post: tags: - Post description: Remove an emoji across an Enterprise Grid organization externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.emoji.remove operationId: postAdminEmojiRemove requestBody: content: application/x-www-form-urlencoded: schema: required: - name - token type: object properties: token: type: string description: 'Authentication token. Requires scope: `admin.teams:write`' name: type: string description: The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Emoji Remove x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.emoji.rename: post: tags: - Post description: Rename an emoji. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.emoji.rename operationId: postAdminEmojiRename requestBody: content: application/x-www-form-urlencoded: schema: required: - name - new_name - token type: object properties: token: type: string description: 'Authentication token. Requires scope: `admin.teams:write`' name: type: string description: The name of the emoji to be renamed. Colons (`:myemoji:`) around the value are not required, although they may be included. new_name: type: string description: The new name of the emoji. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Emoji Rename x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.inviteRequests.approve: post: tags: - Post description: Approve a workspace invite request. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.inviteRequests.approve operationId: postAdminInviterequestsApprove parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.invites:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - invite_request_id type: object properties: team_id: type: string description: ID for the workspace where the invite request was made. invite_request_id: type: string description: ID of the request to invite. application/json: schema: required: - invite_request_id type: object properties: team_id: type: string description: ID for the workspace where the invite request was made. invite_request_id: type: string description: ID of the request to invite. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.invites:write summary: Slack Post Admin Inviterequests Approve x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.inviteRequests.deny: post: tags: - Post description: Deny a workspace invite request. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.inviteRequests.deny operationId: postAdminInviterequestsDeny parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.invites:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - invite_request_id type: object properties: team_id: type: string description: ID for the workspace where the invite request was made. invite_request_id: type: string description: ID of the request to invite. application/json: schema: required: - invite_request_id type: object properties: team_id: type: string description: ID for the workspace where the invite request was made. invite_request_id: type: string description: ID of the request to invite. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.invites:write summary: Slack Post Admin Inviterequests Deny x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.teams.create: post: tags: - Post description: Create an Enterprise team. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.teams.create operationId: postAdminTeamsCreate parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.teams:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - team_domain - team_name type: object properties: team_domain: type: string description: Team domain (for example, slacksoftballteam). team_name: type: string description: Team name (for example, Slack Softball Team). team_description: type: string description: Description for the team. team_discoverability: type: string description: Who can join the team. A team's discoverability can be `open`, `closed`, `invite_only`, or `unlisted`. application/json: schema: required: - team_domain - team_name type: object properties: team_domain: type: string description: Team domain (for example, slacksoftballteam). team_name: type: string description: Team name (for example, Slack Softball Team). team_description: type: string description: Description for the team. team_discoverability: type: string description: Who can join the team. A team's discoverability can be `open`, `closed`, `invite_only`, or `unlisted`. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true team: T12345 default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Teams Create x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.teams.settings.setDefaultChannels: post: tags: - Post description: Set the default channels of a workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.teams.settings.setDefaultChannels operationId: postAdminTeamsSettingsSetdefaultchannels requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_ids - team_id - token type: object properties: token: type: string description: 'Authentication token. Requires scope: `admin.teams:write`' team_id: type: string description: ID for the workspace to set the default channel for. channel_ids: type: string description: An array of channel IDs. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Teams Settings Setdefaultchannels x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.teams.settings.setDescription: post: tags: - Post description: Set the description of a given workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.teams.settings.setDescription operationId: postAdminTeamsSettingsSetdescription parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.teams:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - description - team_id type: object properties: team_id: type: string description: ID for the workspace to set the description for. description: type: string description: The new description for the workspace. application/json: schema: required: - description - team_id type: object properties: team_id: type: string description: ID for the workspace to set the description for. description: type: string description: The new description for the workspace. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Teams Settings Setdescription x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.teams.settings.setDiscoverability: post: tags: - Post description: An API method that allows admins to set the discoverability of a given workspace externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.teams.settings.setDiscoverability operationId: postAdminTeamsSettingsSetdiscoverability parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.teams:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - discoverability - team_id type: object properties: team_id: type: string description: The ID of the workspace to set discoverability on. discoverability: type: string description: This workspace's discovery setting. It must be set to one of `open`, `invite_only`, `closed`, or `unlisted`. application/json: schema: required: - discoverability - team_id type: object properties: team_id: type: string description: The ID of the workspace to set discoverability on. discoverability: type: string description: This workspace's discovery setting. It must be set to one of `open`, `invite_only`, `closed`, or `unlisted`. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Teams Settings Setdiscoverability x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.teams.settings.setIcon: post: tags: - Post description: Sets the icon of a workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.teams.settings.setIcon operationId: postAdminTeamsSettingsSeticon requestBody: content: application/x-www-form-urlencoded: schema: required: - image_url - team_id - token type: object properties: token: type: string description: 'Authentication token. Requires scope: `admin.teams:write`' image_url: type: string description: Image URL for the icon team_id: type: string description: ID for the workspace to set the icon for. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Teams Settings Seticon x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.teams.settings.setName: post: tags: - Post description: Set the name of a given workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.teams.settings.setName operationId: postAdminTeamsSettingsSetname parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.teams:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - name - team_id type: object properties: team_id: type: string description: ID for the workspace to set the name for. name: type: string description: The new name of the workspace. application/json: schema: required: - name - team_id type: object properties: team_id: type: string description: ID for the workspace to set the name for. name: type: string description: The new name of the workspace. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Teams Settings Setname x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.usergroups.addChannels: post: tags: - Post description: Add one or more default channels to an IDP group. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.usergroups.addChannels operationId: postAdminUsergroupsAddchannels parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.usergroups:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_ids - usergroup_id type: object properties: usergroup_id: type: string description: ID of the IDP group to add default channels for. team_id: type: string description: The workspace to add default channels in. channel_ids: type: string description: Comma separated string of channel IDs. application/json: schema: required: - channel_ids - usergroup_id type: object properties: usergroup_id: type: string description: ID of the IDP group to add default channels for. team_id: type: string description: The workspace to add default channels in. channel_ids: type: string description: Comma separated string of channel IDs. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response if the token provided is not associated with an Org Admin or Owner content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: not_an_admin ok: false security: - slackAuth: - admin.usergroups:write summary: Slack Post Admin Usergroups Addchannels x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.usergroups.addTeams: post: tags: - Post description: Associate one or more default workspaces with an organization-wide IDP group. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.usergroups.addTeams operationId: postAdminUsergroupsAddteams parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.teams:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - team_ids - usergroup_id type: object properties: usergroup_id: type: string description: An encoded usergroup (IDP Group) ID. team_ids: type: string description: A comma separated list of encoded team (workspace) IDs. Each workspace *MUST* belong to the organization associated with the token. auto_provision: type: boolean description: When `true`, this method automatically creates new workspace accounts for the IDP group members. application/json: schema: required: - team_ids - usergroup_id type: object properties: usergroup_id: type: string description: An encoded usergroup (IDP Group) ID. team_ids: type: string description: A comma separated list of encoded team (workspace) IDs. Each workspace *MUST* belong to the organization associated with the token. auto_provision: type: boolean description: When `true`, this method automatically creates new workspace accounts for the IDP group members. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:write summary: Slack Post Admin Usergroups Addteams x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.usergroups.removeChannels: post: tags: - Post description: Remove one or more default channels from an org-level IDP group (user group). externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.usergroups.removeChannels operationId: postAdminUsergroupsRemovechannels parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.usergroups:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_ids - usergroup_id type: object properties: usergroup_id: type: string description: ID of the IDP Group channel_ids: type: string description: Comma-separated string of channel IDs application/json: schema: required: - channel_ids - usergroup_id type: object properties: usergroup_id: type: string description: ID of the IDP Group channel_ids: type: string description: Comma-separated string of channel IDs required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response if the token provided is not associated with an Org Admin or Owner content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: not_an_admin ok: false security: - slackAuth: - admin.usergroups:write summary: Slack Post Admin Usergroups Removechannels x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.users.assign: post: tags: - Post description: Add an Enterprise user to a workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.users.assign operationId: postAdminUsersAssign parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.users:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: The ID of the user to add to the workspace. is_restricted: type: boolean description: True if user should be added to the workspace as a guest. is_ultra_restricted: type: boolean description: True if user should be added to the workspace as a single-channel guest. channel_ids: type: string description: Comma separated values of channel IDs to add user in the new workspace. application/json: schema: required: - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: The ID of the user to add to the workspace. is_restricted: type: boolean description: True if user should be added to the workspace as a guest. is_ultra_restricted: type: boolean description: True if user should be added to the workspace as a single-channel guest. channel_ids: type: string description: Comma separated values of channel IDs to add user in the new workspace. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.users:write summary: Slack Post Admin Users Assign x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.users.invite: post: tags: - Post description: Invite a user to a workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.users.invite operationId: postAdminUsersInvite parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.users:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel_ids - email - team_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. email: type: string description: The email address of the person to invite. channel_ids: type: string description: A comma-separated list of `channel_id`s for this user to join. At least one channel is required. custom_message: type: string description: An optional message to send to the user in the invite email. real_name: type: string description: Full name of the user. resend: type: boolean description: 'Allow this invite to be resent in the future if a user has not signed up yet. (default: false)' is_restricted: type: boolean description: 'Is this user a multi-channel guest user? (default: false)' is_ultra_restricted: type: boolean description: 'Is this user a single channel guest user? (default: false)' guest_expiration_ts: type: string description: Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date. application/json: schema: required: - channel_ids - email - team_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. email: type: string description: The email address of the person to invite. channel_ids: type: string description: A comma-separated list of `channel_id`s for this user to join. At least one channel is required. custom_message: type: string description: An optional message to send to the user in the invite email. real_name: type: string description: Full name of the user. resend: type: boolean description: 'Allow this invite to be resent in the future if a user has not signed up yet. (default: false)' is_restricted: type: boolean description: 'Is this user a multi-channel guest user? (default: false)' is_ultra_restricted: type: boolean description: 'Is this user a single channel guest user? (default: false)' guest_expiration_ts: type: string description: Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.users:write summary: Slack Post Admin Users Invite x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.users.remove: post: tags: - Post description: Remove a user from a workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.users.remove operationId: postAdminUsersRemove parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.users:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: The ID of the user to remove. application/json: schema: required: - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: The ID of the user to remove. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.users:write summary: Slack Post Admin Users Remove x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.users.session.invalidate: post: tags: - Post description: Invalidate a single session for a user by session_id externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.users.session.invalidate operationId: postAdminUsersSessionInvalidate parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.users:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - session_id - team_id type: object properties: team_id: type: string description: ID of the team that the session belongs to session_id: type: integer format: int32 application/json: schema: required: - session_id - team_id type: object properties: team_id: type: string description: ID of the team that the session belongs to session_id: type: integer format: int32 required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.users:write summary: Slack Post Admin Users Session Invalidate x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.users.session.reset: post: tags: - Post description: Wipes all valid sessions on all devices for a given user externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.users.session.reset operationId: postAdminUsersSessionReset parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.users:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - user_id type: object properties: user_id: type: string description: The ID of the user to wipe sessions for mobile_only: type: boolean description: 'Only expire mobile sessions (default: false)' web_only: type: boolean description: 'Only expire web sessions (default: false)' application/json: schema: required: - user_id type: object properties: user_id: type: string description: The ID of the user to wipe sessions for mobile_only: type: boolean description: 'Only expire mobile sessions (default: false)' web_only: type: boolean description: 'Only expire web sessions (default: false)' required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.users:write summary: Slack Post Admin Users Session Reset x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.users.setAdmin: post: tags: - Post description: Set an existing guest, regular user, or owner to be an admin user. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.users.setAdmin operationId: postAdminUsersSetadmin parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.users:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: The ID of the user to designate as an admin. application/json: schema: required: - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: The ID of the user to designate as an admin. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.users:write summary: Slack Post Admin Users Setadmin x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.users.setExpiration: post: tags: - Post description: Set an expiration for a guest user externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.users.setExpiration operationId: postAdminUsersSetexpiration parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.users:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - expiration_ts - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: The ID of the user to set an expiration for. expiration_ts: type: integer description: Timestamp when guest account should be disabled. format: int32 application/json: schema: required: - expiration_ts - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: The ID of the user to set an expiration for. expiration_ts: type: integer description: Timestamp when guest account should be disabled. format: int32 required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.users:write summary: Slack Post Admin Users Setexpiration x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.users.setOwner: post: tags: - Post description: Set an existing guest, regular user, or admin user to be a workspace owner. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.users.setOwner operationId: postAdminUsersSetowner parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.users:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: Id of the user to promote to owner. application/json: schema: required: - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: Id of the user to promote to owner. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.users:write summary: Slack Post Admin Users Setowner x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.users.setRegular: post: tags: - Post description: Set an existing guest user, admin user, or owner to be a regular user. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.users.setRegular operationId: postAdminUsersSetregular parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.users:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: The ID of the user to designate as a regular user. application/json: schema: required: - team_id - user_id type: object properties: team_id: type: string description: The ID (`T1234`) of the workspace. user_id: type: string description: The ID of the user to designate as a regular user. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.users:write summary: Slack Post Admin Users Setregular x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /calls.add: post: tags: - Post description: Registers a new Call. externalDocs: description: API method documentation url: https://api.slack.com/methods/calls.add operationId: calls_add parameters: - name: token in: header description: 'Authentication token. Requires scope: `calls:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - external_unique_id - join_url type: object properties: external_unique_id: type: string description: An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service. external_display_id: type: string description: An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object. join_url: type: string description: The URL required for a client to join the Call. desktop_app_join_url: type: string description: When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. date_start: type: integer description: Call start time in UTC UNIX timestamp format format: int32 title: type: string description: The name of the Call. created_by: type: string description: The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required. users: type: string description: The list of users to register as participants in the Call. [Read more on how to specify users here](/apis/calls#users). application/json: schema: required: - external_unique_id - join_url type: object properties: external_unique_id: type: string description: An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service. external_display_id: type: string description: An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object. join_url: type: string description: The URL required for a client to join the Call. desktop_app_join_url: type: string description: When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. date_start: type: integer description: Call start time in UTC UNIX timestamp format format: int32 title: type: string description: The name of the Call. created_by: type: string description: The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required. users: type: string description: The list of users to register as participants in the Call. [Read more on how to specify users here](/apis/calls#users). required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - calls:write summary: Slack Post Calls Add x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true PascalCaseOperationTags: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /calls.end: post: tags: - Post description: Ends a Call. externalDocs: description: API method documentation url: https://api.slack.com/methods/calls.end operationId: calls_end parameters: - name: token in: header description: 'Authentication token. Requires scope: `calls:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - id type: object properties: id: type: string description: '`id` returned when registering the call using the [`calls.add`](/methods/calls.add) method.' duration: type: integer description: Call duration in seconds format: int32 application/json: schema: required: - id type: object properties: id: type: string description: '`id` returned when registering the call using the [`calls.add`](/methods/calls.add) method.' duration: type: integer description: Call duration in seconds format: int32 required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - calls:write summary: Slack Post Calls End x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true PascalCaseOperationTags: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /calls.participants.add: post: tags: - Post description: Registers new participants added to a Call. externalDocs: description: API method documentation url: https://api.slack.com/methods/calls.participants.add operationId: calls_participants_add parameters: - name: token in: header description: 'Authentication token. Requires scope: `calls:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - id - users type: object properties: id: type: string description: '`id` returned by the [`calls.add`](/methods/calls.add) method.' users: type: string description: The list of users to add as participants in the Call. [Read more on how to specify users here](/apis/calls#users). application/json: schema: required: - id - users type: object properties: id: type: string description: '`id` returned by the [`calls.add`](/methods/calls.add) method.' users: type: string description: The list of users to add as participants in the Call. [Read more on how to specify users here](/apis/calls#users). required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - calls:write summary: Slack Post Calls Participants Add x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true PascalCaseOperationTags: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /calls.participants.remove: post: tags: - Post description: Registers participants removed from a Call. externalDocs: description: API method documentation url: https://api.slack.com/methods/calls.participants.remove operationId: calls_participants_remove parameters: - name: token in: header description: 'Authentication token. Requires scope: `calls:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - id - users type: object properties: id: type: string description: '`id` returned by the [`calls.add`](/methods/calls.add) method.' users: type: string description: The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users). application/json: schema: required: - id - users type: object properties: id: type: string description: '`id` returned by the [`calls.add`](/methods/calls.add) method.' users: type: string description: The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users). required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - calls:write summary: Slack Post Calls Participants Remove x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true PascalCaseOperationTags: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /calls.update: post: tags: - Post description: Updates information about a Call. externalDocs: description: API method documentation url: https://api.slack.com/methods/calls.update operationId: calls_update parameters: - name: token in: header description: 'Authentication token. Requires scope: `calls:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - id type: object properties: id: type: string description: '`id` returned by the [`calls.add`](/methods/calls.add) method.' title: type: string description: The name of the Call. join_url: type: string description: The URL required for a client to join the Call. desktop_app_join_url: type: string description: When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. application/json: schema: required: - id type: object properties: id: type: string description: '`id` returned by the [`calls.add`](/methods/calls.add) method.' title: type: string description: The name of the Call. join_url: type: string description: The URL required for a client to join the Call. desktop_app_join_url: type: string description: When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. required: true responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - calls:write summary: Slack Post Calls Update x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true PascalCaseOperationTags: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /chat.delete: post: tags: - Post description: Deletes a message. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.delete operationId: postChatDelete parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: ts: type: number description: Timestamp of the message to be deleted. channel: type: string description: Channel containing the message to be deleted. as_user: type: boolean description: Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope. application/json: schema: type: object properties: ts: type: number description: Timestamp of the message to be deleted. channel: type: string description: Channel containing the message to be deleted. as_user: type: boolean description: Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope. responses: '200': description: Typical success response content: application/json: schema: title: chat.delete success schema required: - channel - ok - ts type: object properties: channel: $ref: '#/components/schemas/defs_channel' ok: $ref: '#/components/schemas/defs_ok_true' ts: $ref: '#/components/schemas/defs_ts' additionalProperties: false description: Schema for successful response of chat.delete method example: channel: C024BE91L ok: true ts: '1401383885.000061' default: description: Typical error response content: application/json: schema: title: chat.delete error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from chat.delete method example: error: message_not_found ok: false security: - slackAuth: - chat:write:user - chat:write:bot summary: Slack Post Chat Delete x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /chat.deleteScheduledMessage: post: tags: - Post description: Deletes a pending scheduled message from the queue. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.deleteScheduledMessage operationId: postChatDeletescheduledmessage parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel - scheduled_message_id type: object properties: as_user: type: boolean description: Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope. channel: type: string description: The channel the scheduled_message is posting to scheduled_message_id: type: string description: '`scheduled_message_id` returned from call to chat.scheduleMessage' application/json: schema: required: - channel - scheduled_message_id type: object properties: as_user: type: boolean description: Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope. channel: type: string description: The channel the scheduled_message is posting to scheduled_message_id: type: string description: '`scheduled_message_id` returned from call to chat.scheduleMessage' required: true responses: '200': description: Typical success response content: application/json: schema: title: chat.deleteScheduledMessage schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from chat.deleteScheduledMessage method example: ok: true default: description: Typical error response if no message is found content: application/json: schema: title: chat.deleteScheduledMessage error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from chat.deleteScheduledMessage method example: error: invalid_scheduled_message_id ok: false security: - slackAuth: - chat:write:user - chat:write:bot summary: Slack Post Chat Deletescheduledmessage x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /chat.meMessage: post: tags: - Post description: Share a me message into a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.meMessage operationId: postChatMemessage parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name. text: type: string description: Text of the message to send. application/json: schema: type: object properties: channel: type: string description: Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name. text: type: string description: Text of the message to send. responses: '200': description: Typical success response content: application/json: schema: title: chat.meMessage schema required: - ok type: object properties: channel: $ref: '#/components/schemas/defs_channel' ok: $ref: '#/components/schemas/defs_ok_true' ts: $ref: '#/components/schemas/defs_ts' additionalProperties: false description: Schema for successful response from chat.meMessage method example: channel: C024BE7LR ok: true ts: '1417671948.000006' default: description: Typical error response content: application/json: schema: title: chat.meMessage error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from chat.meMessage method example: error: invalid_auth ok: false security: - slackAuth: - chat:write:user - chat:write:bot summary: Slack Post Chat Memessage x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /chat.postEphemeral: post: tags: - Post description: Sends an ephemeral message to a user in a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.postEphemeral operationId: postChatPostephemeral parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel - user type: object properties: as_user: type: boolean description: Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false. attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. blocks: type: string description: A JSON-based array of structured blocks, presented as a URL-encoded string. channel: type: string description: Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. icon_emoji: type: string description: Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below. icon_url: type: string description: URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. link_names: type: boolean description: Find and link channel names and usernames. parse: type: string description: Change how messages are treated. Defaults to `none`. See [below](#formatting). text: type: string description: How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail. thread_ts: type: string description: Provide another message's `ts` value to post this message in a thread. Avoid using a reply's `ts` value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread. user: type: string description: '`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.' username: type: string description: Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. application/json: schema: required: - channel - user type: object properties: as_user: type: boolean description: Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false. attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. blocks: type: string description: A JSON-based array of structured blocks, presented as a URL-encoded string. channel: type: string description: Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. icon_emoji: type: string description: Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below. icon_url: type: string description: URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. link_names: type: boolean description: Find and link channel names and usernames. parse: type: string description: Change how messages are treated. Defaults to `none`. See [below](#formatting). text: type: string description: How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail. thread_ts: type: string description: Provide another message's `ts` value to post this message in a thread. Avoid using a reply's `ts` value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread. user: type: string description: '`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.' username: type: string description: Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. required: true responses: '200': description: Typical success response content: application/json: schema: title: chat.postEphemeral success schema required: - message_ts - ok type: object properties: message_ts: $ref: '#/components/schemas/defs_ts' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from chat.postEphemeral method example: message_ts: '1502210682.580145' ok: true default: description: Typical error response content: application/json: schema: title: chat.postEphemeral error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from chat.postEphemeral method example: error: user_not_in_channel ok: false security: - slackAuth: - chat:write:user - chat:write:bot summary: Slack Post Chat Postephemeral x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /chat.postMessage: post: tags: - Post description: Sends a message to a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.postMessage operationId: postChatPostmessage parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel type: object properties: as_user: type: string description: Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below. attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. blocks: type: string description: A JSON-based array of structured blocks, presented as a URL-encoded string. channel: type: string description: Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details. icon_emoji: type: string description: Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below. icon_url: type: string description: URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. link_names: type: boolean description: Find and link channel names and usernames. mrkdwn: type: boolean description: Disable Slack markup parsing by setting to `false`. Enabled by default. parse: type: string description: Change how messages are treated. Defaults to `none`. See [below](#formatting). reply_broadcast: type: boolean description: Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`. text: type: string description: How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail. thread_ts: type: string description: Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead. unfurl_links: type: boolean description: Pass true to enable unfurling of primarily text-based content. unfurl_media: type: boolean description: Pass false to disable unfurling of media content. username: type: string description: Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. application/json: schema: required: - channel type: object properties: as_user: type: string description: Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below. attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. blocks: type: string description: A JSON-based array of structured blocks, presented as a URL-encoded string. channel: type: string description: Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details. icon_emoji: type: string description: Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below. icon_url: type: string description: URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. link_names: type: boolean description: Find and link channel names and usernames. mrkdwn: type: boolean description: Disable Slack markup parsing by setting to `false`. Enabled by default. parse: type: string description: Change how messages are treated. Defaults to `none`. See [below](#formatting). reply_broadcast: type: boolean description: Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`. text: type: string description: How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail. thread_ts: type: string description: Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead. unfurl_links: type: boolean description: Pass true to enable unfurling of primarily text-based content. unfurl_media: type: boolean description: Pass false to disable unfurling of media content. username: type: string description: Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. required: true responses: '200': description: Typical success response content: application/json: schema: title: chat.postMessage success schema required: - channel - message - ok - ts type: object 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' additionalProperties: false description: Schema for successful response of chat.postMessage method example: channel: C1H9RESGL message: attachments: - fallback: This is an attachment's fallback id: 1 text: This is an attachment bot_id: B19LU7CSY subtype: bot_message text: Here's a message for you ts: '1503435956.000247' type: message username: ecto1 ok: true ts: '1503435956.000247' default: description: Typical error response if too many attachments are included content: application/json: schema: title: chat.postMessage error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response chat.postMessage method example: error: too_many_attachments ok: false security: - slackAuth: - chat:write:user - chat:write:bot summary: Slack Post Chat Postmessage x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /chat.scheduleMessage: post: tags: - Post description: Schedules a message to be sent to a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.scheduleMessage operationId: postChatSchedulemessage parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details. text: type: string description: How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail. post_at: type: string description: Unix EPOCH timestamp of time in future to send the message. parse: type: string description: Change how messages are treated. Defaults to `none`. See [chat.postMessage](chat.postMessage#formatting). as_user: type: boolean description: Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [chat.postMessage](chat.postMessage#authorship). link_names: type: boolean description: Find and link channel names and usernames. attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. blocks: type: string description: A JSON-based array of structured blocks, presented as a URL-encoded string. unfurl_links: type: boolean description: Pass true to enable unfurling of primarily text-based content. unfurl_media: type: boolean description: Pass false to disable unfurling of media content. thread_ts: type: number description: Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead. reply_broadcast: type: boolean description: Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`. application/json: schema: type: object properties: channel: type: string description: Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details. text: type: string description: How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail. post_at: type: string description: Unix EPOCH timestamp of time in future to send the message. parse: type: string description: Change how messages are treated. Defaults to `none`. See [chat.postMessage](chat.postMessage#formatting). as_user: type: boolean description: Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [chat.postMessage](chat.postMessage#authorship). link_names: type: boolean description: Find and link channel names and usernames. attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. blocks: type: string description: A JSON-based array of structured blocks, presented as a URL-encoded string. unfurl_links: type: boolean description: Pass true to enable unfurling of primarily text-based content. unfurl_media: type: boolean description: Pass false to disable unfurling of media content. thread_ts: type: number description: Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead. reply_broadcast: type: boolean description: Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`. responses: '200': description: Typical success response content: application/json: schema: title: chat.scheduleMessage success schema required: - channel - message - ok - post_at - scheduled_message_id type: object properties: channel: $ref: '#/components/schemas/defs_channel' message: type: object additionalProperties: false ok: $ref: '#/components/schemas/defs_ok_true' post_at: type: integer scheduled_message_id: title: Scheduled Message ID pattern: ^[Q][A-Z0-9]{8,}$ type: string additionalProperties: false description: Schema for successful response of chat.scheduleMessage method example: channel: C1H9RESGL message: attachments: - fallback: This is an attachment's fallback id: 1 text: This is an attachment bot_id: B19LU7CSY subtype: bot_message text: Here's a message for you in the future type: delayed_message username: ecto1 ok: true post_at: '1562180400' scheduled_message_id: Q1298393284 default: description: Typical error response if the `post_at` is invalid (ex. in the past or too far into the future) content: application/json: schema: title: chat.scheduleMessage error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response chat.scheduleMessage method example: error: time_in_past ok: false security: - slackAuth: - chat:write:user - chat:write:bot summary: Slack Post Chat Schedulemessage x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /chat.unfurl: post: tags: - Post description: Provide custom unfurl behavior for user-posted URLs externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.unfurl operationId: postChatUnfurl parameters: - name: token in: header description: 'Authentication token. Requires scope: `links:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel - ts type: object properties: channel: type: string description: Channel ID of the message ts: type: string description: Timestamp of the message to add unfurl behavior to. unfurls: type: string description: URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments. user_auth_message: type: string description: Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior user_auth_required: type: boolean description: Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain user_auth_url: type: string description: Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded. application/json: schema: required: - channel - ts type: object properties: channel: type: string description: Channel ID of the message ts: type: string description: Timestamp of the message to add unfurl behavior to. unfurls: type: string description: URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments. user_auth_message: type: string description: Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior user_auth_required: type: boolean description: Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain user_auth_url: type: string description: Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded. required: true responses: '200': description: Typical, minimal success response content: application/json: schema: title: chat.unfurl success schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from chat.unfurl method example: ok: true default: description: Typical error response content: application/json: schema: title: chat.unfurl error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from chat.unfurl method example: error: cannot_unfurl_url ok: false security: - slackAuth: - links:write summary: Slack Post Chat Unfurl x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /chat.update: post: tags: - Post description: Updates a message. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.update operationId: postChatUpdate parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel - ts type: object properties: as_user: type: string description: Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users. attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting `text`. If you don't include this field, the message's previous `attachments` will be retained. To remove previous `attachments`, include an empty array for this field. blocks: type: string description: A JSON-based array of [structured blocks](/block-kit/building), presented as a URL-encoded string. If you don't include this field, the message's previous `blocks` will be retained. To remove previous `blocks`, include an empty array for this field. channel: type: string description: Channel containing the message to be updated. link_names: type: string description: Find and link channel names and usernames. Defaults to `none`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `none`. parse: type: string description: Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. Accepts either `none` or `full`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `client`. text: type: string description: New text for the message, using the [default formatting rules](/reference/surfaces/formatting). It's not required when presenting `blocks` or `attachments`. ts: type: string description: Timestamp of the message to be updated. application/json: schema: required: - channel - ts type: object properties: as_user: type: string description: Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users. attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting `text`. If you don't include this field, the message's previous `attachments` will be retained. To remove previous `attachments`, include an empty array for this field. blocks: type: string description: A JSON-based array of [structured blocks](/block-kit/building), presented as a URL-encoded string. If you don't include this field, the message's previous `blocks` will be retained. To remove previous `blocks`, include an empty array for this field. channel: type: string description: Channel containing the message to be updated. link_names: type: string description: Find and link channel names and usernames. Defaults to `none`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `none`. parse: type: string description: Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. Accepts either `none` or `full`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `client`. text: type: string description: New text for the message, using the [default formatting rules](/reference/surfaces/formatting). It's not required when presenting `blocks` or `attachments`. ts: type: string description: Timestamp of the message to be updated. required: true responses: '200': description: Typical success response content: application/json: schema: title: chat.update success schema required: - channel - message - ok - text - ts type: object properties: channel: type: string message: title: Message object required: - text type: object properties: attachments: type: array items: type: object properties: {} blocks: type: object properties: {} text: type: string ok: $ref: '#/components/schemas/defs_ok_true' text: type: string ts: type: string additionalProperties: false description: Schema for successful response of chat.update method example: channel: C024BE91L message: text: Updated text you carefully authored user: U34567890 ok: true text: Updated text you carefully authored ts: '1401383885.000061' default: description: Typical error response content: application/json: schema: title: chat.update error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response chat.update method example: error: cant_update_message ok: false security: - slackAuth: - chat:write:user - chat:write:bot summary: Slack Post Chat Update x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.archive: post: tags: - Post description: Archives a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.archive operationId: postConversationsArchive parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: ID of conversation to archive application/json: schema: type: object properties: channel: type: string description: ID of conversation to archive responses: '200': description: Typical success response content: application/json: schema: title: conversations.archive success schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response conversations.archive method example: ok: true default: description: Typical error response content: application/json: schema: title: conversations.archive error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.archive method example: error: channel_not_found ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Archive x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.close: post: tags: - Post description: Closes a direct message or multi-person direct message. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.close operationId: postConversationsClose parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: Conversation to close. application/json: schema: type: object properties: channel: type: string description: Conversation to close. responses: '200': description: Typical success response content: application/json: schema: title: conversations.close success schema required: - ok type: object properties: already_closed: type: boolean no_op: type: boolean ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response conversations.close method example: ok: true default: description: Typical error response content: application/json: schema: title: conversations.close error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.close method example: error: channel_not_found ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Close x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.create: post: tags: - Post description: Initiates a public or private channel-based conversation externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.create operationId: postConversationsCreate parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: name: type: string description: Name of the public or private channel to create is_private: type: boolean description: Create a private channel instead of a public one application/json: schema: type: object properties: name: type: string description: Name of the public or private channel to create is_private: type: boolean description: Create a private channel instead of a public one responses: '200': description: If successful, the command returns a rather stark [conversation object](/types/conversation) content: application/json: schema: title: conversations.create success schema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/objs_conversation' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response conversations.create method example: channel: created: 1504554479 creator: U0123456 id: C0EAQDV4Z is_archived: false is_channel: true is_ext_shared: false is_general: false is_group: false is_im: false is_member: true is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false last_read: '0000000000.000000' latest: null name: endeavor name_normalized: endeavor pending_shared: [] previous_names: [] priority: 0 purpose: creator: '' last_set: 0 value: '' topic: creator: '' last_set: 0 value: '' unlinked: 0 unread_count: 0 unread_count_display: 0 ok: true default: description: Typical error response when name already in use content: application/json: schema: title: conversations.create error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' detail: type: string error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.create method example: error: name_taken ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Create x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.invite: post: tags: - Post description: Invites users to a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.invite operationId: postConversationsInvite parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: The ID of the public or private channel to invite user(s) to. users: type: string description: A comma separated list of user IDs. Up to 1000 users may be listed. application/json: schema: type: object properties: channel: type: string description: The ID of the public or private channel to invite user(s) to. users: type: string description: A comma separated list of user IDs. Up to 1000 users may be listed. responses: '200': description: Typical success response when an invitation is extended content: application/json: schema: title: conversations.invite error schema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/objs_conversation' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from conversations.invite method example: channel: created: 1449252889 creator: W012A3BCD id: C012AB3CD is_archived: false is_channel: true is_ext_shared: false is_general: true is_group: false is_im: false is_member: true is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_read_only: false is_shared: false last_read: '1502126650.228446' locale: en-US name: general name_normalized: general num_members: 23 pending_shared: [] previous_names: - specifics - abstractions - etc purpose: creator: W012A3BCD last_set: 1449709364 value: This part of the workspace is for fun. Make fun here. topic: creator: W012A3BCD last_set: 1449709364 value: For public discussion of generalities unlinked: 0 ok: true default: description: Typical error response when an invite is attempted on a conversation type that does not support it content: application/json: schema: title: conversations.invite error schema required: - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 errors: title: errors is returned when an error associates an user minItems: 1 uniqueItems: true type: array items: type: object additionalProperties: false needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.invite method example: error: method_not_supported_for_channel_type ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Invite x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.join: post: tags: - Post description: Joins an existing conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.join operationId: postConversationsJoin parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: ID of conversation to join application/json: schema: type: object properties: channel: type: string description: ID of conversation to join responses: '200': description: Typical success response content: application/json: schema: title: conversations.join success schema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/objs_conversation' ok: $ref: '#/components/schemas/defs_ok_true' response_metadata: title: Response metadata type: object properties: warnings: minItems: 1 uniqueItems: true type: array items: type: string warning: type: string additionalProperties: false description: Schema for successful response from conversations.join method example: channel: created: 1449252889 creator: U061F7AUR id: C061EG9SL is_archived: false is_channel: true is_ext_shared: false is_general: true is_group: false is_im: false is_member: true is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: general name_normalized: general pending_shared: [] previous_names: [] purpose: creator: '' last_set: 0 value: For widget discussion topic: creator: '' last_set: 0 value: Which widget do you worry about? unlinked: 0 ok: true response_metadata: warnings: - already_in_channel warning: already_in_channel default: description: Typical error response if the conversation is archived and cannot be joined content: application/json: schema: title: conversations.join error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.join method example: error: is_archived ok: false security: - slackAuth: - channels:write summary: Slack Post Conversations Join x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.kick: post: tags: - Post description: Removes a user from a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.kick operationId: postConversationsKick parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: ID of conversation to remove user from. user: type: string description: User ID to be removed. application/json: schema: type: object properties: channel: type: string description: ID of conversation to remove user from. user: type: string description: User ID to be removed. responses: '200': description: Typical success response content: application/json: schema: title: conversations.kick success schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response conversations.kick method example: ok: true default: description: Typical error response when you attempt to kick yourself from a channel content: application/json: schema: title: conversations.kick error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response conversations.kick method example: error: cant_kick_self ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Kick x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.leave: post: tags: - Post description: Leaves a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.leave operationId: postConversationsLeave parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: Conversation to leave application/json: schema: type: object properties: channel: type: string description: Conversation to leave responses: '200': description: Typical success response content: application/json: schema: title: conversations.leave success schema required: - ok type: object properties: not_in_channel: type: boolean ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from conversations.leave method example: ok: true default: description: Typical error response when attempting to leave a workspace's "general" channel content: application/json: schema: title: conversations.leave error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.leave method example: error: cant_leave_general ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Leave x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.mark: post: tags: - Post description: Sets the read cursor in a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.mark operationId: postConversationsMark parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: Channel or conversation to set the read cursor for. ts: type: number description: Unique identifier of message you want marked as most recently seen in this conversation. application/json: schema: type: object properties: channel: type: string description: Channel or conversation to set the read cursor for. ts: type: number description: Unique identifier of message you want marked as most recently seen in this conversation. responses: '200': description: Typical success response content: application/json: schema: title: conversations.mark success schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response conversations.mark method example: ok: true default: description: Typical error response content: application/json: schema: title: conversations.mark error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.mark method example: error: invalid_auth ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Mark x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.open: post: tags: - Post description: Opens or resumes a direct message or multi-person direct message. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.open operationId: postConversationsOpen parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead. users: type: string description: Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`. return_im: type: boolean description: Boolean, indicates you want the full IM channel definition in the response. application/json: schema: type: object properties: channel: type: string description: Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead. users: type: string description: Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`. return_im: type: boolean description: Boolean, indicates you want the full IM channel definition in the response. responses: '200': description: Typical success response content: application/json: schema: title: conversations.open success schema required: - channel - ok type: object properties: already_open: type: boolean channel: type: object no_op: type: boolean ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from conversations.open method when opening channels, ims, mpims example: channel: id: D069C7QFK ok: true default: description: Typical error response content: application/json: schema: title: conversations.open error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from conversations.open method example: error: channel_not_found ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Open x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.rename: post: tags: - Post description: Renames a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.rename operationId: postConversationsRename parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: ID of conversation to rename name: type: string description: New name for conversation. application/json: schema: type: object properties: channel: type: string description: ID of conversation to rename name: type: string description: New name for conversation. responses: '200': description: Typical success response content: application/json: schema: title: conversations.rename success schema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/objs_conversation' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from conversations.rename method example: channel: created: 1449252889 creator: W012A3BCD id: C012AB3CD is_archived: false is_channel: true is_ext_shared: false is_general: true is_group: false is_im: false is_member: true is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_read_only: false is_shared: false last_read: '1502126650.228446' locale: en-US name: general name_normalized: general num_members: 23 pending_shared: [] previous_names: - specifics - abstractions - etc purpose: creator: W012A3BCD last_set: 1449709364 value: This part of the workspace is for fun. Make fun here. topic: creator: W012A3BCD last_set: 1449709364 value: For public discussion of generalities unlinked: 0 ok: true default: description: Typical error response when the calling user is not a member of the conversation content: application/json: schema: title: conversations.rename error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.rename method example: error: not_in_channel ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Rename x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.setPurpose: post: tags: - Post description: Sets the purpose for a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.setPurpose operationId: postConversationsSetpurpose parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: Conversation to set the purpose of purpose: type: string description: A new, specialer purpose application/json: schema: type: object properties: channel: type: string description: Conversation to set the purpose of purpose: type: string description: A new, specialer purpose responses: '200': description: Typical success response content: application/json: schema: title: conversations.setPurpose success schema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/objs_conversation' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from conversations.setPurpose method example: ok: true default: description: Typical error response content: application/json: schema: title: conversations.setPurpose error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.setPurpose method example: error: invalid_auth ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Setpurpose x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.setTopic: post: tags: - Post description: Sets the topic for a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.setTopic operationId: postConversationsSettopic parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: Conversation to set the topic of topic: type: string description: The new topic string. Does not support formatting or linkification. application/json: schema: type: object properties: channel: type: string description: Conversation to set the topic of topic: type: string description: The new topic string. Does not support formatting or linkification. responses: '200': description: Typical success response content: application/json: schema: title: conversations.setTopic success schema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/objs_conversation' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from conversations.setTopic method example: ok: true default: description: Typical error response content: application/json: schema: title: conversations.setTopic error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.setTopic method example: error: invalid_auth ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Settopic x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.unarchive: post: tags: - Post description: Reverses conversation archival. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.unarchive operationId: postConversationsUnarchive parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: ID of conversation to unarchive application/json: schema: type: object properties: channel: type: string description: ID of conversation to unarchive responses: '200': description: Typical success response content: application/json: schema: title: conversations.unarchive success schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from conversations.unarchive method example: ok: true default: description: Typical error response content: application/json: schema: title: conversations.unarchive error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.unarchive method example: error: channel_not_found ok: false security: - slackAuth: - channels:write - groups:write - im:write - mpim:write summary: Slack Post Conversations Unarchive x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /dnd.endDnd: post: tags: - Post description: Ends the current user's Do Not Disturb session immediately. externalDocs: description: API method documentation url: https://api.slack.com/methods/dnd.endDnd operationId: postDndEnddnd parameters: - name: token in: header description: 'Authentication token. Requires scope: `dnd:write`' required: true schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: dnd.endDnd schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from dnd.endDnd method example: ok: true default: description: Typical error response content: application/json: schema: title: dnd.endDnd error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - unknown_error - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from dnd.endDnd method example: error: invalid_auth ok: false security: - slackAuth: - dnd:write summary: Slack Post End Do Not Disturb x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /dnd.endSnooze: post: tags: - Post description: Ends the current user's snooze mode immediately. externalDocs: description: API method documentation url: https://api.slack.com/methods/dnd.endSnooze operationId: postDndEndsnooze parameters: - name: token in: header description: 'Authentication token. Requires scope: `dnd:write`' required: true schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: dnd.endSnooze schema required: - dnd_enabled - next_dnd_end_ts - next_dnd_start_ts - ok - snooze_enabled type: object 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 additionalProperties: false description: Schema for successful response from dnd.endSnooze method example: ok: true default: description: Typical error response content: application/json: schema: title: dnd.endSnooze error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - snooze_not_active - snooze_end_failed - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from dnd.endSnooze method example: error: invalid_auth ok: false security: - slackAuth: - dnd:write summary: Slack Post End Do Not Disturb Snooze x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /dnd.setSnooze: post: tags: - Post description: Turns on Do Not Disturb mode for the current user, or changes its duration. externalDocs: description: API method documentation url: https://api.slack.com/methods/dnd.setSnooze operationId: postDndSetsnooze requestBody: content: application/x-www-form-urlencoded: schema: required: - num_minutes - token type: object properties: token: type: string description: 'Authentication token. Requires scope: `dnd:write`' num_minutes: type: string description: Number of minutes, from now, to snooze until. required: true responses: '200': description: Typical success response content: application/json: schema: title: dnd.setSnooze schema required: - ok - snooze_enabled - snooze_endtime - snooze_remaining type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' snooze_enabled: type: boolean snooze_endtime: type: integer snooze_remaining: type: integer additionalProperties: false description: Schema for successful response from dnd.setSnooze method example: ok: true default: description: Typical error response content: application/json: schema: title: dnd.setSnooze error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - missing_duration - snooze_failed - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - too_long - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from dnd.setSnooze method example: error: invalid_auth ok: false security: - slackAuth: - dnd:write summary: Slack Post Do Not Disturb Snooze x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.comments.delete: post: tags: - Post description: Deletes an existing comment on a file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.comments.delete operationId: postFilesCommentsDelete parameters: - name: token in: header description: 'Authentication token. Requires scope: `files:write:user`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: file: type: string description: File to delete a comment from. id: type: string description: The comment to delete. application/json: schema: type: object properties: file: type: string description: File to delete a comment from. id: type: string description: The comment to delete. responses: '200': description: Standard success response is very simple content: application/json: schema: title: files.comments.delete schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response files.comments.delete method example: ok: true default: description: Standard failure response when used with an invalid token content: application/json: schema: title: files.comments.delete error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response files.comments.delete method example: error: file_not_found ok: false security: - slackAuth: - files:write:user summary: Slack Post Files Comments Delete x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.delete: post: tags: - Post description: Deletes a file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.delete operationId: postFilesDelete parameters: - name: token in: header description: 'Authentication token. Requires scope: `files:write:user`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: file: type: string description: ID of file to delete. application/json: schema: type: object properties: file: type: string description: ID of file to delete. responses: '200': description: Typical success response content: application/json: schema: title: files.delete schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response files.delete method example: ok: true default: description: Typical error response content: application/json: schema: title: files.delete error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response files.delete method example: error: invalid_auth ok: false security: - slackAuth: - files:write:user summary: Slack Post Files Delete x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.remote.add: post: tags: - Post description: Adds a file from a remote service externalDocs: description: API method documentation url: https://api.slack.com/methods/files.remote.add operationId: postFilesRemoteAdd requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: token: type: string description: 'Authentication token. Requires scope: `remote_files:write`' external_id: type: string description: Creator defined GUID for the file. title: type: string description: Title of the file being shared. filetype: type: string description: type of file external_url: type: string description: URL of the remote file. preview_image: type: string description: Preview of the document via `multipart/form-data`. indexable_file_contents: type: string description: A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file. responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - remote_files:write summary: Slack Post Files Remote Add x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.remote.remove: post: tags: - Post description: Remove a remote file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.remote.remove operationId: postFilesRemoteRemove requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: token: type: string description: 'Authentication token. Requires scope: `remote_files:write`' file: type: string description: Specify a file by providing its ID. external_id: type: string description: Creator defined GUID for the file. responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - remote_files:write summary: Slack Post Files Remote Remove x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.remote.update: post: tags: - Post description: Updates an existing remote file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.remote.update operationId: postFilesRemoteUpdate requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: token: type: string description: 'Authentication token. Requires scope: `remote_files:write`' file: type: string description: Specify a file by providing its ID. external_id: type: string description: Creator defined GUID for the file. title: type: string description: Title of the file being shared. filetype: type: string description: type of file external_url: type: string description: URL of the remote file. preview_image: type: string description: Preview of the document via `multipart/form-data`. indexable_file_contents: type: string description: File containing contents that can be used to improve searchability for the remote file. responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - remote_files:write summary: Slack Post Files Remote Update x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.revokePublicURL: post: tags: - Post description: Revokes public/external sharing access for a file externalDocs: description: API method documentation url: https://api.slack.com/methods/files.revokePublicURL operationId: postFilesRevokepublicurl parameters: - name: token in: header description: 'Authentication token. Requires scope: `files:write:user`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: file: type: string description: File to revoke application/json: schema: type: object properties: file: type: string description: File to revoke responses: '200': description: Typical success response content: application/json: schema: title: files.revokePublicURL schema required: - file - ok type: object properties: file: $ref: '#/components/schemas/objs_file' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from files.revokePublicURL method example: ok: true default: description: Typical error response content: application/json: schema: title: files.revokePublicURL error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from files.revokePublicURL method example: error: invalid_auth ok: false security: - slackAuth: - files:write:user summary: Slack Post Files Revokepublicurl x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.sharedPublicURL: post: tags: - Post description: Enables a file for public/external sharing. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.sharedPublicURL operationId: postFilesSharedpublicurl parameters: - name: token in: header description: 'Authentication token. Requires scope: `files:write:user`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: file: type: string description: File to share application/json: schema: type: object properties: file: type: string description: File to share responses: '200': description: Typical success response content: application/json: schema: title: files.sharedPublicURL schema required: - file - ok type: object properties: file: $ref: '#/components/schemas/objs_file' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from files.sharedPublicURL method example: ok: true default: description: Typical error response content: application/json: schema: title: files.sharedPublicURL error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - file_not_found - not_allowed - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - user_is_restricted - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from files.sharedPublicURL method example: error: invalid_auth ok: false security: - slackAuth: - files:write:user summary: Slack Post Files Sharedpublicurl x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.upload: post: tags: - Post description: Uploads or creates a file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.upload operationId: postFilesUpload requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: token: type: string description: 'Authentication token. Requires scope: `files:write:user`' file: type: string description: File contents via `multipart/form-data`. If omitting this parameter, you must submit `content`. content: type: string description: File contents via a POST variable. If omitting this parameter, you must provide a `file`. filetype: type: string description: A [file type](/types/file#file_types) identifier. filename: type: string description: Filename of file. title: type: string description: Title of file. initial_comment: type: string description: The message text introducing the file in specified `channels`. channels: type: string description: Comma-separated list of channel names or IDs where the file will be shared. thread_ts: type: number description: Provide another message's `ts` value to upload this file as a reply. Never use a reply's `ts` value; use its parent instead. responses: '200': description: Success response after uploading a file to a channel with an initial message content: application/json: schema: title: files.upload schema required: - file - ok type: object properties: file: $ref: '#/components/schemas/objs_file' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response files.upload method example: file: channels: [] comments_count: 0 created: 1532293501 display_as_bot: false editable: false external_type: '' filetype: gif groups: [] has_rich_preview: false id: F0TD00400 image_exif_rotation: 1 ims: - D0L4B9P0Q is_external: false is_public: false is_starred: false mimetype: image/jpeg mode: hosted name: dramacat.gif original_h: 366 original_w: 526 permalink: https://.../dramacat.gif permalink_public: https://.../More-Path-Components pretty_type: JPEG public_url_shared: false shares: private: D0L4B9P0Q: - reply_count: 0 reply_users: [] reply_users_count: 0 ts: '1532293503.000001' size: 43518 thumb_160: https://.../dramacat_160.gif thumb_360: https://.../dramacat_360.gif thumb_360_h: 250 thumb_360_w: 360 thumb_480: https://.../dramacat_480.gif thumb_480_h: 334 thumb_480_w: 480 thumb_64: https://.../dramacat_64.gif thumb_80: https://.../dramacat_80.gif timestamp: 1532293501 title: dramacat url_private: https://.../dramacat.gif url_private_download: https://.../dramacat.gif user: U0L4B9NSU username: '' ok: true default: description: Typical error response content: application/json: schema: title: files.upload error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - posting_to_general_channel_denied - invalid_channel - file_uploads_disabled - file_uploads_except_images_disabled - storage_limit_reached - not_authed - invalid_auth - account_inactive - no_permission - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response files.upload method example: error: invalid_auth ok: false security: - slackAuth: - files:write:user summary: Slack Post Files Upload x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /pins.add: post: tags: - Post description: Pins an item to a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/pins.add operationId: postPinsAdd parameters: - name: token in: header description: 'Authentication token. Requires scope: `pins:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel type: object properties: channel: type: string description: Channel to pin the item in. timestamp: type: string description: Timestamp of the message to pin. application/json: schema: required: - channel type: object properties: channel: type: string description: Channel to pin the item in. timestamp: type: string description: Timestamp of the message to pin. required: true responses: '200': description: Typical success response content: application/json: schema: title: pins.add schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from pins.add method example: ok: true default: description: Typical error response content: application/json: schema: title: pins.add error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from pins.add method example: error: channel_not_found ok: false security: - slackAuth: - pins:write summary: Slack Post Pins Add x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /pins.remove: post: tags: - Post description: Un-pins an item from a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/pins.remove operationId: postPinsRemove parameters: - name: token in: header description: 'Authentication token. Requires scope: `pins:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel type: object properties: channel: type: string description: Channel where the item is pinned to. timestamp: type: string description: Timestamp of the message to un-pin. application/json: schema: required: - channel type: object properties: channel: type: string description: Channel where the item is pinned to. timestamp: type: string description: Timestamp of the message to un-pin. required: true responses: '200': description: Typical success response content: application/json: schema: title: pins.remove schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from pins.remove method example: ok: true default: description: Typical error response content: application/json: schema: title: pins.remove error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from pins.remove method example: error: no_pin ok: false security: - slackAuth: - pins:write summary: Slack Post Pins Remove x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /reactions.add: post: tags: - Post description: Adds a reaction to an item. externalDocs: description: API method documentation url: https://api.slack.com/methods/reactions.add operationId: postReactionsAdd parameters: - name: token in: header description: 'Authentication token. Requires scope: `reactions:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - channel - name - timestamp type: object properties: channel: type: string description: Channel where the message to add reaction to was posted. name: type: string description: Reaction (emoji) name. timestamp: type: string description: Timestamp of the message to add reaction to. application/json: schema: required: - channel - name - timestamp type: object properties: channel: type: string description: Channel where the message to add reaction to was posted. name: type: string description: Reaction (emoji) name. timestamp: type: string description: Timestamp of the message to add reaction to. required: true responses: '200': description: Typical success response content: application/json: schema: title: reactions.add schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from reactions.add method example: ok: true default: description: Typical error response content: application/json: schema: title: reactions.add error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from reactions.add method example: error: already_reacted ok: false security: - slackAuth: - reactions:write summary: Slack Post Reactions Add x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /reactions.remove: post: tags: - Post description: Removes a reaction from an item. externalDocs: description: API method documentation url: https://api.slack.com/methods/reactions.remove operationId: postReactionsRemove parameters: - name: token in: header description: 'Authentication token. Requires scope: `reactions:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - name type: object properties: name: type: string description: Reaction (emoji) name. file: type: string description: File to remove reaction from. file_comment: type: string description: File comment to remove reaction from. channel: type: string description: Channel where the message to remove reaction from was posted. timestamp: type: string description: Timestamp of the message to remove reaction from. application/json: schema: required: - name type: object properties: name: type: string description: Reaction (emoji) name. file: type: string description: File to remove reaction from. file_comment: type: string description: File comment to remove reaction from. channel: type: string description: Channel where the message to remove reaction from was posted. timestamp: type: string description: Timestamp of the message to remove reaction from. required: true responses: '200': description: Typical success response content: application/json: schema: title: reactions.remove schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from reactions.remove method example: ok: true default: description: Typical error response content: application/json: schema: title: reactions.remove error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from reactions.remove method example: error: no_reaction ok: false security: - slackAuth: - reactions:write summary: Slack Post Reactions Remove x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /reminders.add: post: tags: - Post description: Creates a reminder. externalDocs: description: API method documentation url: https://api.slack.com/methods/reminders.add operationId: postRemindersAdd parameters: - name: token in: header description: 'Authentication token. Requires scope: `reminders:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - text - time type: object properties: text: type: string description: The content of the reminder time: type: string description: 'When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday")' user: type: string description: The user who will receive the reminder. If no user is specified, the reminder will go to user who created it. application/json: schema: required: - text - time type: object properties: text: type: string description: The content of the reminder time: type: string description: 'When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday")' user: type: string description: The user who will receive the reminder. If no user is specified, the reminder will go to user who created it. required: true responses: '200': description: Typical success response content: application/json: schema: title: reminders.add schema required: - ok - reminder type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' reminder: $ref: '#/components/schemas/objs_reminder' additionalProperties: false description: Schema for successful response from reminders.add method example: ok: true default: description: Typical error response content: application/json: schema: title: reminders.add error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - cannot_parse - user_not_found - cannot_add_bot - cannot_add_slackbot - cannot_add_others - cannot_add_others_recurring - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from reminders.add method example: error: invalid_auth ok: false security: - slackAuth: - reminders:write summary: Slack Post Reminders Add x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /reminders.complete: post: tags: - Post description: Marks a reminder as complete. externalDocs: description: API method documentation url: https://api.slack.com/methods/reminders.complete operationId: postRemindersComplete parameters: - name: token in: header description: 'Authentication token. Requires scope: `reminders:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: reminder: type: string description: The ID of the reminder to be marked as complete application/json: schema: type: object properties: reminder: type: string description: The ID of the reminder to be marked as complete responses: '200': description: Typical success response content: application/json: schema: title: reminders.complete schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from reminders.complete method example: ok: true default: description: Typical error response content: application/json: schema: title: reminders.complete error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - not_found - cannot_complete_recurring - cannot_complete_others - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from reminders.complete method example: error: invalid_auth ok: false security: - slackAuth: - reminders:write summary: Slack Post Reminders Complete x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /reminders.delete: post: tags: - Post description: Deletes a reminder. externalDocs: description: API method documentation url: https://api.slack.com/methods/reminders.delete operationId: postRemindersDelete parameters: - name: token in: header description: 'Authentication token. Requires scope: `reminders:write`' schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: reminder: type: string description: The ID of the reminder application/json: schema: type: object properties: reminder: type: string description: The ID of the reminder responses: '200': description: Typical success response content: application/json: schema: title: reminders.delete schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from reminders.delete method example: ok: true default: description: Typical error response content: application/json: schema: title: reminders.delete error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - not_found - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from reminders.delete method example: error: invalid_auth ok: false security: - slackAuth: - reminders:write summary: Slack Post Reminders Delete x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /stars.add: post: tags: - Post description: Adds a star to an item. externalDocs: description: API method documentation url: https://api.slack.com/methods/stars.add operationId: postStarsAdd parameters: - name: token in: header description: 'Authentication token. Requires scope: `stars:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`). file: type: string description: File to add star to. file_comment: type: string description: File comment to add star to. timestamp: type: string description: Timestamp of the message to add star to. application/json: schema: type: object properties: channel: type: string description: Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`). file: type: string description: File to add star to. file_comment: type: string description: File comment to add star to. timestamp: type: string description: Timestamp of the message to add star to. responses: '200': description: Typical success response content: application/json: schema: title: stars.add schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from stars.add method example: ok: true default: description: Typical error response content: application/json: schema: title: stars.add error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - bad_timestamp - message_not_found - file_not_found - file_comment_not_found - channel_not_found - no_item_specified - already_starred - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from stars.add method example: error: invalid_auth ok: false security: - slackAuth: - stars:write summary: Slack Post Stars Add x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /stars.remove: post: tags: - Post description: Removes a star from an item. externalDocs: description: API method documentation url: https://api.slack.com/methods/stars.remove operationId: postStarsRemove parameters: - name: token in: header description: 'Authentication token. Requires scope: `stars:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: channel: type: string description: Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`). file: type: string description: File to remove star from. file_comment: type: string description: File comment to remove star from. timestamp: type: string description: Timestamp of the message to remove star from. application/json: schema: type: object properties: channel: type: string description: Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`). file: type: string description: File to remove star from. file_comment: type: string description: File comment to remove star from. timestamp: type: string description: Timestamp of the message to remove star from. responses: '200': description: Typical success response content: application/json: schema: title: stars.remove schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from stars.remove method example: ok: true default: description: Typical error response content: application/json: schema: title: stars.remove error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - bad_timestamp - message_not_found - file_not_found - file_comment_not_found - channel_not_found - no_item_specified - not_starred - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from stars.remove method example: error: invalid_auth ok: false security: - slackAuth: - stars:write summary: Slack Post Stars Remove x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /usergroups.create: post: tags: - Post description: Create a User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.create operationId: postUsergroupsCreate parameters: - name: token in: header description: 'Authentication token. Requires scope: `usergroups:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - name type: object properties: channels: type: string description: A comma separated string of encoded channel IDs for which the User Group uses as a default. description: type: string description: A short description of the User Group. handle: type: string description: A mention handle. Must be unique among channels, users and User Groups. include_count: type: boolean description: Include the number of users in each User Group. name: type: string description: A name for the User Group. Must be unique among User Groups. application/json: schema: required: - name type: object properties: channels: type: string description: A comma separated string of encoded channel IDs for which the User Group uses as a default. description: type: string description: A short description of the User Group. handle: type: string description: A mention handle. Must be unique among channels, users and User Groups. include_count: type: boolean description: Include the number of users in each User Group. name: type: string description: A name for the User Group. Must be unique among User Groups. required: true responses: '200': description: Typical success response content: application/json: schema: title: usergroups.create schema required: - ok - usergroup type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' usergroup: $ref: '#/components/schemas/objs_subteam' additionalProperties: false description: Schema for successful response from usergroups.create method example: ok: true default: description: Typical error response content: application/json: schema: title: usergroups.create error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from usergroups.create method example: error: invalid_auth ok: false security: - slackAuth: - usergroups:write summary: Slack Post User Groups Create x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /usergroups.disable: post: tags: - Post description: Disable an existing User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.disable operationId: postUsergroupsDisable parameters: - name: token in: header description: 'Authentication token. Requires scope: `usergroups:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - usergroup type: object properties: include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to disable. application/json: schema: required: - usergroup type: object properties: include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to disable. required: true responses: '200': description: Typical success response content: application/json: schema: title: usergroups.disable schema required: - ok - usergroup type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' usergroup: $ref: '#/components/schemas/objs_subteam' additionalProperties: false description: Schema for successful response from usergroups.disable method example: ok: true default: description: Typical error response content: application/json: schema: title: usergroups.disable error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from usergroups.disable method example: error: invalid_auth ok: false security: - slackAuth: - usergroups:write summary: Slack Post User Groups Disable x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /usergroups.enable: post: tags: - Post description: Enable a User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.enable operationId: postUsergroupsEnable parameters: - name: token in: header description: 'Authentication token. Requires scope: `usergroups:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - usergroup type: object properties: include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to enable. application/json: schema: required: - usergroup type: object properties: include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to enable. required: true responses: '200': description: Typical success response content: application/json: schema: title: usergroups.enable schema required: - ok - usergroup type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' usergroup: $ref: '#/components/schemas/objs_subteam' additionalProperties: false description: Schema for successful response from usergroups.enable method example: ok: true default: description: Typical error response content: application/json: schema: title: usergroups.enable error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from usergroups.enable method example: error: invalid_auth ok: false security: - slackAuth: - usergroups:write summary: Slack Post User Groups Enable x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /usergroups.update: post: tags: - Post description: Update an existing User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.update operationId: postUsergroupsUpdate parameters: - name: token in: header description: 'Authentication token. Requires scope: `usergroups:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - usergroup type: object properties: handle: type: string description: A mention handle. Must be unique among channels, users and User Groups. description: type: string description: A short description of the User Group. channels: type: string description: A comma separated string of encoded channel IDs for which the User Group uses as a default. include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to update. name: type: string description: A name for the User Group. Must be unique among User Groups. application/json: schema: required: - usergroup type: object properties: handle: type: string description: A mention handle. Must be unique among channels, users and User Groups. description: type: string description: A short description of the User Group. channels: type: string description: A comma separated string of encoded channel IDs for which the User Group uses as a default. include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to update. name: type: string description: A name for the User Group. Must be unique among User Groups. required: true responses: '200': description: Typical success response content: application/json: schema: title: usergroups.update schema required: - ok - usergroup type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' usergroup: $ref: '#/components/schemas/objs_subteam' additionalProperties: false description: Schema for successful response from usergroups.update method example: ok: true usergroup: auto_type: null created_by: U060R4BJ4 date_create: 1447096577 date_delete: 0 date_update: 1447102109 deleted_by: null description: Marketing gurus, PR experts and product advocates. handle: marketing-team id: S0616NG6M is_external: false is_usergroup: true name: Marketing Team prefs: channels: [] groups: [] team_id: T060R4BHN updated_by: U060R4BJ4 user_count: 1 users: - U060R4BJ4 - U060RNRCZ default: description: Typical error response content: application/json: schema: title: usergroups.update error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from usergroups.update method example: error: invalid_auth ok: false security: - slackAuth: - usergroups:write summary: Slack Post User Groups Update x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /usergroups.users.update: post: tags: - Post description: Update the list of users for a User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.users.update operationId: postUsergroupsUsersUpdate parameters: - name: token in: header description: 'Authentication token. Requires scope: `usergroups:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - usergroup - users type: object properties: include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to update. users: type: string description: A comma separated string of encoded user IDs that represent the entire list of users for the User Group. application/json: schema: required: - usergroup - users type: object properties: include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to update. users: type: string description: A comma separated string of encoded user IDs that represent the entire list of users for the User Group. required: true responses: '200': description: Typical success response content: application/json: schema: title: usergroups.users.update schema required: - ok - usergroup type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' usergroup: $ref: '#/components/schemas/objs_subteam' additionalProperties: false description: Schema for successful response from usergroups.users.update method example: ok: true usergroup: auto_type: null created_by: U060R4BJ4 date_create: 1447096577 date_delete: 0 date_update: 1447102109 deleted_by: null description: Marketing gurus, PR experts and product advocates. handle: marketing-team id: S0616NG6M is_external: false is_usergroup: true name: Marketing Team prefs: channels: [] groups: [] team_id: T060R4BHN updated_by: U060R4BJ4 user_count: 1 users: - U060R4BJ4 - U060RNRCZ default: description: Typical error response content: application/json: schema: title: usergroups.users.update error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from usergroups.users.update method example: error: invalid_auth ok: false security: - slackAuth: - usergroups:write summary: Slack Post User Groups Users Update x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.deletePhoto: post: tags: - Post description: Delete the user profile photo externalDocs: description: API method documentation url: https://api.slack.com/methods/users.deletePhoto operationId: postUsersDeletephoto requestBody: content: application/x-www-form-urlencoded: schema: required: - token type: object properties: token: type: string description: 'Authentication token. Requires scope: `users.profile:write`' required: true responses: '200': description: Typical success response content: application/json: schema: title: users.deletePhoto schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from users.deletePhoto method example: ok: true default: description: Typical error response content: application/json: schema: title: users.deletePhoto error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from users.deletePhoto method example: error: invalid_auth ok: false security: - slackAuth: - users.profile:write summary: Slack Post Users Deletephoto x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.profile.set: post: tags: - Post description: Set the profile information for a user. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.profile.set operationId: postUsersProfileSet parameters: - name: token in: header description: 'Authentication token. Requires scope: `users.profile:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: name: type: string description: Name of a single key to set. Usable only if `profile` is not passed. profile: type: string description: Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters. user: type: string description: ID of user to change. This argument may only be specified by team admins on paid teams. value: type: string description: Value to set a single key to. Usable only if `profile` is not passed. application/json: schema: type: object properties: name: type: string description: Name of a single key to set. Usable only if `profile` is not passed. profile: type: string description: Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters. user: type: string description: ID of user to change. This argument may only be specified by team admins on paid teams. value: type: string description: Value to set a single key to. Usable only if `profile` is not passed. responses: '200': description: Typical success response content: application/json: schema: title: users.profile.set schema required: - ok - profile - username type: object properties: email_pending: type: string format: email ok: $ref: '#/components/schemas/defs_ok_true' profile: $ref: '#/components/schemas/objs_user_profile' username: type: string additionalProperties: false description: Schema for successful response from users.profile.set method example: ok: true profile: avatar_hash: ge3b51ca72de display_name: spengler display_name_normalized: spengler email: spengler@ghostbusters.example.com image_192: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_24: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_32: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_48: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_512: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_72: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg real_name: Egon Spengler real_name_normalized: Egon Spengler status_emoji: ':books:' status_expiration: 0 status_text: Print is dead team: T012AB3C4 default: description: Typical error response content: application/json: schema: title: users.profile.set error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - reserved_name - invalid_profile - profile_set_failed - not_admin - not_app_admin - cannot_update_admin_user - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from users.profile.set method example: error: invalid_profile ok: false security: - slackAuth: - users.profile:write summary: Slack Post Users Profile Set x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.setActive: post: tags: - Post description: Marked a user as active. Deprecated and non-functional. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.setActive operationId: postUsersSetactive parameters: - name: token in: header description: 'Authentication token. Requires scope: `users:write`' required: true schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: users.setActive schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from users.setActive method example: ok: true default: description: Typical error response content: application/json: schema: title: users.setActive error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - ekm_access_denied - missing_scope - invalid_arguments - invalid_arg_name - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - request_timeout - fatal_error - internal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from users.setActive method example: error: invalid_auth ok: false security: - slackAuth: - users:write summary: Slack Post Users Setactive x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.setPhoto: post: tags: - Post description: Set the user profile photo externalDocs: description: API method documentation url: https://api.slack.com/methods/users.setPhoto operationId: postUsersSetphoto requestBody: content: application/x-www-form-urlencoded: schema: required: - token type: object properties: token: type: string description: 'Authentication token. Requires scope: `users.profile:write`' crop_w: type: string description: Width/height of crop box (always square) crop_x: type: string description: X coordinate of top-left corner of crop box crop_y: type: string description: Y coordinate of top-left corner of crop box image: type: string description: File contents via `multipart/form-data`. required: true responses: '200': description: Typical success response content: application/json: schema: title: users.setPhoto schema required: - ok - profile type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' profile: type: object additionalProperties: false additionalProperties: false description: Schema for successful response from users.setPhoto method example: ok: true default: description: Typical error response content: application/json: schema: title: users.setPhoto error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' debug_step: type: string description: possibly DEV/QA only dims: type: string description: possibly DEV/QA only error: type: string enum: - bad_image - too_large - too_many_frames - not_found - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' time_ident: type: integer description: possibly DEV/QA only additionalProperties: false description: Schema for error response from users.setPhoto method example: error: invalid_auth ok: false security: - slackAuth: - users.profile:write summary: Slack Post Users Setphoto x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.setPresence: post: tags: - Post description: Manually sets user presence. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.setPresence operationId: postUsersSetpresence parameters: - name: token in: header description: 'Authentication token. Requires scope: `users:write`' required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - presence type: object properties: presence: type: string description: Either `auto` or `away` application/json: schema: required: - presence type: object properties: presence: type: string description: Either `auto` or `away` required: true responses: '200': description: Typical success response content: application/json: schema: title: users.setPresence schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from users.setPresence method example: ok: true default: description: Typical error response content: application/json: schema: title: users.setPresence error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from users.setPresence method example: error: invalid_auth ok: false security: - slackAuth: - users:write summary: Slack Post Users Setpresence x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK