Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://slack.com/api
/admin.apps.approve
Approve an app for installation on a workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.apps:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminappsApproveAppInstallationRequest"
}
}
}
}
POST /admin.apps.approve
/admin.apps.restrict
Restrict an app for installation on a workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.apps:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminappsRestrictAppRequest"
}
}
}
}
POST /admin.apps.restrict
/admin.conversations.archive
Archive a public or private channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsArchiveChannelRequest"
}
}
},
"required": true
}
POST /admin.conversations.archive
/admin.conversations.convertToPrivate
Convert a public channel to a private channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsConvertToPrivateChannelRequest"
}
}
},
"required": true
}
POST /admin.conversations.convertToPrivate
/admin.conversations.create
Create a public or private channel-based conversation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsCreateChannelBasedConversationRequest"
}
}
},
"required": true
}
POST /admin.conversations.create
/admin.conversations.delete
Delete a public or private channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsDeleteChannelRequest"
}
}
},
"required": true
}
POST /admin.conversations.delete
/admin.conversations.disconnectShared
Disconnect a connected channel from one or more workspaces.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsDisconnectSharedChannelRequest"
}
}
},
"required": true
}
POST /admin.conversations.disconnectShared
/admin.conversations.invite
Invite a user to a public or private channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsInviteUserToChannelRequest"
}
}
},
"required": true
}
POST /admin.conversations.invite
/admin.conversations.rename
Rename a public or private channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsRenameChannelRequest"
}
}
},
"required": true
}
POST /admin.conversations.rename
/admin.conversations.setConversationPrefs
Set the posting permissions for a public or private channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsSetConversationPrefsRequest"
}
}
},
"required": true
}
POST /admin.conversations.setConversationPrefs
/admin.conversations.setTeams
Set the workspaces in an Enterprise grid org that connect to a public or private channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsSetTeamsWorkspaceConnectionRequest"
}
}
},
"required": true
}
POST /admin.conversations.setTeams
/admin.conversations.unarchive
Unarchive a public or private channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsUnarchiveChannelRequest"
}
}
},
"required": true
}
POST /admin.conversations.unarchive
/admin.conversations.restrictAccess.addGroup
Add an allowlist of IDP groups for accessing a channel
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsrestrictAccessAddGroupIdpGroupsRequest"
}
}
},
"required": true
}
POST /admin.conversations.restrictAccess.addGroup
/admin.conversations.restrictAccess.removeGroup
Remove a linked IDP group linked from a private channel
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminconversationsrestrictAccessRemoveIdpGroupRequest"
}
}
},
"required": true
}
POST /admin.conversations.restrictAccess.removeGroup
/admin.emoji.add
Add an emoji.
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminemojiAddEmojiRequest"
}
}
},
"required": true
}
POST /admin.emoji.add
/admin.emoji.addAlias
Add an emoji alias.
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminemojiAliasAddRequest"
}
}
},
"required": true
}
POST /admin.emoji.addAlias
/admin.emoji.remove
Remove an emoji across an Enterprise Grid organization
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminemojiRemoveEnterpriseEmojiRequest"
}
}
},
"required": true
}
POST /admin.emoji.remove
/admin.emoji.rename
Rename an emoji.
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminemojiRenameEmojiRequest"
}
}
},
"required": true
}
POST /admin.emoji.rename
/admin.inviteRequests.approve
Approve a workspace invite request.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.invites:write` |
{
"$ref": "#/components/requestBodies/admin_inviteRequests_approve"
}
POST /admin.inviteRequests.approve
/admin.inviteRequests.deny
Deny a workspace invite request.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.invites:write` |
{
"$ref": "#/components/requestBodies/admin_inviteRequests_approve"
}
POST /admin.inviteRequests.deny
/admin.teams.create
Create an Enterprise team.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.teams:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminteamsCreateEnterpriseTeamRequest"
}
}
},
"required": true
}
POST /admin.teams.create
/admin.teams.settings.setDefaultChannels
Set the default channels of a workspace.
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminteamssettingsSetDefaultChannelsRequest"
}
}
},
"required": true
}
POST /admin.teams.settings.setDefaultChannels
/admin.teams.settings.setDescription
Set the description of a given workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.teams:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminteamssettingsSetDescriptionRequest"
}
}
},
"required": true
}
POST /admin.teams.settings.setDescription
/admin.teams.settings.setDiscoverability
An API method that allows admins to set the discoverability of a given workspace
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.teams:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminteamssettingsSetDiscoverabilityOfWorkspaceRequest"
}
}
},
"required": true
}
POST /admin.teams.settings.setDiscoverability
/admin.teams.settings.setIcon
Sets the icon of a workspace.
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminteamssettingsSetIconRequest"
}
}
},
"required": true
}
POST /admin.teams.settings.setIcon
/admin.teams.settings.setName
Set the name of a given workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.teams:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminteamssettingsSetNameRequest"
}
}
},
"required": true
}
POST /admin.teams.settings.setName
/admin.usergroups.addChannels
Add one or more default channels to an IDP group.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.usergroups:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminusergroupsAddDefaultChannelsRequest"
}
}
},
"required": true
}
POST /admin.usergroups.addChannels
/admin.usergroups.addTeams
Associate one or more default workspaces with an organization-wide IDP group.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.teams:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminusergroupsAssociateDefaultWorkspacesRequest"
}
}
},
"required": true
}
POST /admin.usergroups.addTeams
/admin.usergroups.removeChannels
Remove one or more default channels from an org-level IDP group (user group).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.usergroups:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminusergroupsRemoveChannelsRequest"
}
}
},
"required": true
}
POST /admin.usergroups.removeChannels
/admin.users.assign
Add an Enterprise user to a workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.users:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminusersAddWorkspaceUserRequest"
}
}
},
"required": true
}
POST /admin.users.assign
/admin.users.invite
Invite a user to a workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.users:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminusersInviteUserToWorkspaceRequest"
}
}
},
"required": true
}
POST /admin.users.invite
/admin.users.remove
Remove a user from a workspace.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.users:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminusersRemoveUserFromWorkspaceRequest"
}
}
},
"required": true
}
POST /admin.users.remove
/admin.users.setAdmin
Set an existing guest, regular user, or owner to be an admin user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.users:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminusersSetAdminUserRequest"
}
}
},
"required": true
}
POST /admin.users.setAdmin
/admin.users.setExpiration
Set an expiration for a guest user
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.users:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminusersSetExpirationGuestRequest"
}
}
},
"required": true
}
POST /admin.users.setExpiration
/admin.users.setOwner
Set an existing guest, regular user, or admin user to be a workspace owner.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.users:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminusersSetWorkspaceOwnerRequest"
}
}
},
"required": true
}
POST /admin.users.setOwner
/admin.users.setRegular
Set an existing guest user, admin user, or owner to be a regular user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.users:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminusersSetRegularUserRequest"
}
}
},
"required": true
}
POST /admin.users.setRegular
/admin.users.session.invalidate
Invalidate a single session for a user by session_id
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.users:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminuserssessionInvalidateSessionRequest"
}
}
},
"required": true
}
POST /admin.users.session.invalidate
/admin.users.session.reset
Wipes all valid sessions on all devices for a given user
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `admin.users:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AdminuserssessionResetSessionsRequest"
}
}
},
"required": true
}
POST /admin.users.session.reset
/calls.add
Registers a new Call.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `calls:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/CallsAddRequest"
}
}
},
"required": true
}
POST /calls.add
/calls.end
Ends a Call.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `calls:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/CallsEndRequest"
}
}
},
"required": true
}
POST /calls.end
/calls.update
Updates information about a Call.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `calls:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/CallsUpdateRequest"
}
}
},
"required": true
}
POST /calls.update
/calls.participants.add
Registers new participants added to a Call.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `calls:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/CallsparticipantsAddNewParticipantRequest"
}
}
},
"required": true
}
POST /calls.participants.add
/calls.participants.remove
Registers participants removed from a Call.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `calls:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/CallsparticipantsRegisterRemovedRequest"
}
}
},
"required": true
}
POST /calls.participants.remove
/chat.delete
Deletes a message.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `chat:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ChatDeleteRequest"
}
}
}
}
POST /chat.delete
/chat.deleteScheduledMessage
Deletes a pending scheduled message from the queue.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `chat:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ChatDeleteScheduledMessageRequest"
}
}
}
}
POST /chat.deleteScheduledMessage
/chat.meMessage
Share a me message into a channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `chat:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ChatMeMessageRequest"
}
}
}
}
POST /chat.meMessage
/chat.postEphemeral
Sends an ephemeral message to a user in a channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `chat:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ChatPostEphemeralRequest"
}
}
}
}
POST /chat.postEphemeral
/chat.postMessage
Sends a message to a channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `chat:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ChatPostMessageRequest"
}
}
}
}
POST /chat.postMessage
/chat.scheduleMessage
Schedules a message to be sent to a channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `chat:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ChatScheduleMessageRequest"
}
}
}
}
POST /chat.scheduleMessage
/chat.unfurl
Provide custom unfurl behavior for user-posted URLs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `links:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ChatUnfurlRequest"
}
}
},
"required": true
}
POST /chat.unfurl
/chat.update
Updates a message.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `chat:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ChatUpdateRequest"
}
}
}
}
POST /chat.update
/conversations.archive
Archives a conversation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsArchiveRequest"
}
}
}
}
POST /conversations.archive
/conversations.close
Closes a direct message or multi-person direct message.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsCloseRequest"
}
}
}
}
POST /conversations.close
/conversations.create
Initiates a public or private channel-based conversation
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsCreateRequest"
}
}
}
}
POST /conversations.create
/conversations.invite
Invites users to a channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsInviteRequest"
}
}
}
}
POST /conversations.invite
/conversations.join
Joins an existing conversation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `channels:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsJoinRequest"
}
}
}
}
POST /conversations.join
/conversations.kick
Removes a user from a conversation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsKickRequest"
}
}
}
}
POST /conversations.kick
/conversations.leave
Leaves a conversation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsLeaveRequest"
}
}
}
}
POST /conversations.leave
/conversations.mark
Sets the read cursor in a channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsMarkRequest"
}
}
}
}
POST /conversations.mark
/conversations.open
Opens or resumes a direct message or multi-person direct message.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsOpenRequest"
}
}
}
}
POST /conversations.open
/conversations.rename
Renames a conversation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsRenameRequest"
}
}
}
}
POST /conversations.rename
/conversations.setPurpose
Sets the purpose for a conversation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsSetPurposeRequest"
}
}
}
}
POST /conversations.setPurpose
/conversations.setTopic
Sets the topic for a conversation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsSetTopicRequest"
}
}
}
}
POST /conversations.setTopic
/conversations.unarchive
Reverses conversation archival.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `conversations:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ConversationsUnarchiveRequest"
}
}
}
}
POST /conversations.unarchive
/dnd.endDnd
Ends the current user's Do Not Disturb session immediately.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `dnd:write` |
POST /dnd.endDnd
/dnd.endSnooze
Ends the current user's snooze mode immediately.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `dnd:write` |
POST /dnd.endSnooze
/dnd.setSnooze
Turns on Do Not Disturb mode for the current user, or changes its duration.
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DndSetSnoozeRequest"
}
}
},
"required": true
}
POST /dnd.setSnooze
/files.delete
Deletes a file.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `files:write:user` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FilesDeleteRequest"
}
}
}
}
POST /files.delete
/files.revokePublicURL
Revokes public/external sharing access for a file
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `files:write:user` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FilesRevokePublicUrlRequest"
}
}
}
}
POST /files.revokePublicURL
/files.sharedPublicURL
Enables a file for public/external sharing.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `files:write:user` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FilesSharedPublicUrlRequest"
}
}
}
}
POST /files.sharedPublicURL
/files.upload
Uploads or creates a file.
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FilesUploadRequest"
}
}
}
}
POST /files.upload
/files.comments.delete
Deletes an existing comment on a file.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `files:write:user` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FilescommentsDeleteCommentRequest"
}
}
}
}
POST /files.comments.delete
/files.remote.add
Adds a file from a remote service
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FilesremoteAddFromRemoteRequest"
}
}
}
}
POST /files.remote.add
/files.remote.remove
Remove a remote file.
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FilesremoteDeleteFileRequest"
}
}
}
}
POST /files.remote.remove
/files.remote.update
Updates an existing remote file.
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FilesremoteUpdateRemoteFileRequest"
}
}
}
}
POST /files.remote.update
/pins.add
Pins an item to a channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `pins:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PinsAddRequest"
}
}
},
"required": true
}
POST /pins.add
/pins.remove
Un-pins an item from a channel.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `pins:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PinsRemoveRequest"
}
}
},
"required": true
}
POST /pins.remove
/reactions.add
Adds a reaction to an item.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `reactions:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ReactionsAddRequest"
}
}
},
"required": true
}
POST /reactions.add
/reactions.remove
Removes a reaction from an item.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `reactions:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ReactionsRemoveRequest"
}
}
},
"required": true
}
POST /reactions.remove
/reminders.add
Creates a reminder.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `reminders:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/RemindersAddRequest"
}
}
},
"required": true
}
POST /reminders.add
/reminders.complete
Marks a reminder as complete.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `reminders:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/RemindersCompleteRequest"
}
}
}
}
POST /reminders.complete
/reminders.delete
Deletes a reminder.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | optional | string | Authentication token. Requires scope: `reminders:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/RemindersDeleteRequest"
}
}
}
}
POST /reminders.delete
/stars.add
Adds a star to an item.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `stars:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/StarsAddRequest"
}
}
}
}
POST /stars.add
/stars.remove
Removes a star from an item.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `stars:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/StarsRemoveRequest"
}
}
}
}
POST /stars.remove
/usergroups.create
Create a User Group
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `usergroups:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UsergroupsCreateRequest"
}
}
}
}
POST /usergroups.create
/usergroups.disable
Disable an existing User Group
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `usergroups:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UsergroupsDisableRequest"
}
}
}
}
POST /usergroups.disable
/usergroups.enable
Enable a User Group
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `usergroups:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UsergroupsEnableRequest"
}
}
}
}
POST /usergroups.enable
/usergroups.update
Update an existing User Group
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `usergroups:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UsergroupsUpdateRequest"
}
}
}
}
POST /usergroups.update
/usergroups.users.update
Update the list of users for a User Group
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `usergroups:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UsergroupsusersUpdateListRequest"
}
}
}
}
POST /usergroups.users.update
/users.deletePhoto
Delete the user profile photo
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UsersDeletePhotoRequest"
}
}
},
"required": true
}
POST /users.deletePhoto
/users.setActive
Marked a user as active. Deprecated and non-functional.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `users:write` |
POST /users.setActive
/users.setPhoto
Set the user profile photo
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UsersSetPhotoRequest"
}
}
},
"required": true
}
POST /users.setPhoto
/users.setPresence
Manually sets user presence.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `users:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UsersSetPresenceRequest"
}
}
},
"required": true
}
POST /users.setPresence
/users.profile.set
Set the profile information for a user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token | header | required | string | Authentication token. Requires scope: `users.profile:write` |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UsersprofileSetProfileInfoRequest"
}
}
}
}
POST /users.profile.set
AdminappsApproveAppInstallationRequest
{
"type": "object",
"properties": {
"app_id": {
"type": "string",
"description": "The id of the app to approve."
},
"team_id": {
"type": "string"
},
"request_id": {
"type": "string",
"description": "The id of the request to approve."
}
}
}
AdminappsApproveAppInstallationResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminappsApproveAppInstallationdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminappsRestrictAppRequest
{
"type": "object",
"properties": {
"app_id": {
"type": "string",
"description": "The id of the app to restrict."
},
"team_id": {
"type": "string"
},
"request_id": {
"type": "string",
"description": "The id of the request to restrict."
}
}
}
AdminappsRestrictAppResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminappsRestrictAppdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminappsapprovedListResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminappsapprovedListdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminappsrequestsListResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminappsrequestsListdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminappsrestrictedGetListResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminappsrestrictedGetListdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminconversationsArchiveChannelRequest
{
"type": "object",
"required": [
"channel_id"
],
"properties": {
"channel_id": {
"type": "string",
"description": "The channel to archive."
}
}
}
AdminconversationsArchiveChannelResponse
{
"type": "object",
"title": "admin.conversations.archive schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response of admin.conversations.archive"
}
AdminconversationsArchiveChanneldefaultResponse
{
"type": "object",
"title": "admin.conversations.archive error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"channel_not_found",
"channel_type_not_supported",
"default_org_wide_channel",
"already_archived",
"cant_archive_general",
"restricted_action",
"could_not_archive_channel"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.archive"
}
AdminconversationsConvertToPrivateChannelRequest
{
"type": "object",
"required": [
"channel_id"
],
"properties": {
"channel_id": {
"type": "string",
"description": "The channel to convert to private."
}
}
}
AdminconversationsConvertToPrivateChannelResponse
{
"type": "object",
"title": "admin.conversations.convertToPrivate schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response of admin.conversations.convertToPrivate"
}
AdminconversationsConvertToPrivateChanneldefaultResponse
{
"type": "object",
"title": "admin.conversations.convertToPrivate error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"restricted_action",
"name_taken",
"channel_not_found",
"channel_type_not_supported",
"default_org_wide_channel",
"method_not_supported_for_channel_type",
"could_not_convert_channel",
"external_channel_migrating"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.convertToPrivate"
}
AdminconversationsCreateChannelBasedConversationRequest
{
"type": "object",
"required": [
"name",
"is_private"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the public or private channel to create."
},
"team_id": {
"type": "string",
"description": "The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`."
},
"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"
},
"is_private": {
"type": "boolean",
"description": "When `true`, creates a private channel instead of a public channel"
},
"description": {
"type": "string",
"description": "Description of the public or private channel to create."
}
}
}
AdminconversationsCreateChannelBasedConversationResponse
{
"type": "object",
"title": "admin.conversations.create schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channel_id": {
"$ref": "#/components/schemas/defs_channel_id"
}
},
"description": "Schema for successful response of admin.conversations.create"
}
AdminconversationsCreateChannelBasedConversationdefaultResponse
{
"type": "object",
"title": "admin.conversations.create error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"name_taken",
"restricted_action",
"team_not_found",
"invalid_team",
"invalid_name",
"could_not_create_channel",
"team_id_or_org_required"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.create"
}
AdminconversationsDeleteChannelRequest
{
"type": "object",
"required": [
"channel_id"
],
"properties": {
"channel_id": {
"type": "string",
"description": "The channel to delete."
}
}
}
AdminconversationsDeleteChannelResponse
{
"type": "object",
"title": "admin.conversations.delete schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response of admin.conversations.delete"
}
AdminconversationsDeleteChanneldefaultResponse
{
"type": "object",
"title": "admin.conversations.delete error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"not_an_admin",
"channel_not_found",
"channel_type_not_supported",
"default_org_wide_channel",
"restricted_action",
"could_not_delete_channel",
"missing_scope"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.delete"
}
AdminconversationsDisconnectSharedChannelRequest
{
"type": "object",
"required": [
"channel_id"
],
"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."
}
}
}
AdminconversationsDisconnectSharedChannelResponse
{
"type": "object",
"title": "admin.conversations.rename schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response of admin.conversations.disconnectShared"
}
AdminconversationsDisconnectSharedChanneldefaultResponse
{
"type": "object",
"title": "admin.conversations.disconnectShared error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"not_an_admin",
"not_an_enterprise",
"channel_not_found",
"not_supported",
"team_not_found",
"restricted_action",
"missing_scope",
"leaving_team_not_in_channel",
"no_teams_to_disconnect",
"leaving_team_required",
"cannot_kick_team",
"cannot_kick_home_team"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.disconnectShared"
}
AdminconversationsGetConversationPrefsResponse
{
"type": "object",
"title": "admin.conversations.getConversationPrefs schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"prefs": {
"type": "object",
"properties": {
"can_thread": {
"type": "object",
"properties": {
"type": {
"type": "array",
"items": {
"type": "string"
}
},
"user": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"who_can_post": {
"type": "object",
"properties": {
"type": {
"type": "array",
"items": {
"type": "string"
}
},
"user": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"description": "Schema for successful response of admin.conversations.getConversationPrefs"
}
AdminconversationsGetConversationPrefsdefaultResponse
{
"type": "object",
"title": "admin.conversations.unarchive error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"not_an_admin",
"not_an_enterprise",
"restricted_action",
"missing_scope",
"channel_not_found",
"channel_type_not_supported",
"could_not_get_conversation_prefs"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.getConversationPrefs"
}
AdminconversationsGetTeamsListResponse
{
"type": "object",
"title": "admin.conversations.getTeams schema",
"required": [
"ok",
"team_ids"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"team_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
}
},
"response_metadata": {
"type": "object",
"required": [
"next_cursor"
],
"properties": {
"next_cursor": {
"type": "string"
}
}
}
},
"description": "Schema for successful response of admin.conversations.getTeams"
}
AdminconversationsGetTeamsListdefaultResponse
{
"type": "object",
"title": "admin.conversations.getTeams error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"channel_not_found",
"channel_type_not_supported",
"unsupported_team_type",
"restricted_action",
"could_not_get_teams",
"invalid_cursor",
"invalid_limit"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.getTeams"
}
AdminconversationsInviteUserToChannelRequest
{
"type": "object",
"required": [
"user_ids",
"channel_id"
],
"properties": {
"user_ids": {
"type": "string",
"description": "The users to invite."
},
"channel_id": {
"type": "string",
"description": "The channel that the users will be invited to."
}
}
}
AdminconversationsInviteUserToChannelResponse
{
"type": "object",
"title": "admin.conversations.invite schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response of admin.conversations.invite"
}
AdminconversationsInviteUserToChanneldefaultResponse
{
"type": "object",
"title": "admin.conversations.invite error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"channel_not_found",
"channel_type_not_supported",
"default_org_wide_channel",
"restricted_action",
"user_must_be_admin",
"failed_for_some_users"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.invite",
"additionalProperties": true
}
AdminconversationsRenameChannelRequest
{
"type": "object",
"required": [
"channel_id",
"name"
],
"properties": {
"name": {
"type": "string"
},
"channel_id": {
"type": "string",
"description": "The channel to rename."
}
}
}
AdminconversationsRenameChannelResponse
{
"type": "object",
"title": "admin.conversations.rename schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response of admin.conversations.rename"
}
AdminconversationsRenameChanneldefaultResponse
{
"type": "object",
"title": "admin.conversations.unarchive error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"channel_not_found",
"channel_type_not_supported",
"restricted_action",
"could_not_rename_channel",
"default_org_wide_channel",
"name_taken"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.rename"
}
AdminconversationsSearchChannelsResponse
{
"type": "object",
"title": "admin.conversations.search schema",
"required": [
"channels",
"next_cursor"
],
"properties": {
"channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_channel"
}
},
"next_cursor": {
"type": "string"
}
},
"description": "Schema for successful response of admin.conversations.search"
}
AdminconversationsSearchChannelsdefaultResponse
{
"type": "object",
"title": "admin.conversations.search error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"not_an_admin",
"not_an_enterprise",
"team_not_found",
"not_allowed",
"invalid_auth",
"invalid_cursor",
"invalid_search_channel_type",
"invalid_sort",
"invalid_sort_dir"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.search"
}
AdminconversationsSetConversationPrefsRequest
{
"type": "object",
"required": [
"channel_id",
"prefs"
],
"properties": {
"prefs": {
"type": "string",
"description": "The prefs for this channel in a stringified JSON format."
},
"channel_id": {
"type": "string",
"description": "The channel to set the prefs for"
}
}
}
AdminconversationsSetConversationPrefsResponse
{
"type": "object",
"title": "admin.conversations.setConversationPrefs schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response of admin.conversations.setConversationPrefs"
}
AdminconversationsSetConversationPrefsdefaultResponse
{
"type": "object",
"title": "admin.conversations.setConversationPrefs error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"not_an_admin",
"channel_not_found",
"channel_type_not_supported",
"restricted_action",
"missing_scope",
"could_not_set_channel_pref",
"default_org_wide_channel"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.setConversationPrefs"
}
AdminconversationsSetTeamsWorkspaceConnectionRequest
{
"type": "object",
"required": [
"channel_id"
],
"properties": {
"team_id": {
"type": "string",
"description": "The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel."
},
"channel_id": {
"type": "string",
"description": "The encoded `channel_id` to add or remove to workspaces."
},
"org_channel": {
"type": "boolean",
"description": "True if channel has to be converted to an org 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."
}
}
}
AdminconversationsSetTeamsWorkspaceConnectionResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminconversationsSetTeamsWorkspaceConnectiondefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminconversationsUnarchiveChannelRequest
{
"type": "object",
"required": [
"channel_id"
],
"properties": {
"channel_id": {
"type": "string",
"description": "The channel to unarchive."
}
}
}
AdminconversationsUnarchiveChannelResponse
{
"type": "object",
"title": "admin.conversations.unarchive schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response of admin.conversations.unarchive"
}
AdminconversationsUnarchiveChanneldefaultResponse
{
"type": "object",
"title": "admin.conversations.unarchive error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"feature_not_enabled",
"channel_not_found",
"channel_not_archived",
"channel_type_not_supported",
"restricted_action",
"could_not_unarchive_channel",
"default_org_wide_channel",
"missing_scope"
],
"type": "string"
}
},
"description": "Schema for error response from admin.conversations.unarchive"
}
AdminconversationsekmListOriginalConnectedChannelInfoResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminconversationsekmListOriginalConnectedChannelInfodefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminconversationsrestrictAccessAddGroupIdpGroupsRequest
{
"type": "object",
"required": [
"token",
"group_id",
"channel_id"
],
"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."
}
}
}
AdminconversationsrestrictAccessAddGroupIdpGroupsResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminconversationsrestrictAccessAddGroupIdpGroupsdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminconversationsrestrictAccessListGroupsResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminconversationsrestrictAccessListGroupsdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminconversationsrestrictAccessRemoveIdpGroupRequest
{
"type": "object",
"required": [
"token",
"team_id",
"group_id",
"channel_id"
],
"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."
}
}
}
AdminconversationsrestrictAccessRemoveIdpGroupResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminconversationsrestrictAccessRemoveIdpGroupdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminemojiAddEmojiRequest
{
"type": "object",
"required": [
"token",
"name",
"url"
],
"properties": {
"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."
},
"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."
},
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `admin.teams:write`"
}
}
}
AdminemojiAddEmojiResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminemojiAddEmojidefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminemojiAliasAddRequest
{
"type": "object",
"required": [
"token",
"name",
"alias_for"
],
"properties": {
"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."
},
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `admin.teams:write`"
},
"alias_for": {
"type": "string",
"description": "The alias of the emoji."
}
}
}
AdminemojiAliasAddResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminemojiAliasAdddefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminemojiListEnterpriseEmojiResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminemojiListEnterpriseEmojidefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminemojiRemoveEnterpriseEmojiRequest
{
"type": "object",
"required": [
"token",
"name"
],
"properties": {
"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."
},
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `admin.teams:write`"
}
}
}
AdminemojiRemoveEnterpriseEmojiResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminemojiRemoveEnterpriseEmojidefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminemojiRenameEmojiRequest
{
"type": "object",
"required": [
"token",
"name",
"new_name"
],
"properties": {
"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."
},
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `admin.teams:write`"
},
"new_name": {
"type": "string",
"description": "The new name of the emoji."
}
}
}
AdminemojiRenameEmojiResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminemojiRenameEmojidefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdmininviteRequestsApproveRequestRequest
{
"type": "object",
"required": [
"invite_request_id"
],
"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."
}
}
}
AdmininviteRequestsApproveRequestResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdmininviteRequestsApproveRequestdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdmininviteRequestsDenyRequestResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdmininviteRequestsDenyRequestdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdmininviteRequestsListPendingWorkspaceInviteRequestsResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdmininviteRequestsListPendingWorkspaceInviteRequestsdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdmininviteRequestsapprovedListResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdmininviteRequestsapprovedListdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdmininviteRequestsdeniedListResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdmininviteRequestsdeniedListdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamsCreateEnterpriseTeamRequest
{
"type": "object",
"required": [
"team_domain",
"team_name"
],
"properties": {
"team_name": {
"type": "string",
"description": "Team name (for example, Slack Softball Team)."
},
"team_domain": {
"type": "string",
"description": "Team domain (for example, slacksoftballteam)."
},
"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`."
}
}
}
AdminteamsCreateEnterpriseTeamResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamsCreateEnterpriseTeamdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamsListAllResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamsListAlldefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamsadminsGetAllResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamsadminsGetAlldefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamsownersListOwnersResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamsownersListOwnersdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsGetInfoResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsGetInfodefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsSetDefaultChannelsRequest
{
"type": "object",
"required": [
"token",
"team_id",
"channel_ids"
],
"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."
}
}
}
AdminteamssettingsSetDefaultChannelsResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsSetDefaultChannelsdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsSetDescriptionRequest
{
"type": "object",
"required": [
"team_id",
"description"
],
"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."
}
}
}
AdminteamssettingsSetDescriptionResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsSetDescriptiondefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsSetDiscoverabilityOfWorkspaceRequest
{
"type": "object",
"required": [
"team_id",
"discoverability"
],
"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`."
}
}
}
AdminteamssettingsSetDiscoverabilityOfWorkspaceResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsSetDiscoverabilityOfWorkspacedefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsSetIconRequest
{
"type": "object",
"required": [
"token",
"image_url",
"team_id"
],
"properties": {
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `admin.teams:write`"
},
"team_id": {
"type": "string",
"description": "ID for the workspace to set the icon for."
},
"image_url": {
"type": "string",
"description": "Image URL for the icon"
}
}
}
AdminteamssettingsSetIconResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsSetIcondefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsSetNameRequest
{
"type": "object",
"required": [
"team_id",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The new name of the workspace."
},
"team_id": {
"type": "string",
"description": "ID for the workspace to set the name for."
}
}
}
AdminteamssettingsSetNameResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminteamssettingsSetNamedefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusergroupsAddDefaultChannelsRequest
{
"type": "object",
"required": [
"usergroup_id",
"channel_ids"
],
"properties": {
"team_id": {
"type": "string",
"description": "The workspace to add default channels in."
},
"channel_ids": {
"type": "string",
"description": "Comma separated string of channel IDs."
},
"usergroup_id": {
"type": "string",
"description": "ID of the IDP group to add default channels for."
}
}
}
AdminusergroupsAddDefaultChannelsResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusergroupsAddDefaultChannelsdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusergroupsAssociateDefaultWorkspacesRequest
{
"type": "object",
"required": [
"usergroup_id",
"team_ids"
],
"properties": {
"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."
},
"usergroup_id": {
"type": "string",
"description": "An encoded usergroup (IDP Group) ID."
},
"auto_provision": {
"type": "boolean",
"description": "When `true`, this method automatically creates new workspace accounts for the IDP group members."
}
}
}
AdminusergroupsAssociateDefaultWorkspacesResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusergroupsAssociateDefaultWorkspacesdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusergroupsListChannelsGetResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusergroupsListChannelsGetdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusergroupsRemoveChannelsRequest
{
"type": "object",
"required": [
"usergroup_id",
"channel_ids"
],
"properties": {
"channel_ids": {
"type": "string",
"description": "Comma-separated string of channel IDs"
},
"usergroup_id": {
"type": "string",
"description": "ID of the IDP Group"
}
}
}
AdminusergroupsRemoveChannelsResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusergroupsRemoveChannelsdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersAddWorkspaceUserRequest
{
"type": "object",
"required": [
"team_id",
"user_id"
],
"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."
},
"channel_ids": {
"type": "string",
"description": "Comma separated values of channel IDs to add user in the new 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."
}
}
}
AdminusersAddWorkspaceUserResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersAddWorkspaceUserdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersInviteUserToWorkspaceRequest
{
"type": "object",
"required": [
"team_id",
"email",
"channel_ids"
],
"properties": {
"email": {
"type": "string",
"description": "The email address of the person to invite."
},
"resend": {
"type": "boolean",
"description": "Allow this invite to be resent in the future if a user has not signed up yet. (default: false)"
},
"team_id": {
"type": "string",
"description": "The ID (`T1234`) of the workspace."
},
"real_name": {
"type": "string",
"description": "Full name of the user."
},
"channel_ids": {
"type": "string",
"description": "A comma-separated list of `channel_id`s for this user to join. At least one channel is required."
},
"is_restricted": {
"type": "boolean",
"description": "Is this user a multi-channel guest user? (default: false)"
},
"custom_message": {
"type": "string",
"description": "An optional message to send to the user in the invite email."
},
"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."
},
"is_ultra_restricted": {
"type": "boolean",
"description": "Is this user a single channel guest user? (default: false)"
}
}
}
AdminusersInviteUserToWorkspaceResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersInviteUserToWorkspacedefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersListWorkspaceUsersResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersListWorkspaceUsersdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersRemoveUserFromWorkspaceRequest
{
"type": "object",
"required": [
"team_id",
"user_id"
],
"properties": {
"team_id": {
"type": "string",
"description": "The ID (`T1234`) of the workspace."
},
"user_id": {
"type": "string",
"description": "The ID of the user to remove."
}
}
}
AdminusersRemoveUserFromWorkspaceResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersRemoveUserFromWorkspacedefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersSetAdminUserRequest
{
"type": "object",
"required": [
"team_id",
"user_id"
],
"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."
}
}
}
AdminusersSetAdminUserResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersSetAdminUserdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersSetExpirationGuestRequest
{
"type": "object",
"required": [
"team_id",
"user_id",
"expiration_ts"
],
"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."
}
}
}
AdminusersSetExpirationGuestResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersSetExpirationGuestdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersSetRegularUserRequest
{
"type": "object",
"required": [
"team_id",
"user_id"
],
"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."
}
}
}
AdminusersSetRegularUserResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersSetRegularUserdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersSetWorkspaceOwnerRequest
{
"type": "object",
"required": [
"team_id",
"user_id"
],
"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."
}
}
}
AdminusersSetWorkspaceOwnerResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminusersSetWorkspaceOwnerdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminuserssessionInvalidateSessionRequest
{
"type": "object",
"required": [
"team_id",
"session_id"
],
"properties": {
"team_id": {
"type": "string",
"description": "ID of the team that the session belongs to"
},
"session_id": {
"type": "integer"
}
}
}
AdminuserssessionInvalidateSessionResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminuserssessionInvalidateSessiondefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminuserssessionResetSessionsRequest
{
"type": "object",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "string",
"description": "The ID of the user to wipe sessions for"
},
"web_only": {
"type": "boolean",
"description": "Only expire web sessions (default: false)"
},
"mobile_only": {
"type": "boolean",
"description": "Only expire mobile sessions (default: false)"
}
}
}
AdminuserssessionResetSessionsResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AdminuserssessionResetSessionsdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
ApiTestResponse
{
"type": "object",
"title": "api.test success schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response api.test method",
"additionalProperties": {
"type": "object"
}
}
ApiTestdefaultResponse
{
"type": "object",
"title": "api.test error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"type": "string"
}
},
"description": "Schema for error response api.test method",
"additionalProperties": {
"type": "object"
}
}
AppsUninstallResponse
{
"type": "object",
"title": "apps.uninstall schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from apps.uninstall method"
}
AppsUninstalldefaultResponse
{
"type": "object",
"title": "apps.uninstall error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"invalid_client_id",
"bad_client_secret",
"client_id_token_mismatch",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from apps.uninstall method"
}
AppseventauthorizationsGetListResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AppseventauthorizationsGetListdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AppspermissionsAdditionalScopesRequestResponse
{
"type": "object",
"title": "apps.permissions.request schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from apps.permissions.request method"
}
AppspermissionsAdditionalScopesRequestdefaultResponse
{
"type": "object",
"title": "apps.permissions.request error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"invalid_trigger",
"trigger_exchanged",
"invalid_scope",
"invalid_user",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from apps.permissions.request method"
}
AppspermissionsListPermissionsResponse
{
"type": "object",
"title": "apps.permissions.info schema",
"required": [
"ok",
"info"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"info": {
"type": "object",
"required": [
"team",
"channel",
"group",
"mpim",
"im",
"app_home"
],
"properties": {
"im": {
"type": "object",
"properties": {
"scopes": {
"$ref": "#/components/schemas/objs_scopes"
},
"resources": {
"$ref": "#/components/schemas/objs_resources"
}
}
},
"mpim": {
"type": "object",
"properties": {
"scopes": {
"$ref": "#/components/schemas/objs_scopes"
},
"resources": {
"$ref": "#/components/schemas/objs_resources"
}
}
},
"team": {
"type": "object",
"required": [
"scopes",
"resources"
],
"properties": {
"scopes": {
"$ref": "#/components/schemas/objs_scopes"
},
"resources": {
"$ref": "#/components/schemas/objs_resources"
}
}
},
"group": {
"type": "object",
"properties": {
"scopes": {
"$ref": "#/components/schemas/objs_scopes"
},
"resources": {
"$ref": "#/components/schemas/objs_resources"
}
}
},
"channel": {
"type": "object",
"properties": {
"scopes": {
"$ref": "#/components/schemas/objs_scopes"
},
"resources": {
"$ref": "#/components/schemas/objs_resources"
}
}
},
"app_home": {
"type": "object",
"properties": {
"scopes": {
"$ref": "#/components/schemas/objs_scopes"
},
"resources": {
"$ref": "#/components/schemas/objs_resources"
}
}
}
}
}
},
"description": "Schema for successful response from apps.permissions.info method"
}
AppspermissionsListPermissionsdefaultResponse
{
"type": "object",
"title": "apps.permissions.info error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from apps.permissions.info method"
}
AppspermissionsresourcesGetResourcesListResponse
{
"type": "object",
"title": "apps.permissions.resources.list success schema",
"required": [
"ok",
"resources"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "An ID for a resource",
"x-examples": [
"T0DES3UAN",
"C0ABC1ABC"
]
},
"type": {
"type": "string",
"title": "The type of resource the `id` corresponds to",
"x-examples": [
"team",
"channel",
"mpim"
]
}
}
}
},
"response_metadata": {
"type": "object",
"required": [
"next_cursor"
],
"properties": {
"next_cursor": {
"type": "string",
"x-examples": [
"dGVhbTpDMUg5UkVTR0w="
]
}
}
}
},
"description": "Schema for successful response apps.permissions.resources.list method",
"additionalProperties": true
}
AppspermissionsresourcesGetResourcesListdefaultResponse
{
"type": "object",
"title": "apps.permissions.resources.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"invalid_cursor",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from apps.permissions.resources.list method"
}
AppspermissionsscopesGetListResponse
{
"type": "object",
"title": "api.permissions.scopes.list success schema",
"required": [
"ok",
"scopes"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"scopes": {
"type": "object",
"properties": {
"im": {
"$ref": "#/components/schemas/objs_scopes"
},
"mpim": {
"$ref": "#/components/schemas/objs_scopes"
},
"team": {
"$ref": "#/components/schemas/objs_scopes"
},
"user": {
"$ref": "#/components/schemas/objs_scopes"
},
"group": {
"$ref": "#/components/schemas/objs_scopes"
},
"channel": {
"$ref": "#/components/schemas/objs_scopes"
},
"app_home": {
"$ref": "#/components/schemas/objs_scopes"
}
},
"additionalProperties": true
}
},
"description": "Schema for successful response api.permissions.scopes.list method",
"additionalProperties": true
}
AppspermissionsscopesGetListdefaultResponse
{
"type": "object",
"title": "apps.permissions.scopes.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from apps.permissions.scopes.list method"
}
AppspermissionsusersListUserGrantsResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AppspermissionsusersListUserGrantsdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AppspermissionsusersRequestModalResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AppspermissionsusersRequestModaldefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
AuthRevokeResponse
{
"type": "object",
"title": "auth.revoke schema",
"required": [
"ok",
"revoked"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"revoked": {
"type": "boolean"
}
},
"description": "Schema for successful response from auth.revoke method"
}
AuthRevokedefaultResponse
{
"type": "object",
"title": "auth.revoke error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from auth.revoke method"
}
AuthTestResponse
{
"type": "object",
"title": "auth.test success schema",
"required": [
"ok",
"url",
"team",
"user",
"team_id",
"user_id"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"url": {
"type": "string"
},
"team": {
"type": "string"
},
"user": {
"type": "string"
},
"bot_id": {
"$ref": "#/components/schemas/defs_bot_id"
},
"team_id": {
"$ref": "#/components/schemas/defs_team"
},
"user_id": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_enterprise_install": {
"type": "boolean"
}
},
"description": "Schema for successful response auth.test method"
}
AuthTestdefaultResponse
{
"type": "object",
"title": "auth.test error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"token_revoked",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response auth.test method"
}
BotsInfoResponse
{
"type": "object",
"title": "bots.info schema",
"required": [
"ok",
"bot"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"bot": {
"type": "object",
"required": [
"id",
"deleted",
"name",
"updated",
"app_id",
"icons"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_bot_id"
},
"name": {
"type": "string"
},
"icons": {
"type": "object",
"required": [
"image_36",
"image_48",
"image_72"
],
"properties": {
"image_36": {
"type": "string",
"format": "uri"
},
"image_48": {
"type": "string",
"format": "uri"
},
"image_72": {
"type": "string",
"format": "uri"
}
}
},
"app_id": {
"$ref": "#/components/schemas/defs_app_id"
},
"deleted": {
"type": "boolean"
},
"updated": {
"type": "integer"
},
"user_id": {
"$ref": "#/components/schemas/defs_user_id"
}
}
}
},
"description": "Schema for successful response from bots.info method"
}
BotsInfodefaultResponse
{
"type": "object",
"title": "bots.info error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"bot_not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from bots.info method"
}
CallsAddRequest
{
"type": "object",
"required": [
"external_unique_id",
"join_url"
],
"properties": {
"title": {
"type": "string",
"description": "The name of the Call."
},
"users": {
"type": "string",
"description": "The list of users to register as participants in the Call. [Read more on how to specify users here](https://slack.dev)."
},
"join_url": {
"type": "string",
"description": "The URL required for a client to join 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."
},
"date_start": {
"type": "integer",
"description": "Call start time in UTC UNIX timestamp format"
},
"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."
},
"desktop_app_join_url": {
"type": "string",
"description": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL."
}
}
}
CallsAddResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsAdddefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsEndRequest
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "`id` returned when registering the call using the [`calls.add`](https://slack.dev) method."
},
"duration": {
"type": "integer",
"description": "Call duration in seconds"
}
}
}
CallsEndResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsEnddefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsInfoResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsInfodefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsUpdateRequest
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "`id` returned by the [`calls.add`](https://slack.dev) 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."
}
}
}
CallsUpdateResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsUpdatedefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsparticipantsAddNewParticipantRequest
{
"type": "object",
"required": [
"id",
"users"
],
"properties": {
"id": {
"type": "string",
"description": "`id` returned by the [`calls.add`](https://slack.dev) method."
},
"users": {
"type": "string",
"description": "The list of users to add as participants in the Call. [Read more on how to specify users here](https://slack.dev)."
}
}
}
CallsparticipantsAddNewParticipantResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsparticipantsAddNewParticipantdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsparticipantsRegisterRemovedRequest
{
"type": "object",
"required": [
"id",
"users"
],
"properties": {
"id": {
"type": "string",
"description": "`id` returned by the [`calls.add`](https://slack.dev) method."
},
"users": {
"type": "string",
"description": "The list of users to remove as participants in the Call. [Read more on how to specify users here](https://slack.dev)."
}
}
}
CallsparticipantsRegisterRemovedResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
CallsparticipantsRegisterRemoveddefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
ChatDeleteRequest
{
"type": "object",
"properties": {
"ts": {
"type": "number",
"description": "Timestamp of 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](https://slack.dev) 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": "Channel containing the message to be deleted."
}
}
}
ChatDeleteResponse
{
"type": "object",
"title": "chat.delete success schema",
"required": [
"ok",
"channel",
"ts"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"ts": {
"$ref": "#/components/schemas/defs_ts"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
}
},
"description": "Schema for successful response of chat.delete method"
}
ChatDeleteScheduledMessageRequest
{
"type": "object",
"required": [
"channel",
"scheduled_message_id"
],
"properties": {
"as_user": {
"type": "boolean",
"description": "Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](https://slack.dev) 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"
}
}
}
ChatDeleteScheduledMessageResponse
{
"type": "object",
"title": "chat.deleteScheduledMessage schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from chat.deleteScheduledMessage method"
}
ChatDeleteScheduledMessagedefaultResponse
{
"type": "object",
"title": "chat.deleteScheduledMessage error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"invalid_scheduled_message_id",
"channel_not_found",
"bad_token",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"ekm_access_denied",
"missing_scope",
"invalid_arguments",
"invalid_arg_name",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from chat.deleteScheduledMessage method"
}
ChatDeletedefaultResponse
{
"type": "object",
"title": "chat.delete error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"message_not_found",
"channel_not_found",
"cant_delete_message",
"compliance_exports_prevent_deletion",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from chat.delete method"
}
ChatGetPermalinkResponse
{
"type": "object",
"title": "chat.getPermalink success schema",
"required": [
"ok",
"channel",
"permalink"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
},
"permalink": {
"type": "string",
"format": "uri"
}
},
"description": "Schema for successful response chat.getPermalink"
}
ChatGetPermalinkdefaultResponse
{
"type": "object",
"title": "chat.getPermalink error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"channel_not_found",
"message_not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from chat.getPermalink method"
}
ChatMeMessageRequest
{
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Text of the message to send."
},
"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."
}
}
}
ChatMeMessageResponse
{
"type": "object",
"title": "chat.meMessage schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"ts": {
"$ref": "#/components/schemas/defs_ts"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
}
},
"description": "Schema for successful response from chat.meMessage method"
}
ChatMeMessagedefaultResponse
{
"type": "object",
"title": "chat.meMessage error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"channel_not_found",
"not_in_channel",
"is_archived",
"msg_too_long",
"no_text",
"rate_limited",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from chat.meMessage method"
}
ChatPostEphemeralRequest
{
"type": "object",
"required": [
"channel",
"user"
],
"properties": {
"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](https://slack.dev) for more detail."
},
"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."
},
"parse": {
"type": "string",
"description": "Change how messages are treated. Defaults to `none`. See [below](https://slack.dev)."
},
"blocks": {
"type": "string",
"description": "A JSON-based array of structured blocks, presented as a URL-encoded string."
},
"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."
},
"channel": {
"type": "string",
"description": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name."
},
"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](https://slack.dev) below."
},
"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](https://slack.dev) below."
},
"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."
},
"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](https://slack.dev) below."
},
"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."
}
}
}
ChatPostEphemeralResponse
{
"type": "object",
"title": "chat.postEphemeral success schema",
"required": [
"ok",
"message_ts"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"message_ts": {
"$ref": "#/components/schemas/defs_ts"
}
},
"description": "Schema for successful response from chat.postEphemeral method"
}
ChatPostEphemeraldefaultResponse
{
"type": "object",
"title": "chat.postEphemeral error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"channel_not_found",
"is_archived",
"msg_too_long",
"no_text",
"restricted_action",
"too_many_attachments",
"user_not_in_channel",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from chat.postEphemeral method"
}
ChatPostMessageRequest
{
"type": "object",
"required": [
"channel"
],
"properties": {
"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](https://slack.dev) for more detail."
},
"parse": {
"type": "string",
"description": "Change how messages are treated. Defaults to `none`. See [below](https://slack.dev)."
},
"blocks": {
"type": "string",
"description": "A JSON-based array of structured blocks, presented as a URL-encoded string."
},
"mrkdwn": {
"type": "boolean",
"description": "Disable Slack markup parsing by setting to `false`. Enabled by default."
},
"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](https://slack.dev) below."
},
"channel": {
"type": "string",
"description": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](https://slack.dev) for more details."
},
"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](https://slack.dev) below."
},
"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](https://slack.dev) below."
},
"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."
},
"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](https://slack.dev) below."
},
"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."
},
"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."
},
"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`."
}
}
}
ChatPostMessageResponse
{
"type": "object",
"title": "chat.postMessage success schema",
"required": [
"ok",
"channel",
"ts",
"message"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"ts": {
"$ref": "#/components/schemas/defs_ts"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
},
"message": {
"$ref": "#/components/schemas/objs_message"
}
},
"description": "Schema for successful response of chat.postMessage method"
}
ChatPostMessagedefaultResponse
{
"type": "object",
"title": "chat.postMessage error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"channel_not_found",
"not_in_channel",
"is_archived",
"msg_too_long",
"no_text",
"too_many_attachments",
"rate_limited",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response chat.postMessage method"
}
ChatScheduleMessageRequest
{
"type": "object",
"properties": {
"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](https://slack.dev) for more detail."
},
"parse": {
"type": "string",
"description": "Change how messages are treated. Defaults to `none`. See [chat.postMessage](chat.postMessage#formatting)."
},
"blocks": {
"type": "string",
"description": "A JSON-based array of structured blocks, presented as a URL-encoded string."
},
"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)."
},
"channel": {
"type": "string",
"description": "Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See [below](https://slack.dev) for more details."
},
"post_at": {
"type": "string",
"description": "Unix EPOCH timestamp of time in future to send the message."
},
"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."
},
"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."
},
"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."
},
"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`."
}
}
}
ChatScheduleMessageResponse
{
"type": "object",
"title": "chat.scheduleMessage success schema",
"required": [
"ok",
"channel",
"post_at",
"scheduled_message_id",
"message"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
},
"message": {
"type": "object",
"required": [
"type",
"text",
"bot_id",
"user",
"team"
],
"properties": {
"team": {
"$ref": "#/components/schemas/defs_team"
},
"text": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"bot_id": {
"$ref": "#/components/schemas/defs_bot_id"
},
"username": {
"type": "string"
},
"bot_profile": {
"$ref": "#/components/schemas/objs_bot_profile"
}
}
},
"post_at": {
"type": "integer",
"pattern": "^\\d{10}$"
},
"scheduled_message_id": {
"type": "string",
"title": "Scheduled Message ID",
"pattern": "^[Q][A-Z0-9]{8,}$"
}
},
"description": "Schema for successful response of chat.scheduleMessage method"
}
ChatScheduleMessagedefaultResponse
{
"type": "object",
"title": "chat.scheduleMessage error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"invalid_time",
"time_in_past",
"time_too_far",
"channel_not_found",
"not_in_channel",
"is_archived",
"msg_too_long",
"no_text",
"restricted_action",
"restricted_action_read_only_channel",
"restricted_action_thread_only_channel",
"restricted_action_non_threadable_channel",
"too_many_attachments",
"rate_limited",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"ekm_access_denied",
"missing_scope",
"invalid_arguments",
"invalid_arg_name",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response chat.scheduleMessage method"
}
ChatUnfurlRequest
{
"type": "object",
"required": [
"channel",
"ts"
],
"properties": {
"ts": {
"type": "string",
"description": "Timestamp of the message to add unfurl behavior to."
},
"channel": {
"type": "string",
"description": "Channel ID of the message"
},
"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_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."
},
"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"
}
}
}
ChatUnfurlResponse
{
"type": "object",
"title": "chat.unfurl success schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from chat.unfurl method"
}
ChatUnfurldefaultResponse
{
"type": "object",
"title": "chat.unfurl error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"cannot_unfurl_url",
"cannot_find_service",
"missing_unfurls",
"cannot_prompt",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from chat.unfurl method"
}
ChatUpdateRequest
{
"type": "object",
"required": [
"channel",
"ts"
],
"properties": {
"ts": {
"type": "string",
"description": "Timestamp of the message to be updated."
},
"text": {
"type": "string",
"description": "New text for the message, using the [default formatting rules](https://slack.dev). It's not required when presenting `blocks` or `attachments`."
},
"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`."
},
"blocks": {
"type": "string",
"description": "A JSON-based array of [structured blocks](https://slack.dev), 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."
},
"as_user": {
"type": "string",
"description": "Pass true to update the message as the authed user. [Bot users](https://slack.dev) in this context are considered authed users."
},
"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`."
},
"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."
}
}
}
ChatUpdateResponse
{
"type": "object",
"title": "chat.update success schema",
"required": [
"ok",
"channel",
"ts",
"text",
"message"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"ts": {
"type": "string"
},
"text": {
"type": "string"
},
"channel": {
"type": "string"
},
"message": {
"type": "object",
"title": "Message object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string"
},
"blocks": {
"type": "object"
},
"attachments": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"description": "Schema for successful response of chat.update method"
}
ChatUpdatedefaultResponse
{
"type": "object",
"title": "chat.update error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"message_not_found",
"cant_update_message",
"channel_not_found",
"edit_window_closed",
"msg_too_long",
"too_many_attachments",
"rate_limited",
"no_text",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"request_timeout",
"invalid_json",
"json_not_object",
"upgrade_required",
"fatal_error",
"is_inactive"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response chat.update method"
}
ChatscheduledMessagesListResponse
{
"type": "object",
"title": "chat.scheduledMessages.list schema",
"required": [
"ok",
"scheduled_messages",
"response_metadata"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"response_metadata": {
"type": "object",
"required": [
"next_cursor"
],
"properties": {
"next_cursor": {
"type": "string"
}
}
},
"scheduled_messages": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"channel_id",
"post_at",
"date_created"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[Q][A-Z0-9]{8,}$"
},
"text": {
"type": "string"
},
"post_at": {
"type": "integer",
"pattern": "^\\d{10}$"
},
"channel_id": {
"$ref": "#/components/schemas/defs_channel_id"
},
"date_created": {
"type": "integer",
"pattern": "^\\d{10}$"
}
}
}
}
},
"description": "Schema for successful response from chat.scheduledMessages.list method"
}
ChatscheduledMessagesListdefaultResponse
{
"type": "object",
"title": "chat.scheduledMessages.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"invalid_channel",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"ekm_access_denied",
"missing_scope",
"invalid_arguments",
"invalid_arg_name",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from chat.scheduledMessages.list method"
}
ConversationsArchiveRequest
{
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "ID of conversation to archive"
}
}
}
ConversationsArchiveResponse
{
"type": "object",
"title": "conversations.archive success schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response conversations.archive method"
}
ConversationsArchivedefaultResponse
{
"type": "object",
"title": "conversations.archive error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"not_supported",
"channel_not_found",
"already_archived",
"cant_archive_general",
"restricted_action",
"not_authed",
"invalid_auth",
"account_inactive",
"user_is_bot",
"user_is_restricted",
"user_is_ultra_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"team_added_to_org",
"missing_charset",
"superfluous_charset"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.archive method"
}
ConversationsCloseRequest
{
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Conversation to close."
}
}
}
ConversationsCloseResponse
{
"type": "object",
"title": "conversations.close success schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"no_op": {
"type": "boolean"
},
"already_closed": {
"type": "boolean"
}
},
"description": "Schema for successful response conversations.close method"
}
ConversationsClosedefaultResponse
{
"type": "object",
"title": "conversations.close error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"channel_not_found",
"user_does_not_own_channel",
"missing_scope",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.close method"
}
ConversationsCreateRequest
{
"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"
}
}
}
ConversationsCreateResponse
{
"type": "object",
"title": "conversations.create success schema",
"required": [
"ok",
"channel"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channel": {
"$ref": "#/components/schemas/objs_conversation"
}
},
"description": "Schema for successful response conversations.create method"
}
ConversationsCreatedefaultResponse
{
"type": "object",
"title": "conversations.create error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"name_taken",
"restricted_action",
"no_channel",
"invalid_name_required",
"invalid_name_punctuation",
"invalid_name_maxlength",
"invalid_name_specials",
"invalid_name",
"not_authed",
"invalid_auth",
"account_inactive",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"detail": {
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.create method"
}
ConversationsHistoryResponse
{
"type": "object",
"title": "conversations.history success schema",
"required": [
"ok",
"messages",
"has_more",
"pin_count",
"channel_actions_ts",
"channel_actions_count"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"has_more": {
"type": "boolean"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_message"
},
"minItems": 1,
"uniqueItems": true
},
"pin_count": {
"type": "integer"
},
"channel_actions_ts": {
"items": {
"anyOf": [
{
"type": "integer"
},
{
"nullable": true
}
]
}
},
"channel_actions_count": {
"type": "integer"
}
},
"description": "Schema for successful response from conversations.history method"
}
ConversationsHistorydefaultResponse
{
"type": "object",
"title": "conversations.history error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"missing_scope",
"channel_not_found",
"invalid_ts_latest",
"invalid_ts_oldest",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.history method"
}
ConversationsInfoResponse
{
"type": "object",
"title": "conversations.info success schema",
"required": [
"ok",
"channel"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channel": {
"$ref": "#/components/schemas/objs_conversation"
}
},
"description": "Schema for successful response conversations.info"
}
ConversationsInfodefaultResponse
{
"type": "object",
"title": "conversations.info error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"missing_scope",
"channel_not_found",
"team_added_to_org",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.info method"
}
ConversationsInviteRequest
{
"type": "object",
"properties": {
"users": {
"type": "string",
"description": "A comma separated list of user IDs. Up to 1000 users may be listed."
},
"channel": {
"type": "string",
"description": "The ID of the public or private channel to invite user(s) to."
}
}
}
ConversationsInviteResponse
{
"type": "object",
"title": "conversations.invite error schema",
"required": [
"ok",
"channel"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channel": {
"$ref": "#/components/schemas/objs_conversation"
}
},
"description": "Schema for successful response from conversations.invite method"
}
ConversationsInvitedefaultResponse
{
"type": "object",
"title": "conversations.invite error schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"channel_not_found",
"user_not_found",
"no_user",
"cant_invite_self",
"not_in_channel",
"already_in_channel",
"is_archived",
"cant_invite",
"too_many_users",
"ura_max_channels",
"not_authed",
"invalid_auth",
"account_inactive",
"user_is_bot",
"user_is_restricted",
"user_is_ultra_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"team_added_to_org",
"missing_charset",
"superfluous_charset"
],
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"channel_not_found",
"user_not_found",
"no_user",
"cant_invite_self",
"not_in_channel",
"already_in_channel",
"is_archived",
"cant_invite",
"too_many_users",
"ura_max_channels",
"not_authed",
"invalid_auth",
"account_inactive",
"user_is_bot",
"user_is_restricted",
"user_is_ultra_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"team_added_to_org",
"missing_charset",
"superfluous_charset"
],
"type": "string"
}
}
},
"title": "errors is returned when an error associates an user",
"minItems": 1,
"uniqueItems": true
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.invite method"
}
ConversationsJoinRequest
{
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "ID of conversation to join"
}
}
}
ConversationsJoinResponse
{
"type": "object",
"title": "conversations.join success schema",
"required": [
"ok",
"channel"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channel": {
"$ref": "#/components/schemas/objs_conversation"
},
"warning": {
"type": "string"
},
"response_metadata": {
"type": "object",
"title": "Response metadata",
"properties": {
"warnings": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
}
}
},
"description": "Schema for successful response from conversations.join method"
}
ConversationsJoindefaultResponse
{
"type": "object",
"title": "conversations.join error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"channel_not_found",
"is_archived",
"not_authed",
"invalid_auth",
"account_inactive",
"user_is_bot",
"user_is_restricted",
"user_is_ultra_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"team_added_to_org",
"missing_charset",
"superfluous_charset"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.join method"
}
ConversationsKickRequest
{
"type": "object",
"properties": {
"user": {
"type": "string",
"description": "User ID to be removed."
},
"channel": {
"type": "string",
"description": "ID of conversation to remove user from."
}
}
}
ConversationsKickResponse
{
"type": "object",
"title": "conversations.kick success schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response conversations.kick method"
}
ConversationsKickdefaultResponse
{
"type": "object",
"title": "conversations.kick error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"channel_not_found",
"user_not_found",
"cant_kick_self",
"not_in_channel",
"cant_kick_from_general",
"restricted_action",
"not_authed",
"invalid_auth",
"account_inactive",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response conversations.kick method"
}
ConversationsLeaveRequest
{
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Conversation to leave"
}
}
}
ConversationsLeaveResponse
{
"type": "object",
"title": "conversations.leave success schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"not_in_channel": {
"enum": [
true
],
"type": "boolean"
}
},
"description": "Schema for successful response from conversations.leave method"
}
ConversationsLeavedefaultResponse
{
"type": "object",
"title": "conversations.leave error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"last_member",
"missing_scope",
"channel_not_found",
"is_archived",
"cant_leave_general",
"not_authed",
"invalid_auth",
"account_inactive",
"user_is_bot",
"user_is_restricted",
"user_is_ultra_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"team_added_to_org",
"missing_charset",
"superfluous_charset"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.leave method"
}
ConversationsListResponse
{
"type": "object",
"title": "conversations.list success schema",
"required": [
"ok",
"channels"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_conversation"
},
"uniqueItems": true
},
"response_metadata": {
"type": "object",
"required": [
"next_cursor"
],
"properties": {
"next_cursor": {
"type": "string"
}
}
}
},
"description": "Schema for successful response from conversations.list method"
}
ConversationsListdefaultResponse
{
"type": "object",
"title": "conversations.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"missing_scope",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.list method"
}
ConversationsMarkRequest
{
"type": "object",
"properties": {
"ts": {
"type": "number",
"description": "Unique identifier of message you want marked as most recently seen in this conversation."
},
"channel": {
"type": "string",
"description": "Channel or conversation to set the read cursor for."
}
}
}
ConversationsMarkResponse
{
"type": "object",
"title": "conversations.mark success schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response conversations.mark method"
}
ConversationsMarkdefaultResponse
{
"type": "object",
"title": "conversations.mark error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"channel_not_found",
"invalid_timestamp",
"not_in_channel",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"not_allowed_token_type"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.mark method"
}
ConversationsMembersResponse
{
"type": "object",
"title": "conversations.members success schema",
"required": [
"ok",
"members",
"response_metadata"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_user_id"
},
"minItems": 1,
"uniqueItems": true
},
"response_metadata": {
"type": "object",
"required": [
"next_cursor"
],
"properties": {
"next_cursor": {
"type": "string"
}
}
}
},
"description": "Schema for successful response conversations.members method"
}
ConversationsMembersdefaultResponse
{
"type": "object",
"title": "conversations.members error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"channel_not_found",
"invalid_limit",
"invalid_cursor",
"fetch_members_failed",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response conversations.members method"
}
ConversationsOpenRequest
{
"type": "object",
"properties": {
"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`."
},
"channel": {
"type": "string",
"description": "Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead."
},
"return_im": {
"type": "boolean",
"description": "Boolean, indicates you want the full IM channel definition in the response."
}
}
}
ConversationsOpenResponse
{
"type": "object",
"title": "conversations.open success schema",
"required": [
"ok",
"channel"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"no_op": {
"type": "boolean"
},
"channel": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/objs_conversation"
},
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_dm_id"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_im": {
"type": "boolean"
},
"latest": {
"$ref": "#/components/schemas/objs_message"
},
"created": {
"type": "string"
},
"is_open": {
"type": "boolean"
},
"last_read": {
"$ref": "#/components/schemas/defs_ts"
},
"unread_count": {
"type": "number"
},
"unread_count_display": {
"type": "number"
}
}
}
]
}
},
"already_open": {
"type": "boolean"
}
},
"description": "Schema for successful response from conversations.open method when opening channels, ims, mpims"
}
ConversationsOpendefaultResponse
{
"type": "object",
"title": "conversations.open error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"user_not_found",
"user_not_visible",
"user_disabled",
"users_list_not_supplied",
"not_enough_users",
"too_many_users",
"invalid_user_combination",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"channel_not_found"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.open method"
}
ConversationsRenameRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "New name for conversation."
},
"channel": {
"type": "string",
"description": "ID of conversation to rename"
}
}
}
ConversationsRenameResponse
{
"type": "object",
"title": "conversations.rename success schema",
"required": [
"ok",
"channel"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channel": {
"$ref": "#/components/schemas/objs_conversation"
}
},
"description": "Schema for successful response from conversations.rename method"
}
ConversationsRenamedefaultResponse
{
"type": "object",
"title": "conversations.rename error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"user_is_restricted",
"method_not_supported_for_channel_type",
"missing_scope",
"channel_not_found",
"not_in_channel",
"not_authorized",
"invalid_name",
"name_taken",
"invalid_name_required",
"invalid_name_punctuation",
"invalid_name_maxlength",
"invalid_name_specials",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.rename method"
}
ConversationsRepliesResponse
{
"type": "object",
"title": "conversations.replies success schema",
"required": [
"ok",
"messages"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"has_more": {
"type": "boolean"
},
"messages": {
"type": "array",
"items": {
"items": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"user",
"text",
"thread_ts",
"reply_count",
"subscribed",
"ts"
],
"properties": {
"ts": {
"$ref": "#/components/schemas/defs_ts"
},
"team": {
"$ref": "#/components/schemas/defs_team"
},
"text": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"last_read": {
"$ref": "#/components/schemas/defs_ts"
},
"thread_ts": {
"$ref": "#/components/schemas/defs_ts"
},
"user_team": {
"$ref": "#/components/schemas/defs_team"
},
"subscribed": {
"type": "boolean"
},
"reply_count": {
"type": "integer"
},
"reply_users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_user_id"
},
"uniqueItems": true
},
"source_team": {
"$ref": "#/components/schemas/defs_team"
},
"latest_reply": {
"$ref": "#/components/schemas/defs_ts"
},
"unread_count": {
"type": "integer"
},
"user_profile": {
"$ref": "#/components/schemas/objs_user_profile_short"
},
"reply_users_count": {
"type": "integer"
}
}
},
{
"type": "object",
"required": [
"type",
"user",
"text",
"thread_ts",
"parent_user_id",
"ts"
],
"properties": {
"ts": {
"$ref": "#/components/schemas/defs_ts"
},
"team": {
"$ref": "#/components/schemas/defs_team"
},
"text": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"thread_ts": {
"$ref": "#/components/schemas/defs_ts"
},
"user_team": {
"$ref": "#/components/schemas/defs_team"
},
"is_starred": {
"type": "boolean"
},
"source_team": {
"$ref": "#/components/schemas/defs_team"
},
"user_profile": {
"$ref": "#/components/schemas/objs_user_profile_short"
},
"parent_user_id": {
"$ref": "#/components/schemas/defs_user_id"
}
}
}
]
}
}
}
},
"description": "Schema for successful response from conversations.replies method"
}
ConversationsRepliesdefaultResponse
{
"type": "object",
"title": "conversations.replies error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"missing_scope",
"channel_not_found",
"thread_not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.replies method"
}
ConversationsSetPurposeRequest
{
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "Conversation to set the purpose of"
},
"purpose": {
"type": "string",
"description": "A new, specialer purpose"
}
}
}
ConversationsSetPurposeResponse
{
"type": "object",
"title": "conversations.setPurpose success schema",
"required": [
"ok",
"channel"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channel": {
"$ref": "#/components/schemas/objs_conversation"
}
},
"description": "Schema for successful response from conversations.setPurpose method"
}
ConversationsSetPurposedefaultResponse
{
"type": "object",
"title": "conversations.setPurpose error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"channel_not_found",
"not_in_channel",
"is_archived",
"too_long",
"user_is_restricted",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.setPurpose method"
}
ConversationsSetTopicRequest
{
"type": "object",
"properties": {
"topic": {
"type": "string",
"description": "The new topic string. Does not support formatting or linkification."
},
"channel": {
"type": "string",
"description": "Conversation to set the topic of"
}
}
}
ConversationsSetTopicResponse
{
"type": "object",
"title": "conversations.setTopic success schema",
"required": [
"ok",
"channel"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channel": {
"$ref": "#/components/schemas/objs_conversation"
}
},
"description": "Schema for successful response from conversations.setTopic method"
}
ConversationsSetTopicdefaultResponse
{
"type": "object",
"title": "conversations.setTopic error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"channel_not_found",
"not_in_channel",
"is_archived",
"too_long",
"user_is_restricted",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.setTopic method"
}
ConversationsUnarchiveRequest
{
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "ID of conversation to unarchive"
}
}
}
ConversationsUnarchiveResponse
{
"type": "object",
"title": "conversations.unarchive success schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from conversations.unarchive method"
}
ConversationsUnarchivedefaultResponse
{
"type": "object",
"title": "conversations.unarchive error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"channel_not_found",
"not_archived",
"not_authed",
"invalid_auth",
"account_inactive",
"user_is_bot",
"user_is_restricted",
"user_is_ultra_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"team_added_to_org",
"missing_charset",
"superfluous_charset"
],
"type": "string"
},
"needed": {
"type": "string"
},
"provided": {
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from conversations.unarchive method"
}
DialogOpenResponse
{
"type": "object",
"title": "dialog.open schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from dialog.open method"
}
DialogOpendefaultResponse
{
"type": "object",
"title": "dialog.open error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"validation_errors",
"missing_trigger",
"missing_dialog",
"trigger_exchanged",
"trigger_expired",
"invalid_trigger",
"app_missing_action_url",
"cannot_create_dialog",
"failed_sending_dialog",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from dialog.open method"
}
DndEndDndResponse
{
"type": "object",
"title": "dnd.endDnd schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from dnd.endDnd method"
}
DndEndDnddefaultResponse
{
"type": "object",
"title": "dnd.endDnd error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"unknown_error",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from dnd.endDnd method"
}
DndEndSnoozeResponse
{
"type": "object",
"title": "dnd.endSnooze schema",
"required": [
"ok",
"dnd_enabled",
"next_dnd_start_ts",
"next_dnd_end_ts",
"snooze_enabled"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"dnd_enabled": {
"type": "boolean"
},
"snooze_enabled": {
"type": "boolean"
},
"next_dnd_end_ts": {
"type": "integer"
},
"next_dnd_start_ts": {
"type": "integer"
}
},
"description": "Schema for successful response from dnd.endSnooze method"
}
DndEndSnoozedefaultResponse
{
"type": "object",
"title": "dnd.endSnooze error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"snooze_not_active",
"snooze_end_failed",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from dnd.endSnooze method"
}
DndInfoResponse
{
"type": "object",
"title": "dnd.info schema",
"required": [
"ok",
"dnd_enabled",
"next_dnd_start_ts",
"next_dnd_end_ts"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"dnd_enabled": {
"type": "boolean"
},
"snooze_enabled": {
"type": "boolean"
},
"snooze_endtime": {
"type": "integer"
},
"next_dnd_end_ts": {
"type": "integer"
},
"snooze_remaining": {
"type": "integer"
},
"next_dnd_start_ts": {
"type": "integer"
}
},
"description": "Schema for successful response from dnd.info method"
}
DndInfodefaultResponse
{
"type": "object",
"title": "dnd.info error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"user_not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from dnd.info method"
}
DndSetSnoozeRequest
{
"type": "object",
"required": [
"token",
"num_minutes"
],
"properties": {
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `dnd:write`"
},
"num_minutes": {
"type": "string",
"description": "Number of minutes, from now, to snooze until."
}
}
}
DndSetSnoozeResponse
{
"type": "object",
"title": "dnd.setSnooze schema",
"required": [
"ok",
"snooze_enabled",
"snooze_endtime",
"snooze_remaining"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"snooze_enabled": {
"type": "boolean"
},
"snooze_endtime": {
"type": "integer"
},
"snooze_remaining": {
"type": "integer"
}
},
"description": "Schema for successful response from dnd.setSnooze method"
}
DndSetSnoozedefaultResponse
{
"type": "object",
"title": "dnd.setSnooze error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"missing_duration",
"snooze_failed",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"too_long",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from dnd.setSnooze method"
}
DndTeamInfoResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
DndTeamInfodefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
EmojiListResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
EmojiListdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesDeleteRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "ID of file to delete."
}
}
}
FilesDeleteResponse
{
"type": "object",
"title": "files.delete schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response files.delete method"
}
FilesDeletedefaultResponse
{
"type": "object",
"title": "files.delete error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"file_not_found",
"file_deleted",
"cant_delete_file",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response files.delete method"
}
FilesInfoResponse
{
"type": "object",
"title": "files.info schema",
"required": [
"ok",
"file",
"comments"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"file": {
"$ref": "#/components/schemas/objs_file"
},
"editor": {
"$ref": "#/components/schemas/defs_user_id"
},
"paging": {
"$ref": "#/components/schemas/objs_paging"
},
"comments": {
"$ref": "#/components/schemas/objs_comments"
},
"content_html": {
"nullable": true
},
"response_metadata": {
"$ref": "#/components/schemas/objs_response_metadata"
}
},
"description": "Schema for successful response from files.info method"
}
FilesInfodefaultResponse
{
"type": "object",
"title": "files.info error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"file_not_found",
"file_deleted",
"timezone_count_failed",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from files.info method"
}
FilesListResponse
{
"type": "object",
"title": "files.list schema",
"required": [
"ok",
"files",
"paging"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_file"
},
"minItems": 0,
"uniqueItems": true
},
"paging": {
"$ref": "#/components/schemas/objs_paging"
}
},
"description": "Schema for successful response from files.list method"
}
FilesListdefaultResponse
{
"type": "object",
"title": "files.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"user_not_found",
"unknown_type",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from files.list method"
}
FilesRevokePublicUrlRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "File to revoke"
}
}
}
FilesRevokePublicUrlResponse
{
"type": "object",
"title": "files.revokePublicURL schema",
"required": [
"ok",
"file"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"file": {
"$ref": "#/components/schemas/objs_file"
}
},
"description": "Schema for successful response from files.revokePublicURL method"
}
FilesRevokePublicUrldefaultResponse
{
"type": "object",
"title": "files.revokePublicURL error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"file_not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from files.revokePublicURL method"
}
FilesSharedPublicUrlRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "File to share"
}
}
}
FilesSharedPublicUrlResponse
{
"type": "object",
"title": "files.sharedPublicURL schema",
"required": [
"ok",
"file"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"file": {
"$ref": "#/components/schemas/objs_file"
}
},
"description": "Schema for successful response from files.sharedPublicURL method"
}
FilesSharedPublicUrldefaultResponse
{
"type": "object",
"title": "files.sharedPublicURL error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"file_not_found",
"not_allowed",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from files.sharedPublicURL method"
}
FilesUploadRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "File contents via `multipart/form-data`. If omitting this parameter, you must submit `content`."
},
"title": {
"type": "string",
"description": "Title of file."
},
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `files:write:user`"
},
"content": {
"type": "string",
"description": "File contents via a POST variable. If omitting this parameter, you must provide a `file`."
},
"channels": {
"type": "string",
"description": "Comma-separated list of channel names or IDs where the file will be shared."
},
"filename": {
"type": "string",
"description": "Filename of file."
},
"filetype": {
"type": "string",
"description": "A [file type](https://slack.dev) identifier."
},
"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."
},
"initial_comment": {
"type": "string",
"description": "The message text introducing the file in specified `channels`."
}
}
}
FilesUploadResponse
{
"type": "object",
"title": "files.upload schema",
"required": [
"ok",
"file"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"file": {
"$ref": "#/components/schemas/objs_file"
}
},
"description": "Schema for successful response files.upload method"
}
FilesUploaddefaultResponse
{
"type": "object",
"title": "files.upload error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"posting_to_general_channel_denied",
"invalid_channel",
"file_uploads_disabled",
"file_uploads_except_images_disabled",
"storage_limit_reached",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response files.upload method"
}
FilescommentsDeleteCommentRequest
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The comment to delete."
},
"file": {
"type": "string",
"description": "File to delete a comment from."
}
}
}
FilescommentsDeleteCommentResponse
{
"type": "object",
"title": "files.comments.delete schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response files.comments.delete method"
}
FilescommentsDeleteCommentdefaultResponse
{
"type": "object",
"title": "files.comments.delete error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"cant_delete",
"comment_not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response files.comments.delete method"
}
FilesremoteAddFromRemoteRequest
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the file being shared."
},
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `remote_files:write`"
},
"filetype": {
"type": "string",
"description": "type of file"
},
"external_id": {
"type": "string",
"description": "Creator defined GUID for the 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."
}
}
}
FilesremoteAddFromRemoteResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteAddFromRemotedefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteDeleteFileRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Specify a file by providing its ID."
},
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `remote_files:write`"
},
"external_id": {
"type": "string",
"description": "Creator defined GUID for the file."
}
}
}
FilesremoteDeleteFileResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteDeleteFiledefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteGetInfoResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteGetInfodefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteListRemoteFilesResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteListRemoteFilesdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteShareRemoteFileResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteShareRemoteFiledefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteUpdateRemoteFileRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Specify a file by providing its ID."
},
"title": {
"type": "string",
"description": "Title of the file being shared."
},
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `remote_files:write`"
},
"filetype": {
"type": "string",
"description": "type of file"
},
"external_id": {
"type": "string",
"description": "Creator defined GUID for the 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."
}
}
}
FilesremoteUpdateRemoteFileResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
FilesremoteUpdateRemoteFiledefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
MigrationExchangeResponse
{
"type": "object",
"title": "migration.exchange success schema",
"required": [
"ok",
"team_id",
"enterprise_id"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"team_id": {
"$ref": "#/components/schemas/defs_team"
},
"user_id_map": {
"type": "object",
"title": "A mapping of provided user IDs with mapped user IDs",
"additionalProperties": true
},
"enterprise_id": {
"type": "string",
"title": "The enterprise grid organization ID containing the workspace/team."
},
"invalid_user_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "A list of User IDs that cannot be mapped or found"
}
},
"description": "Schema for successful response from migration.exchange method",
"additionalProperties": true
}
MigrationExchangedefaultResponse
{
"type": "object",
"title": "migration.exchange error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_enterprise_team",
"too_many_users",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from migration.exchange method"
}
OauthAccessResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
OauthAccessdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
OauthTokenResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
OauthTokendefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
Oauthv2ExchangeTokenResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
Oauthv2ExchangeTokendefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
PinsAddRequest
{
"type": "object",
"required": [
"channel"
],
"properties": {
"channel": {
"type": "string",
"description": "Channel to pin the item in."
},
"timestamp": {
"type": "string",
"description": "Timestamp of the message to pin."
}
}
}
PinsAddResponse
{
"type": "object",
"title": "pins.add schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from pins.add method"
}
PinsAdddefaultResponse
{
"type": "object",
"title": "pins.add error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"bad_timestamp",
"message_not_found",
"channel_not_found",
"no_item_specified",
"already_pinned",
"permission_denied",
"file_not_shared",
"not_pinnable",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from pins.add method"
}
PinsListResponse
{
"items": {
"anyOf": [
{
"type": "object",
"required": [
"ok",
"items"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"items": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"title": "File Pin",
"properties": {
"file": {
"$ref": "#/components/schemas/objs_file"
},
"type": {
"enum": [
"file"
],
"type": "string"
},
"created": {
"type": "integer"
},
"created_by": {
"$ref": "#/components/schemas/defs_user_id"
}
}
},
{
"type": "object",
"title": "Message Pin",
"properties": {
"type": {
"enum": [
"message"
],
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
},
"created": {
"type": "integer"
},
"message": {
"$ref": "#/components/schemas/objs_message"
},
"created_by": {
"$ref": "#/components/schemas/defs_user_id"
}
}
}
]
},
"uniqueItems": true
}
}
},
{
"type": "object",
"required": [
"ok",
"count"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"count": {
"type": "integer"
}
}
}
]
},
"title": "pins.list success schema",
"description": "Schema for successful response from pins.list method"
}
PinsListdefaultResponse
{
"type": "object",
"title": "pins.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"channel_not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from pins.list method"
}
PinsRemoveRequest
{
"type": "object",
"required": [
"channel"
],
"properties": {
"channel": {
"type": "string",
"description": "Channel where the item is pinned to."
},
"timestamp": {
"type": "string",
"description": "Timestamp of the message to un-pin."
}
}
}
PinsRemoveResponse
{
"type": "object",
"title": "pins.remove schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from pins.remove method"
}
PinsRemovedefaultResponse
{
"type": "object",
"title": "pins.remove error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"bad_timestamp",
"file_not_found",
"file_comment_not_found",
"message_not_found",
"no_item_specified",
"not_pinned",
"permission_denied",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_typ",
"missing_post_typ",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeou",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from pins.remove method"
}
ReactionsAddRequest
{
"type": "object",
"required": [
"channel",
"name",
"timestamp"
],
"properties": {
"name": {
"type": "string",
"description": "Reaction (emoji) name."
},
"channel": {
"type": "string",
"description": "Channel where the message to add reaction to was posted."
},
"timestamp": {
"type": "string",
"description": "Timestamp of the message to add reaction to."
}
}
}
ReactionsAddResponse
{
"type": "object",
"title": "reactions.add schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from reactions.add method"
}
ReactionsAdddefaultResponse
{
"type": "object",
"title": "reactions.add error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"bad_timestamp",
"message_not_found",
"no_item_specified",
"invalid_name",
"already_reacted",
"too_many_emoji",
"too_many_reactions",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from reactions.add method"
}
ReactionsGetResponse
{
"type": "object",
"items": {
"anyOf": [
{
"required": [
"ok",
"type",
"channel",
"message"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"type": {
"enum": [
"message"
],
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
},
"message": {
"$ref": "#/components/schemas/objs_message"
}
},
"additionalProperties": false
},
{
"required": [
"ok",
"type",
"file"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"file": {
"$ref": "#/components/schemas/objs_file"
},
"type": {
"enum": [
"file"
],
"type": "string"
}
},
"additionalProperties": false
},
{
"required": [
"ok",
"type",
"file",
"comment"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"file": {
"$ref": "#/components/schemas/objs_file"
},
"type": {
"enum": [
"file_comment"
],
"type": "string"
},
"comment": {
"$ref": "#/components/schemas/objs_comment"
}
},
"additionalProperties": false
}
]
},
"title": "reactions.get success schema",
"description": "Schema for successful response from reactions.get method"
}
ReactionsGetdefaultResponse
{
"type": "object",
"title": "reactions.get error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"bad_timestamp",
"file_not_found",
"file_comment_not_found",
"message_not_found",
"no_item_specified",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from reactions.get method"
}
ReactionsListResponse
{
"type": "object",
"title": "reactions.list schema",
"required": [
"ok",
"items"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"items": {
"type": "array",
"items": {
"items": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"channel",
"message"
],
"properties": {
"type": {
"enum": [
"message"
],
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
},
"message": {
"$ref": "#/components/schemas/objs_message"
}
}
},
{
"type": "object",
"required": [
"type",
"file"
],
"properties": {
"file": {
"$ref": "#/components/schemas/objs_file"
},
"type": {
"enum": [
"file"
],
"type": "string"
}
}
},
{
"type": "object",
"required": [
"type",
"file",
"comment"
],
"properties": {
"file": {
"$ref": "#/components/schemas/objs_file"
},
"type": {
"enum": [
"file_comment"
],
"type": "string"
},
"comment": {
"$ref": "#/components/schemas/objs_comment"
}
}
}
]
}
}
},
"paging": {
"$ref": "#/components/schemas/objs_paging"
},
"response_metadata": {
"$ref": "#/components/schemas/objs_response_metadata"
}
},
"description": "Schema for successful response from reactions.list method"
}
ReactionsListdefaultResponse
{
"type": "object",
"title": "reactions.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"user_not_found",
"not_authed",
"invalid_auth",
"account_inactiv",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from reactions.list method"
}
ReactionsRemoveRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"file": {
"type": "string",
"description": "File to remove reaction from."
},
"name": {
"type": "string",
"description": "Reaction (emoji) name."
},
"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."
},
"file_comment": {
"type": "string",
"description": "File comment to remove reaction from."
}
}
}
ReactionsRemoveResponse
{
"type": "object",
"title": "reactions.remove schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from reactions.remove method"
}
ReactionsRemovedefaultResponse
{
"type": "object",
"title": "reactions.remove error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"bad_timestamp",
"file_not_found",
"file_comment_not_found",
"message_not_found",
"no_item_specified",
"invalid_name",
"no_reaction",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from reactions.remove method"
}
RemindersAddRequest
{
"type": "object",
"required": [
"text",
"time"
],
"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."
}
}
}
RemindersAddResponse
{
"type": "object",
"title": "reminders.add schema",
"required": [
"ok",
"reminder"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"reminder": {
"$ref": "#/components/schemas/objs_reminder"
}
},
"description": "Schema for successful response from reminders.add method"
}
RemindersAdddefaultResponse
{
"type": "object",
"title": "reminders.add error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"cannot_parse",
"user_not_found",
"cannot_add_bot",
"cannot_add_slackbot",
"cannot_add_others",
"cannot_add_others_recurring",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from reminders.add method"
}
RemindersCompleteRequest
{
"type": "object",
"properties": {
"reminder": {
"type": "string",
"description": "The ID of the reminder to be marked as complete"
}
}
}
RemindersCompleteResponse
{
"type": "object",
"title": "reminders.complete schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from reminders.complete method"
}
RemindersCompletedefaultResponse
{
"type": "object",
"title": "reminders.complete error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_found",
"cannot_complete_recurring",
"cannot_complete_others",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from reminders.complete method"
}
RemindersDeleteRequest
{
"type": "object",
"properties": {
"reminder": {
"type": "string",
"description": "The ID of the reminder"
}
}
}
RemindersDeleteResponse
{
"type": "object",
"title": "reminders.delete schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from reminders.delete method"
}
RemindersDeletedefaultResponse
{
"type": "object",
"title": "reminders.delete error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from reminders.delete method"
}
RemindersInfoResponse
{
"type": "object",
"title": "reminders.info schema",
"required": [
"ok",
"reminder"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"reminder": {
"$ref": "#/components/schemas/objs_reminder"
}
},
"description": "Schema for successful response from reminders.info method"
}
RemindersInfodefaultResponse
{
"type": "object",
"title": "reminders.info error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from reminders.info method"
}
RemindersListResponse
{
"type": "object",
"title": "reminders.list schema",
"required": [
"ok",
"reminders"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"reminders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_reminder"
}
}
},
"description": "Schema for successful response from reminders.list method"
}
RemindersListdefaultResponse
{
"type": "object",
"title": "reminders.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from reminders.list method"
}
RtmConnectResponse
{
"type": "object",
"title": "rtm.connect schema",
"required": [
"ok",
"url",
"team",
"self"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"url": {
"type": "string",
"format": "uri"
},
"self": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_user_id"
},
"name": {
"type": "string"
}
}
},
"team": {
"type": "object",
"required": [
"id",
"name",
"domain"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_team"
},
"name": {
"type": "string"
},
"domain": {
"type": "string"
}
}
}
},
"description": "Schema for successful response from rtm.connect method"
}
RtmConnectdefaultResponse
{
"type": "object",
"title": "rtm.connect error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from rtm.connect method"
}
SearchMessagesResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
SearchMessagesdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
StarsAddRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "File to add star to."
},
"channel": {
"type": "string",
"description": "Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`)."
},
"timestamp": {
"type": "string",
"description": "Timestamp of the message to add star to."
},
"file_comment": {
"type": "string",
"description": "File comment to add star to."
}
}
}
StarsAddResponse
{
"type": "object",
"title": "stars.add schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from stars.add method"
}
StarsAdddefaultResponse
{
"type": "object",
"title": "stars.add error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"bad_timestamp",
"message_not_found",
"file_not_found",
"file_comment_not_found",
"channel_not_found",
"no_item_specified",
"already_starred",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from stars.add method"
}
StarsListResponse
{
"type": "object",
"title": "stars.list schema",
"required": [
"ok",
"items"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"items": {
"type": "array",
"items": {
"items": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"channel",
"message",
"date_create"
],
"properties": {
"type": {
"enum": [
"message"
],
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
},
"message": {
"$ref": "#/components/schemas/objs_message"
},
"date_create": {
"type": "integer"
}
}
},
{
"type": "object",
"required": [
"type",
"file",
"date_create"
],
"properties": {
"file": {
"$ref": "#/components/schemas/objs_file"
},
"type": {
"enum": [
"file"
],
"type": "string"
},
"date_create": {
"type": "integer"
}
}
},
{
"type": "object",
"required": [
"type",
"file",
"comment",
"date_create"
],
"properties": {
"file": {
"$ref": "#/components/schemas/objs_file"
},
"type": {
"enum": [
"file_comment"
],
"type": "string"
},
"comment": {
"$ref": "#/components/schemas/objs_comment"
},
"date_create": {
"type": "integer"
}
}
},
{
"type": "object",
"required": [
"type",
"channel",
"date_create"
],
"properties": {
"type": {
"enum": [
"channel"
],
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
},
"date_create": {
"type": "integer"
}
}
},
{
"type": "object",
"required": [
"type",
"channel",
"date_create"
],
"properties": {
"type": {
"enum": [
"im"
],
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/defs_dm_id"
},
"date_create": {
"type": "integer"
}
}
},
{
"type": "object",
"required": [
"type",
"channel",
"date_create"
],
"properties": {
"type": {
"enum": [
"group"
],
"type": "string"
},
"channel": {
"$ref": "#/components/schemas/defs_group_id"
},
"date_create": {
"type": "integer"
}
}
}
]
}
}
},
"paging": {
"$ref": "#/components/schemas/objs_paging"
}
},
"description": "Schema for successful response from stars.list method"
}
StarsListdefaultResponse
{
"type": "object",
"title": "stars.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from stars.list method"
}
StarsRemoveRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "File to remove star from."
},
"channel": {
"type": "string",
"description": "Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`)."
},
"timestamp": {
"type": "string",
"description": "Timestamp of the message to remove star from."
},
"file_comment": {
"type": "string",
"description": "File comment to remove star from."
}
}
}
StarsRemoveResponse
{
"type": "object",
"title": "stars.remove schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from stars.remove method"
}
StarsRemovedefaultResponse
{
"type": "object",
"title": "stars.remove error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"bad_timestamp",
"message_not_found",
"file_not_found",
"file_comment_not_found",
"channel_not_found",
"no_item_specified",
"not_starred",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from stars.remove method"
}
TeamAccessLogsResponse
{
"type": "object",
"title": "team.accessLogs schema",
"required": [
"ok",
"logins",
"paging"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"logins": {
"type": "array",
"items": {
"type": "object",
"required": [
"user_id",
"username",
"date_first",
"date_last",
"count",
"ip",
"user_agent",
"isp",
"country",
"region"
],
"properties": {
"ip": {
"type": "string",
"nullable": true
},
"isp": {
"type": "string",
"nullable": true
},
"count": {
"type": "integer"
},
"region": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"user_id": {
"$ref": "#/components/schemas/defs_user_id"
},
"username": {
"type": "string"
},
"date_last": {
"type": "integer"
},
"date_first": {
"type": "integer"
},
"user_agent": {
"type": "string"
}
}
},
"minItems": 1,
"uniqueItems": true
},
"paging": {
"$ref": "#/components/schemas/objs_paging"
}
},
"description": "Schema for successful response from team.accessLogs method"
}
TeamAccessLogsdefaultResponse
{
"type": "object",
"title": "team.accessLogs error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"paid_only",
"over_pagination_limit",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from team.accessLogs method"
}
TeamBillableInfoResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
TeamBillableInfodefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
TeamInfoResponse
{
"type": "object",
"title": "team.info schema",
"required": [
"ok",
"team"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"team": {
"$ref": "#/components/schemas/objs_team"
}
},
"description": "Schema for successful response from team.info method"
}
TeamInfodefaultResponse
{
"type": "object",
"title": "team.info error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from team.info method"
}
TeamIntegrationLogsResponse
{
"type": "object",
"title": "team.integrationLogs schema",
"required": [
"ok",
"logs",
"paging"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"logs": {
"type": "array",
"items": {
"type": "object",
"required": [
"user_id",
"user_name",
"date",
"change_type",
"app_type",
"app_id",
"scope"
],
"properties": {
"date": {
"type": "string"
},
"scope": {
"type": "string"
},
"app_id": {
"$ref": "#/components/schemas/defs_app_id"
},
"channel": {
"$ref": "#/components/schemas/defs_channel"
},
"user_id": {
"$ref": "#/components/schemas/defs_user_id"
},
"app_type": {
"type": "string"
},
"user_name": {
"type": "string"
},
"service_id": {
"type": "string"
},
"change_type": {
"type": "string"
},
"admin_app_id": {
"$ref": "#/components/schemas/defs_app_id"
},
"service_type": {
"type": "string"
}
}
},
"minItems": 1,
"uniqueItems": true
},
"paging": {
"$ref": "#/components/schemas/objs_paging"
}
},
"description": "Schema for successful response from team.integrationLogs method"
}
TeamIntegrationLogsdefaultResponse
{
"type": "object",
"title": "team.integrationLogs error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from team.integrationLogs method"
}
TeamprofileGetProfileResponse
{
"type": "object",
"title": "team.profile.get success schema",
"required": [
"ok",
"profile"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"profile": {
"type": "object",
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_team_profile_field"
},
"uniqueItems": true
}
}
}
},
"description": "Schema for successful response from team.profile.get method"
}
TeamprofileGetProfiledefaultResponse
{
"type": "object",
"title": "team.profile.get error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_typ",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeou",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from team.profile.get method"
}
UsergroupsCreateRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "A name for the User Group. Must be unique among User Groups."
},
"handle": {
"type": "string",
"description": "A mention handle. Must be unique among channels, users and User Groups."
},
"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."
},
"include_count": {
"type": "boolean",
"description": "Include the number of users in each User Group."
}
}
}
UsergroupsCreateResponse
{
"type": "object",
"title": "usergroups.create schema",
"required": [
"ok",
"usergroup"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"usergroup": {
"$ref": "#/components/schemas/objs_subteam"
}
},
"description": "Schema for successful response from usergroups.create method"
}
UsergroupsCreatedefaultResponse
{
"type": "object",
"title": "usergroups.create error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"permission_denied",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from usergroups.create method"
}
UsergroupsDisableRequest
{
"type": "object",
"required": [
"usergroup"
],
"properties": {
"usergroup": {
"type": "string",
"description": "The encoded ID of the User Group to disable."
},
"include_count": {
"type": "boolean",
"description": "Include the number of users in the User Group."
}
}
}
UsergroupsDisableResponse
{
"type": "object",
"title": "usergroups.disable schema",
"required": [
"ok",
"usergroup"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"usergroup": {
"$ref": "#/components/schemas/objs_subteam"
}
},
"description": "Schema for successful response from usergroups.disable method"
}
UsergroupsDisabledefaultResponse
{
"type": "object",
"title": "usergroups.disable error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"permission_denied",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from usergroups.disable method"
}
UsergroupsEnableRequest
{
"type": "object",
"required": [
"usergroup"
],
"properties": {
"usergroup": {
"type": "string",
"description": "The encoded ID of the User Group to enable."
},
"include_count": {
"type": "boolean",
"description": "Include the number of users in the User Group."
}
}
}
UsergroupsEnableResponse
{
"type": "object",
"title": "usergroups.enable schema",
"required": [
"ok",
"usergroup"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"usergroup": {
"$ref": "#/components/schemas/objs_subteam"
}
},
"description": "Schema for successful response from usergroups.enable method"
}
UsergroupsEnabledefaultResponse
{
"type": "object",
"title": "usergroups.enable error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_require",
"fatal_error",
"missing_charset",
"superfluous_charset"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from usergroups.enable method"
}
UsergroupsListResponse
{
"type": "object",
"title": "usergroups.list schema",
"required": [
"ok",
"usergroups"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"usergroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_subteam"
}
}
},
"description": "Schema for successful response from usergroups.list method"
}
UsergroupsListdefaultResponse
{
"type": "object",
"title": "usergroups.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_require",
"fatal_error",
"missing_charset",
"superfluous_charset"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from usergroups.list method"
}
UsergroupsUpdateRequest
{
"type": "object",
"required": [
"usergroup"
],
"properties": {
"name": {
"type": "string",
"description": "A name for the User Group. Must be unique among User Groups."
},
"handle": {
"type": "string",
"description": "A mention handle. Must be unique among channels, users and User Groups."
},
"channels": {
"type": "string",
"description": "A comma separated string of encoded channel IDs for which the User Group uses as a default."
},
"usergroup": {
"type": "string",
"description": "The encoded ID of the User Group to update."
},
"description": {
"type": "string",
"description": "A short description of the User Group."
},
"include_count": {
"type": "boolean",
"description": "Include the number of users in the User Group."
}
}
}
UsergroupsUpdateResponse
{
"type": "object",
"title": "usergroups.update schema",
"required": [
"ok",
"usergroup"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"usergroup": {
"$ref": "#/components/schemas/objs_subteam"
}
},
"description": "Schema for successful response from usergroups.update method"
}
UsergroupsUpdatedefaultResponse
{
"type": "object",
"title": "usergroups.update error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"permission_denied",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_require",
"fatal_error",
"missing_charset",
"superfluous_charset"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from usergroups.update method"
}
UsergroupsusersListAllUsersResponse
{
"type": "object",
"title": "usergroups.users.list schema",
"required": [
"ok",
"users"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_user_id"
}
}
},
"description": "Schema for successful response from usergroups.users.list method"
}
UsergroupsusersListAllUsersdefaultResponse
{
"type": "object",
"title": "usergroups.users.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_require",
"fatal_error",
"missing_charset",
"superfluous_charset"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from usergroups.users.list method"
}
UsergroupsusersUpdateListRequest
{
"type": "object",
"required": [
"usergroup",
"users"
],
"properties": {
"users": {
"type": "string",
"description": "A comma separated string of encoded user IDs that represent the entire list of users for the User Group."
},
"usergroup": {
"type": "string",
"description": "The encoded ID of the User Group to update."
},
"include_count": {
"type": "boolean",
"description": "Include the number of users in the User Group."
}
}
}
UsergroupsusersUpdateListResponse
{
"type": "object",
"title": "usergroups.users.update schema",
"required": [
"ok",
"usergroup"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"usergroup": {
"$ref": "#/components/schemas/objs_subteam"
}
},
"description": "Schema for successful response from usergroups.users.update method"
}
UsergroupsusersUpdateListdefaultResponse
{
"type": "object",
"title": "usergroups.users.update error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"permission_denied",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"user_is_restricted",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_require",
"fatal_error",
"missing_charset",
"superfluous_charset"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from usergroups.users.update method"
}
UsersConversationsResponse
{
"type": "object",
"title": "users.conversations success schema",
"required": [
"ok",
"channels"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_conversation"
},
"uniqueItems": true
},
"response_metadata": {
"type": "object",
"required": [
"next_cursor"
],
"properties": {
"next_cursor": {
"type": "string"
}
}
}
},
"description": "Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member`",
"additionalProperties": true
}
UsersConversationsdefaultResponse
{
"type": "object",
"title": "users.conversations error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"method_not_supported_for_channel_type",
"missing_scope",
"invalid_types",
"invalid_cursor",
"invalid_limit",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from users.conversations method"
}
UsersDeletePhotoRequest
{
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"description": "Authentication token. Requires scope: `users.profile:write`"
}
}
}
UsersDeletePhotoResponse
{
"type": "object",
"title": "users.deletePhoto schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from users.deletePhoto method"
}
UsersDeletePhotodefaultResponse
{
"type": "object",
"title": "users.deletePhoto error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from users.deletePhoto method"
}
UsersGetPresenceResponse
{
"type": "object",
"title": "API method: users.getPresence",
"required": [
"ok",
"presence"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"online": {
"type": "boolean"
},
"presence": {
"type": "string"
},
"auto_away": {
"type": "boolean"
},
"manual_away": {
"type": "boolean"
},
"last_activity": {
"type": "integer"
},
"connection_count": {
"type": "integer"
}
},
"description": "Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65",
"additionalProperties": true
}
UsersGetPresencedefaultResponse
{
"type": "object",
"title": "users.counts error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"type": "string"
}
},
"description": "Schema for error response users.getPresence method",
"additionalProperties": {
"type": "object"
}
}
UsersIdentityResponse
{
"items": {
"anyOf": [
{
"type": "object",
"required": [
"ok",
"user",
"team"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"team": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_team"
}
}
},
"user": {
"type": "object",
"required": [
"name",
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_user_id"
},
"name": {
"type": "string"
}
}
}
},
"description": "Schema for 'identity.basic' scope"
},
{
"type": "object",
"required": [
"ok",
"user",
"team"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"team": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_team"
}
}
},
"user": {
"type": "object",
"required": [
"name",
"id",
"email"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_user_id"
},
"name": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
}
}
}
},
"description": "Schema for 'identity.basic,identity.email' scopes"
},
{
"type": "object",
"required": [
"ok",
"user",
"team"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"team": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_team"
}
}
},
"user": {
"type": "object",
"required": [
"name",
"id",
"image_24",
"image_32",
"image_48",
"image_72",
"image_192",
"image_512"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_user_id"
},
"name": {
"type": "string"
},
"image_24": {
"type": "string",
"format": "url"
},
"image_32": {
"type": "string",
"format": "url"
},
"image_48": {
"type": "string",
"format": "url"
},
"image_72": {
"type": "string",
"format": "url"
},
"image_192": {
"type": "string",
"format": "url"
},
"image_512": {
"type": "string",
"format": "url"
}
}
}
},
"description": "Schema for 'identity.basic,identity.avatar' scopes"
},
{
"type": "object",
"required": [
"ok",
"user",
"team"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"team": {
"type": "object",
"required": [
"id",
"name",
"domain",
"image_34",
"image_44",
"image_68",
"image_88",
"image_102",
"image_132",
"image_230",
"image_default"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_team"
},
"name": {
"type": "string"
},
"domain": {
"type": "string"
},
"image_34": {
"type": "string",
"format": "url"
},
"image_44": {
"type": "string",
"format": "url"
},
"image_68": {
"type": "string",
"format": "url"
},
"image_88": {
"type": "string",
"format": "url"
},
"image_102": {
"type": "string",
"format": "url"
},
"image_132": {
"type": "string",
"format": "url"
},
"image_230": {
"type": "string",
"format": "url"
},
"image_default": {
"type": "boolean"
}
}
},
"user": {
"type": "object",
"required": [
"name",
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_user_id"
},
"name": {
"type": "string"
}
}
}
},
"description": "Schema for 'identity.basic,identity.team' scopes"
}
]
},
"title": "users.identity schema",
"description": "Schema for successful response from users.identity method"
}
UsersIdentitydefaultResponse
{
"type": "object",
"title": "users.identity error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from users.identity method"
}
UsersInfoResponse
{
"type": "object",
"title": "users.info success schema",
"required": [
"ok",
"user"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"user": {
"$ref": "#/components/schemas/objs_user"
}
},
"description": "Schema for successful response from users.info method",
"additionalProperties": true
}
UsersInfodefaultResponse
{
"type": "object",
"title": "users.info error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"user_not_found",
"user_not_visible",
"not_authed",
"invalid_auth",
"account_inactive",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required"
],
"type": "string"
},
"callstack": {
"type": "string"
}
},
"description": "Schema for error response from users.info method"
}
UsersListResponse
{
"type": "object",
"title": "users.list schema",
"required": [
"ok",
"members",
"cache_ts"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_user"
},
"minItems": 1,
"uniqueItems": true
},
"cache_ts": {
"type": "integer"
},
"response_metadata": {
"$ref": "#/components/schemas/objs_response_metadata"
}
},
"description": "Schema for successful response from users.list method"
}
UsersListdefaultResponse
{
"type": "object",
"title": "users.list error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"limit_required",
"invalid_cursor",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from users.list method"
}
UsersLookupByEmailResponse
{
"type": "object",
"title": "users.lookupByEmail success schema",
"required": [
"ok",
"user"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"user": {
"$ref": "#/components/schemas/objs_user"
}
},
"description": "Schema for successful response from users.lookupByEmail method",
"additionalProperties": true
}
UsersLookupByEmaildefaultResponse
{
"type": "object",
"title": "users.lookupByEmail error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"users_not_found",
"enterprise_is_restricted",
"not_authed",
"invalid_auth",
"account_inactive",
"no_permission",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from users.lookupByEmail method"
}
UsersSetActiveResponse
{
"type": "object",
"title": "users.setActive schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from users.setActive method"
}
UsersSetActivedefaultResponse
{
"type": "object",
"title": "users.setActive error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"ekm_access_denied",
"missing_scope",
"invalid_arguments",
"invalid_arg_name",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"request_timeout",
"fatal_error",
"internal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from users.setActive method"
}
UsersSetPhotoRequest
{
"type": "object",
"required": [
"token"
],
"properties": {
"image": {
"type": "string",
"description": "File contents via `multipart/form-data`."
},
"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"
}
}
}
UsersSetPhotoResponse
{
"type": "object",
"title": "users.setPhoto schema",
"required": [
"ok",
"profile"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"profile": {
"type": "object",
"required": [
"image_24",
"image_32",
"image_48",
"image_72",
"image_192",
"image_512",
"image_1024",
"image_original",
"avatar_hash"
],
"properties": {
"image_24": {
"type": "string",
"format": "uri"
},
"image_32": {
"type": "string",
"format": "uri"
},
"image_48": {
"type": "string",
"format": "uri"
},
"image_72": {
"type": "string",
"format": "uri"
},
"image_192": {
"type": "string",
"format": "uri"
},
"image_512": {
"type": "string",
"format": "uri"
},
"image_1024": {
"type": "string",
"format": "uri"
},
"avatar_hash": {
"type": "string",
"pattern": "^[0-9a-f]{12}$"
},
"image_original": {
"type": "string",
"format": "uri"
}
}
}
},
"description": "Schema for successful response from users.setPhoto method"
}
UsersSetPhotodefaultResponse
{
"type": "object",
"title": "users.setPhoto error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"dims": {
"type": "string",
"description": "possibly DEV/QA only"
},
"error": {
"enum": [
"bad_image",
"too_large",
"too_many_frames",
"not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
},
"debug_step": {
"type": "string",
"description": "possibly DEV/QA only"
},
"time_ident": {
"type": "integer",
"description": "possibly DEV/QA only"
}
},
"description": "Schema for error response from users.setPhoto method"
}
UsersSetPresenceRequest
{
"type": "object",
"required": [
"presence"
],
"properties": {
"presence": {
"type": "string",
"description": "Either `auto` or `away`"
}
}
}
UsersSetPresenceResponse
{
"type": "object",
"title": "users.setPresence schema",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "Schema for successful response from users.setPresence method"
}
UsersSetPresencedefaultResponse
{
"type": "object",
"title": "users.setPresence error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"invalid_presence",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from users.setPresence method"
}
UsersprofileGetProfileInfoResponse
{
"type": "object",
"title": "users.profile.get schema",
"required": [
"ok",
"profile"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"profile": {
"$ref": "#/components/schemas/objs_user_profile"
}
},
"description": "Schema for successful response from users.profile.get method"
}
UsersprofileGetProfileInfodefaultResponse
{
"type": "object",
"title": "users.profile.get error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"user_not_found",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from users.profile.get method"
}
UsersprofileSetProfileInfoRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of a single key to set. Usable only if `profile` is not passed."
},
"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."
},
"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."
}
}
}
UsersprofileSetProfileInfoResponse
{
"type": "object",
"title": "users.profile.set schema",
"required": [
"ok",
"username",
"profile"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
},
"profile": {
"$ref": "#/components/schemas/objs_user_profile"
},
"username": {
"type": "string"
},
"email_pending": {
"type": "string",
"format": "email"
}
},
"description": "Schema for successful response from users.profile.set method"
}
UsersprofileSetProfileInfodefaultResponse
{
"type": "object",
"title": "users.profile.set error schema",
"required": [
"ok",
"error"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
},
"error": {
"enum": [
"reserved_name",
"invalid_profile",
"profile_set_failed",
"not_admin",
"not_app_admin",
"cannot_update_admin_user",
"not_authed",
"invalid_auth",
"account_inactive",
"token_revoked",
"no_permission",
"org_login_required",
"user_is_bot",
"invalid_arg_name",
"invalid_array_arg",
"invalid_charset",
"invalid_form_data",
"invalid_post_type",
"missing_post_type",
"team_added_to_org",
"invalid_json",
"json_not_object",
"request_timeout",
"upgrade_required",
"fatal_error"
],
"type": "string"
},
"callstack": {
"type": "string",
"description": "Note: PHP callstack is only visible in dev/qa"
}
},
"description": "Schema for error response from users.profile.set method"
}
ViewsOpenResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
ViewsOpendefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
ViewsPublishResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
ViewsPublishdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
ViewsPushResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
ViewsPushdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
ViewsUpdateResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
ViewsUpdatedefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
WorkflowsStepCompletedResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
WorkflowsStepCompleteddefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
WorkflowsStepFailedResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
WorkflowsStepFaileddefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
WorkflowsUpdateStepResponse
{
"type": "object",
"title": "Default success template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_true"
}
},
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
WorkflowsUpdateStepdefaultResponse
{
"type": "object",
"title": "Default error template",
"required": [
"ok"
],
"properties": {
"ok": {
"$ref": "#/components/schemas/defs_ok_false"
}
},
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"additionalProperties": true
}
blocks
{
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
}
},
"additionalProperties": true
},
"title": "Block Kit blocks",
"description": "This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace."
}
defs_app_id
{
"type": "string",
"title": "App ID",
"pattern": "^A[A-Z0-9]{1,}$"
}
defs_bot_id
{
"type": "string",
"title": "Bot User ID",
"pattern": "^B[A-Z0-9]{8,}$"
}
defs_channel
{
"type": "string",
"title": "Channel-like conversation ID",
"pattern": "^[CGD][A-Z0-9]{8,}$"
}
defs_channel_id
{
"type": "string",
"title": "Channel ID",
"pattern": "^[C][A-Z0-9]{2,}$"
}
defs_channel_name
{
"type": "string",
"title": "Name of a channel"
}
defs_comment_id
{
"type": "string",
"title": "File Comment ID",
"pattern": "^Fc[A-Z0-9]{8,}$"
}
defs_dm_id
{
"type": "string",
"title": "Direct Message Channel ID",
"pattern": "^[D][A-Z0-9]{8,}$"
}
defs_enterprise_id
{
"type": "string",
"title": "Enterprise ID",
"pattern": "^[E][A-Z0-9]{8,}$"
}
defs_enterprise_name
{
"type": "string",
"title": "Name of the enterprise org"
}
defs_enterprise_user_id
{
"type": "string",
"title": "Enterprise User ID",
"pattern": "^[WU][A-Z0-9]{8,}$"
}
defs_file_id
{
"type": "string",
"title": "File ID",
"pattern": "^[F][A-Z0-9]{8,}$"
}
defs_group_id
{
"type": "string",
"title": "Private Channel ID",
"pattern": "^[G][A-Z0-9]{8,}$"
}
defs_ok_false
{
"enum": [
false
],
"type": "boolean",
"title": "default failure response"
}
defs_ok_true
{
"enum": [
true
],
"type": "boolean",
"title": "default success response"
}
defs_optional_app_id
{
"type": "string",
"title": "App ID or empty string",
"pattern": "^(A[A-Z0-9]{1,})?$"
}
defs_pinned_info
{
"type": "object",
"title": "Info for a pinned item"
}
defs_reminder_id
{
"type": "string",
"title": "Reminder ID",
"pattern": "^Rm[A-Z0-9]{8,}$"
}
defs_subteam_id
{
"type": "string",
"title": "Subteam ID",
"pattern": "^S[A-Z0-9]{2,}$"
}
defs_team
{
"type": "string",
"title": "Team ID",
"pattern": "^[T][A-Z0-9]{2,}$"
}
defs_topic_purpose_creator
{
"type": "string",
"title": "User ID or empty string, used for topic and purpose creation",
"pattern": "^[UW][A-Z0-9]{8,}$|^$"
}
defs_ts
{
"type": "string",
"title": "Timestamp in format 0123456789.012345",
"pattern": "^\\d{10}\\.\\d{6}$"
}
defs_user_id
{
"type": "string",
"title": "User ID",
"pattern": "^[UW][A-Z0-9]{2,}$"
}
defs_workspace_id
{
"type": "string",
"title": "Team or Enterprise ID",
"pattern": "^[TE][A-Z0-9]{8,}$"
}
objs_bot_profile
{
"type": "object",
"title": "Bot Profile Object",
"required": [
"id",
"deleted",
"name",
"updated",
"app_id",
"icons",
"team_id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_bot_id"
},
"name": {
"type": "string"
},
"icons": {
"type": "object",
"required": [
"image_36",
"image_48",
"image_72"
],
"properties": {
"image_36": {
"type": "string",
"format": "uri"
},
"image_48": {
"type": "string",
"format": "uri"
},
"image_72": {
"type": "string",
"format": "uri"
}
}
},
"app_id": {
"$ref": "#/components/schemas/defs_app_id"
},
"deleted": {
"type": "boolean"
},
"team_id": {
"$ref": "#/components/schemas/defs_team"
},
"updated": {
"type": "integer"
}
}
}
objs_channel
{
"type": "object",
"title": "Channel Object",
"required": [
"id",
"name",
"created",
"creator",
"is_channel",
"is_org_shared",
"is_private",
"is_mpim",
"is_shared",
"name_normalized",
"members",
"topic",
"purpose"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_channel_id"
},
"name": {
"type": "string"
},
"topic": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/components/schemas/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
}
},
"latest": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/objs_message"
},
{
"nullable": true
}
]
}
},
"created": {
"type": "integer"
},
"creator": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_mpim": {
"type": "boolean"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_user_id"
},
"minItems": 0,
"uniqueItems": true
},
"purpose": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/components/schemas/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
}
},
"is_moved": {
"type": "integer"
},
"priority": {
"type": "number"
},
"unlinked": {
"type": "integer",
"title": "Field to determine whether a channel has ever been shared/disconnected in the past"
},
"is_frozen": {
"type": "boolean"
},
"is_member": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/components/schemas/defs_ts"
},
"is_channel": {
"type": "boolean"
},
"is_general": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
},
"is_archived": {
"type": "boolean"
},
"num_members": {
"type": "integer"
},
"is_read_only": {
"type": "boolean"
},
"unread_count": {
"type": "integer"
},
"accepted_user": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_org_shared": {
"type": "boolean"
},
"is_thread_only": {
"type": "boolean"
},
"pending_shared": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"previous_names": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_channel_name"
},
"minItems": 0,
"uniqueItems": true
},
"name_normalized": {
"type": "string"
},
"is_non_threadable": {
"type": "boolean"
},
"unread_count_display": {
"type": "integer"
},
"is_pending_ext_shared": {
"type": "boolean"
}
}
}
objs_comment
{
"type": "object",
"title": "File Comment Object",
"required": [
"id",
"created",
"timestamp",
"user",
"is_intro",
"comment"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_comment_id"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"comment": {
"type": "string"
},
"created": {
"type": "integer"
},
"is_intro": {
"type": "boolean"
},
"num_stars": {
"type": "integer"
},
"pinned_to": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_channel"
}
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_reaction"
}
},
"timestamp": {
"type": "integer"
},
"is_starred": {
"type": "boolean"
},
"pinned_info": {
"$ref": "#/components/schemas/defs_pinned_info"
}
}
}
objs_comments
{
"type": "array",
"items": {},
"title": "file comments object"
}
objs_conversation
{
"items": {
"anyOf": [
{
"type": "object",
"title": "Conversation object",
"required": [
"id",
"name",
"created",
"creator",
"is_archived",
"is_channel",
"is_general",
"is_mpim",
"is_group",
"is_org_shared",
"is_im",
"is_shared",
"is_private",
"name_normalized",
"topic",
"purpose"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_channel"
},
"name": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_im": {
"type": "boolean"
},
"topic": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/components/schemas/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
}
},
"latest": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/objs_message"
},
{
"nullable": true
}
]
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"required": [
"team",
"user",
"is_active"
],
"properties": {
"team": {
"$ref": "#/components/schemas/objs_team"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_active": {
"type": "boolean"
},
"accepted_user": {
"$ref": "#/components/schemas/defs_user_id"
}
}
},
"minItems": 0,
"uniqueItems": true
},
"created": {
"type": "integer"
},
"creator": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_mpim": {
"enum": [
false
],
"type": "boolean"
},
"is_open": {
"type": "boolean"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_user_id"
},
"minItems": 0,
"uniqueItems": true
},
"purpose": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/components/schemas/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
}
},
"version": {
"type": "integer"
},
"has_pins": {
"type": "boolean"
},
"is_group": {
"type": "boolean"
},
"is_moved": {
"type": "integer"
},
"priority": {
"type": "number"
},
"unlinked": {
"type": "integer",
"title": "Field to determine whether a channel has ever been shared/disconnected in the past"
},
"use_case": {
"type": "string"
},
"is_frozen": {
"type": "boolean"
},
"is_member": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/components/schemas/defs_ts"
},
"pin_count": {
"type": "integer"
},
"is_channel": {
"type": "boolean"
},
"is_general": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
},
"is_starred": {
"type": "boolean"
},
"is_archived": {
"type": "boolean"
},
"num_members": {
"type": "integer"
},
"is_read_only": {
"type": "boolean"
},
"unread_count": {
"type": "integer"
},
"accepted_user": {
"$ref": "#/components/schemas/defs_user_id"
},
"enterprise_id": {
"$ref": "#/components/schemas/defs_enterprise_id"
},
"is_ext_shared": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"display_counts": {
"type": "object",
"required": [
"display_counts",
"guest_counts"
],
"properties": {
"guest_counts": {
"type": "integer"
},
"display_counts": {
"type": "integer"
}
}
},
"is_org_default": {
"type": "boolean"
},
"is_thread_only": {
"type": "boolean"
},
"pending_shared": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"previous_names": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_channel_name"
},
"minItems": 0,
"uniqueItems": true
},
"timezone_count": {
"type": "integer"
},
"name_normalized": {
"type": "string"
},
"shared_team_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"is_global_shared": {
"type": "boolean"
},
"is_org_mandatory": {
"type": "boolean"
},
"internal_team_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"is_non_threadable": {
"type": "boolean"
},
"connected_team_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"minItems": 0,
"uniqueItems": true
},
"parent_conversation": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/defs_channel"
},
{
"nullable": true
}
]
}
},
"conversation_host_id": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"unread_count_display": {
"type": "integer"
},
"is_pending_ext_shared": {
"type": "boolean"
},
"pending_connected_team_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"minItems": 0,
"uniqueItems": true
}
}
},
{
"type": "object",
"title": "Conversation MPIM Object",
"required": [
"id",
"name",
"created",
"creator",
"is_archived",
"is_channel",
"is_general",
"is_mpim",
"is_group",
"is_org_shared",
"is_im",
"is_shared",
"is_private",
"name_normalized",
"topic",
"purpose"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_channel"
},
"name": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_im": {
"type": "boolean"
},
"topic": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/components/schemas/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
}
},
"latest": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/objs_message"
},
{
"nullable": true
}
]
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"required": [
"team",
"user",
"is_active"
],
"properties": {
"team": {
"$ref": "#/components/schemas/objs_team"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_active": {
"type": "boolean"
},
"accepted_user": {
"$ref": "#/components/schemas/defs_user_id"
}
}
},
"minItems": 0,
"uniqueItems": true
},
"created": {
"type": "integer"
},
"creator": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_mpim": {
"enum": [
true
],
"type": "boolean"
},
"is_open": {
"type": "boolean"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_user_id"
},
"minItems": 0,
"uniqueItems": true
},
"purpose": {
"type": "object",
"required": [
"value",
"creator",
"last_set"
],
"properties": {
"value": {
"type": "string"
},
"creator": {
"$ref": "#/components/schemas/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
}
}
},
"version": {
"type": "integer"
},
"is_group": {
"type": "boolean"
},
"is_moved": {
"type": "integer"
},
"priority": {
"type": "number"
},
"unlinked": {
"type": "integer",
"title": "Field to determine whether a channel has ever been shared/disconnected in the past"
},
"is_frozen": {
"type": "boolean"
},
"is_member": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/components/schemas/defs_ts"
},
"pin_count": {
"type": "integer"
},
"is_channel": {
"type": "boolean"
},
"is_general": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
},
"is_starred": {
"type": "boolean"
},
"is_archived": {
"type": "boolean"
},
"num_members": {
"type": "integer"
},
"is_read_only": {
"type": "boolean"
},
"unread_count": {
"type": "integer"
},
"accepted_user": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_ext_shared": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"display_counts": {
"type": "object",
"required": [
"display_counts",
"guest_counts"
],
"properties": {
"guest_counts": {
"type": "integer"
},
"display_counts": {
"type": "integer"
}
}
},
"is_thread_only": {
"type": "boolean"
},
"pending_shared": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"previous_names": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_channel_name"
},
"minItems": 0,
"uniqueItems": true
},
"timezone_count": {
"type": "integer"
},
"name_normalized": {
"type": "string"
},
"shared_team_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"internal_team_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"is_non_threadable": {
"type": "boolean"
},
"connected_team_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"minItems": 0,
"uniqueItems": true
},
"parent_conversation": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/defs_channel"
},
{
"nullable": true
}
]
}
},
"conversation_host_id": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"unread_count_display": {
"type": "integer"
},
"is_pending_ext_shared": {
"type": "boolean"
},
"pending_connected_team_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"minItems": 0,
"uniqueItems": true
}
}
},
{
"type": "object",
"title": "Conversation IM Channel Object from conversations.* methods",
"required": [
"id",
"created",
"is_im",
"is_org_shared",
"user",
"priority"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_dm_id"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"is_im": {
"type": "boolean"
},
"latest": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/objs_message"
},
{
"nullable": true
}
]
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"team",
"date_create",
"is_active"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_team"
},
"name": {
"type": "string"
},
"team": {
"$ref": "#/components/schemas/objs_team"
},
"is_active": {
"type": "boolean"
},
"date_create": {
"type": "integer"
}
}
},
"minItems": 0,
"uniqueItems": true
},
"created": {
"type": "integer"
},
"is_open": {
"type": "boolean"
},
"version": {
"type": "integer"
},
"has_pins": {
"type": "boolean"
},
"priority": {
"type": "number"
},
"is_frozen": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/components/schemas/defs_ts"
},
"pin_count": {
"type": "integer"
},
"is_starred": {
"type": "boolean"
},
"is_archived": {
"type": "boolean"
},
"unread_count": {
"type": "integer"
},
"is_ext_shared": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"is_user_deleted": {
"type": "boolean"
},
"parent_conversation": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/defs_channel"
},
{
"nullable": true
}
]
}
},
"unread_count_display": {
"type": "integer"
}
}
}
]
}
}
objs_enterprise_user
{
"type": "object",
"required": [
"id",
"enterprise_id",
"enterprise_name",
"is_admin",
"is_owner",
"teams"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_enterprise_user_id"
},
"teams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_team"
},
"uniqueItems": true
},
"is_admin": {
"type": "boolean"
},
"is_owner": {
"type": "boolean"
},
"enterprise_id": {
"$ref": "#/components/schemas/defs_enterprise_id"
},
"enterprise_name": {
"$ref": "#/components/schemas/defs_enterprise_name"
}
}
}
objs_external_org_migrations
{
"type": "object",
"title": "External Org Migrations",
"required": [
"date_updated",
"current"
],
"properties": {
"current": {
"type": "array",
"items": {
"type": "object",
"required": [
"team_id",
"date_started"
],
"properties": {
"team_id": {
"type": "string"
},
"date_started": {
"type": "integer"
}
}
}
},
"date_updated": {
"type": "integer"
}
}
}
objs_file
{
"type": "object",
"title": "file object",
"properties": {
"id": {
"$ref": "#/components/schemas/defs_file_id"
},
"ims": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_dm_id"
},
"uniqueItems": true
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
},
"user": {
"type": "string"
},
"state": {
"type": "string"
},
"title": {
"type": "string"
},
"editor": {
"$ref": "#/components/schemas/defs_user_id"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_group_id"
},
"uniqueItems": true
},
"shares": {
"type": "object",
"properties": {
"public": {
"additionalProperties": false
},
"private": {
"additionalProperties": false
}
}
},
"created": {
"type": "integer"
},
"preview": {
"type": "string"
},
"updated": {
"type": "integer"
},
"channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_channel_id"
},
"uniqueItems": true
},
"editable": {
"type": "boolean"
},
"filetype": {
"type": "string"
},
"mimetype": {
"type": "string"
},
"thumb_64": {
"type": "string",
"format": "uri"
},
"thumb_80": {
"type": "string",
"format": "uri"
},
"username": {
"type": "string"
},
"is_public": {
"type": "boolean"
},
"num_stars": {
"type": "integer"
},
"permalink": {
"type": "string",
"format": "uri"
},
"pinned_to": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_channel"
}
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_reaction"
}
},
"thumb_160": {
"type": "string",
"format": "uri"
},
"thumb_360": {
"type": "string",
"format": "uri"
},
"thumb_480": {
"type": "string",
"format": "uri"
},
"thumb_720": {
"type": "string",
"format": "uri"
},
"thumb_800": {
"type": "string",
"format": "uri"
},
"thumb_960": {
"type": "string",
"format": "uri"
},
"timestamp": {
"type": "integer"
},
"user_team": {
"$ref": "#/components/schemas/defs_team"
},
"is_starred": {
"type": "boolean"
},
"original_h": {
"type": "integer"
},
"original_w": {
"type": "integer"
},
"thumb_1024": {
"type": "string",
"format": "uri"
},
"thumb_tiny": {
"type": "string"
},
"date_delete": {
"type": "integer"
},
"external_id": {
"type": "string"
},
"is_external": {
"type": "boolean"
},
"last_editor": {
"$ref": "#/components/schemas/defs_user_id"
},
"pinned_info": {
"$ref": "#/components/schemas/defs_pinned_info"
},
"pretty_type": {
"type": "string"
},
"source_team": {
"$ref": "#/components/schemas/defs_team"
},
"thumb_360_h": {
"type": "integer"
},
"thumb_360_w": {
"type": "integer"
},
"thumb_480_h": {
"type": "integer"
},
"thumb_480_w": {
"type": "integer"
},
"thumb_720_h": {
"type": "integer"
},
"thumb_720_w": {
"type": "integer"
},
"thumb_800_h": {
"type": "integer"
},
"thumb_800_w": {
"type": "integer"
},
"thumb_960_h": {
"type": "integer"
},
"thumb_960_w": {
"type": "integer"
},
"url_private": {
"type": "string",
"format": "uri"
},
"external_url": {
"type": "string",
"format": "uri"
},
"thumb_1024_h": {
"type": "integer"
},
"thumb_1024_w": {
"type": "integer"
},
"external_type": {
"type": "string"
},
"is_tombstoned": {
"type": "boolean"
},
"comments_count": {
"type": "integer"
},
"display_as_bot": {
"type": "boolean"
},
"has_rich_preview": {
"type": "boolean"
},
"permalink_public": {
"type": "string",
"format": "uri"
},
"public_url_shared": {
"type": "boolean"
},
"non_owner_editable": {
"type": "boolean"
},
"image_exif_rotation": {
"type": "integer"
},
"url_private_download": {
"type": "string",
"format": "uri"
}
}
}
objs_icon
{
"type": "object",
"properties": {
"image_34": {
"type": "string"
},
"image_44": {
"type": "string"
},
"image_68": {
"type": "string"
},
"image_88": {
"type": "string"
},
"image_102": {
"type": "string"
},
"image_132": {
"type": "string"
},
"image_230": {
"type": "string"
},
"image_default": {
"type": "boolean"
}
}
}
objs_message
{
"type": "object",
"title": "Message object",
"required": [
"text",
"type",
"ts"
],
"properties": {
"ts": {
"$ref": "#/components/schemas/defs_ts"
},
"file": {
"$ref": "#/components/schemas/objs_file"
},
"name": {
"type": "string"
},
"team": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"text": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_file"
},
"minItems": 1,
"uniqueItems": true
},
"icons": {
"type": "object",
"properties": {
"emoji": {
"type": "string"
},
"image_64": {
"type": "string",
"format": "uri"
}
}
},
"topic": {
"type": "string"
},
"blocks": {
"$ref": "#/components/schemas/blocks"
},
"bot_id": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/defs_bot_id"
},
{
"title": "Nil bot_id set when display_as_bot is false",
"nullable": true
}
]
}
},
"upload": {
"type": "boolean"
},
"comment": {
"$ref": "#/components/schemas/objs_comment"
},
"inviter": {
"$ref": "#/components/schemas/defs_user_id"
},
"purpose": {
"type": "string"
},
"subtype": {
"type": "string"
},
"is_intro": {
"type": "boolean"
},
"old_name": {
"type": "string"
},
"username": {
"type": "string"
},
"last_read": {
"$ref": "#/components/schemas/defs_ts"
},
"permalink": {
"type": "string",
"format": "uri"
},
"pinned_to": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_channel"
}
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_reaction"
}
},
"thread_ts": {
"$ref": "#/components/schemas/defs_ts"
},
"user_team": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"is_starred": {
"type": "boolean"
},
"subscribed": {
"type": "boolean"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
},
"fallback": {
"type": "string"
},
"image_url": {
"type": "string"
},
"image_bytes": {
"type": "integer"
},
"image_width": {
"type": "integer"
},
"image_height": {
"type": "integer"
}
}
},
"minItems": 1,
"uniqueItems": true
},
"bot_profile": {
"$ref": "#/components/schemas/objs_bot_profile"
},
"reply_count": {
"type": "integer"
},
"reply_users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_user_id"
},
"minItems": 1,
"uniqueItems": true
},
"source_team": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"latest_reply": {
"$ref": "#/components/schemas/defs_ts"
},
"unread_count": {
"type": "integer"
},
"user_profile": {
"$ref": "#/components/schemas/objs_user_profile_short"
},
"client_msg_id": {
"type": "string"
},
"display_as_bot": {
"type": "boolean"
},
"parent_user_id": {
"$ref": "#/components/schemas/defs_user_id"
},
"reply_users_count": {
"type": "integer"
},
"is_delayed_message": {
"type": "boolean"
}
}
}
objs_paging
{
"type": "object",
"title": "paging object",
"required": [
"page",
"total"
],
"properties": {
"page": {
"type": "integer"
},
"count": {
"type": "integer"
},
"pages": {
"type": "integer"
},
"spill": {
"type": "integer"
},
"total": {
"type": "integer"
},
"per_page": {
"type": "integer"
}
}
}
objs_primary_owner
{
"type": "object",
"required": [
"id",
"email"
],
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
objs_reaction
{
"type": "object",
"title": "Reaction object",
"required": [
"name",
"users",
"count"
],
"properties": {
"name": {
"type": "string"
},
"count": {
"type": "integer"
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_user_id"
}
}
},
"additionalProperties": true
}
objs_reminder
{
"type": "object",
"required": [
"id",
"creator",
"user",
"text",
"recurring"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_reminder_id"
},
"text": {
"type": "string"
},
"time": {
"type": "integer"
},
"user": {
"$ref": "#/components/schemas/defs_user_id"
},
"creator": {
"$ref": "#/components/schemas/defs_user_id"
},
"recurring": {
"type": "boolean"
},
"complete_ts": {
"type": "integer"
}
}
}
objs_resources
{
"type": "object",
"title": "resources in info from apps.permissions.info",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/defs_channel"
},
{
"$ref": "#/components/schemas/defs_team"
}
]
}
}
},
"wildcard": {
"type": "boolean"
},
"excluded_ids": {
"type": "array",
"items": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/defs_channel"
},
{
"$ref": "#/components/schemas/defs_team"
}
]
}
}
}
}
}
objs_response_metadata
{
"items": {
"anyOf": [
{
"type": "object",
"title": "new paging style",
"required": [
"next_cursor"
],
"properties": {
"next_cursor": {
"type": "string"
}
}
},
{
"type": "object",
"title": "deprecation_warning",
"required": [
"messages",
"warnings"
],
"properties": {
"messages": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"enum": [
"method_deprecated"
],
"type": "string"
}
}
}
},
{
"type": "object",
"title": "deprecation_warning and paging style together",
"required": [
"messages",
"warnings",
"next_cursor"
],
"properties": {
"messages": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"enum": [
"method_deprecated"
],
"type": "string"
}
},
"next_cursor": {
"type": "string"
}
}
}
]
}
}
objs_scopes
{
"type": "array",
"items": {
"type": "string",
"title": "Named OAuth scopes",
"x-examples": [
"chat:write",
"im:history",
"im:read"
]
}
}
objs_subteam
{
"type": "object",
"title": "Subteam/Usergroup Object",
"required": [
"id",
"team_id",
"is_usergroup",
"is_subteam",
"name",
"description",
"handle",
"is_external",
"date_create",
"date_update",
"date_delete",
"auto_type",
"auto_provision",
"enterprise_subteam_id",
"created_by",
"updated_by",
"deleted_by",
"prefs"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_subteam_id"
},
"name": {
"type": "string"
},
"prefs": {
"type": "object",
"required": [
"channels",
"groups"
],
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_group_id"
}
},
"channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_channel_id"
}
}
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_user_id"
}
},
"handle": {
"type": "string"
},
"team_id": {
"$ref": "#/components/schemas/defs_team"
},
"auto_type": {
"items": {
"anyOf": [
{
"nullable": true
},
{
"enum": [
"owner",
"admin"
],
"type": "string"
}
]
}
},
"created_by": {
"$ref": "#/components/schemas/defs_user_id"
},
"deleted_by": {
"items": {
"anyOf": [
{
"nullable": true
},
{
"$ref": "#/components/schemas/defs_user_id"
}
]
}
},
"is_subteam": {
"type": "boolean"
},
"updated_by": {
"$ref": "#/components/schemas/defs_user_id"
},
"user_count": {
"type": "integer"
},
"date_create": {
"type": "integer"
},
"date_delete": {
"type": "integer"
},
"date_update": {
"type": "integer"
},
"description": {
"type": "string"
},
"is_external": {
"type": "boolean"
},
"is_usergroup": {
"type": "boolean"
},
"channel_count": {
"type": "integer"
},
"auto_provision": {
"type": "boolean"
},
"enterprise_subteam_id": {
"type": "string"
}
}
}
objs_team
{
"type": "object",
"title": "Team Object",
"required": [
"id",
"name",
"domain",
"email_domain",
"icon"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"icon": {
"$ref": "#/components/schemas/objs_icon"
},
"name": {
"type": "string"
},
"plan": {
"enum": [
"",
"std",
"plus",
"compliance",
"enterprise"
],
"type": "string"
},
"domain": {
"type": "string"
},
"locale": {
"type": "string"
},
"created": {
"type": "integer"
},
"deleted": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"limit_ts": {
"type": "integer"
},
"date_create": {
"type": "integer"
},
"description": {
"type": "string",
"nullable": true
},
"is_assigned": {
"type": "boolean"
},
"discoverable": {
"items": {
"anyOf": [
{
"nullable": true
},
{
"type": "string"
}
]
}
},
"email_domain": {
"type": "string"
},
"pay_prod_cur": {
"type": "string"
},
"sso_provider": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"label": {
"type": "string"
}
}
},
"enterprise_id": {
"$ref": "#/components/schemas/defs_enterprise_id"
},
"is_enterprise": {
"type": "integer"
},
"primary_owner": {
"$ref": "#/components/schemas/objs_primary_owner"
},
"messages_count": {
"type": "integer"
},
"avatar_base_url": {
"type": "string",
"format": "uri"
},
"enterprise_name": {
"$ref": "#/components/schemas/defs_enterprise_name"
},
"over_storage_limit": {
"type": "boolean"
},
"msg_edit_window_mins": {
"type": "integer"
},
"has_compliance_export": {
"type": "boolean"
},
"is_over_storage_limit": {
"type": "boolean"
},
"external_org_migrations": {
"$ref": "#/components/schemas/objs_external_org_migrations"
},
"over_integrations_limit": {
"type": "boolean"
}
}
}
objs_team_profile_field
{
"type": "object",
"required": [
"id",
"ordering",
"label",
"hint",
"type"
],
"properties": {
"id": {
"type": "string",
"pattern": "^X[a-zA-Z0-9]{9,}$"
},
"hint": {
"type": "string"
},
"type": {
"enum": [
"text",
"date",
"link",
"mailto",
"options_list",
"user"
],
"type": "string"
},
"label": {
"type": "string"
},
"options": {
"items": {
"anyOf": [
{
"nullable": true
},
{
"$ref": "#/components/schemas/objs_team_profile_field_option"
}
]
}
},
"ordering": {
"type": "number"
},
"is_hidden": {
"type": "boolean"
},
"field_name": {
"type": "string",
"nullable": true
},
"possible_values": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
}
objs_team_profile_field_option
{
"type": "object",
"properties": {
"is_scim": {
"type": "boolean",
"nullable": true
},
"is_custom": {
"type": "boolean",
"nullable": true
},
"is_protected": {
"type": "boolean",
"nullable": true
},
"is_multiple_entry": {
"type": "boolean",
"nullable": true
}
}
}
objs_user
{
"items": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"name",
"profile",
"is_bot",
"updated",
"is_app_user"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_user_id"
},
"tz": {
"items": {
"anyOf": [
{
"nullable": true
},
{
"type": "string"
}
]
}
},
"name": {
"type": "string"
},
"team": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"color": {
"type": "string",
"pattern": "^[a-fA-F0-9]{6}$"
},
"is_bot": {
"type": "boolean"
},
"locale": {
"type": "string"
},
"deleted": {
"type": "boolean"
},
"has_2fa": {
"type": "boolean"
},
"profile": {
"$ref": "#/components/schemas/objs_user_profile"
},
"team_id": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"updated": {
"type": "number"
},
"is_admin": {
"type": "boolean"
},
"is_owner": {
"type": "boolean"
},
"presence": {
"type": "string"
},
"tz_label": {
"type": "string"
},
"real_name": {
"type": "string"
},
"tz_offset": {
"type": "number"
},
"is_app_user": {
"type": "boolean"
},
"is_external": {
"type": "boolean"
},
"is_stranger": {
"type": "boolean"
},
"is_forgotten": {
"type": "boolean"
},
"team_profile": {
"type": "object",
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_team_profile_field"
},
"minItems": 1,
"uniqueItems": true
}
}
},
"is_restricted": {
"type": "boolean"
},
"enterprise_user": {
"$ref": "#/components/schemas/objs_enterprise_user"
},
"is_invited_user": {
"type": "boolean"
},
"two_factor_type": {
"type": "string"
},
"is_primary_owner": {
"type": "boolean"
},
"is_ultra_restricted": {
"type": "boolean"
}
},
"description": "user object for non enterprise type"
},
{
"type": "object",
"required": [
"id",
"name",
"profile",
"is_bot",
"updated",
"is_app_user"
],
"properties": {
"id": {
"$ref": "#/components/schemas/defs_user_id"
},
"tz": {
"items": {
"anyOf": [
{
"nullable": true
},
{
"type": "string"
}
]
}
},
"name": {
"type": "string"
},
"color": {
"type": "string",
"pattern": "^([a-fA-F0-9]{6})?$",
"description": "refercing to bug: https://jira.tinyspeck.com/browse/EVALUE-1559"
},
"teams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"minItems": 1,
"uniqueItems": true
},
"is_bot": {
"type": "boolean"
},
"locale": {
"type": "string"
},
"deleted": {
"type": "boolean"
},
"has_2fa": {
"type": "boolean"
},
"profile": {
"$ref": "#/components/schemas/objs_user_profile"
},
"team_id": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"updated": {
"type": "number"
},
"is_admin": {
"type": "boolean"
},
"is_owner": {
"type": "boolean"
},
"presence": {
"type": "string"
},
"tz_label": {
"type": "string"
},
"real_name": {
"type": "string"
},
"tz_offset": {
"type": "number"
},
"is_app_user": {
"type": "boolean"
},
"is_external": {
"type": "boolean"
},
"is_stranger": {
"type": "boolean"
},
"is_forgotten": {
"type": "boolean"
},
"team_profile": {
"type": "object",
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/objs_team_profile_field"
},
"minItems": 1,
"uniqueItems": true
}
}
},
"is_restricted": {
"type": "boolean"
},
"enterprise_user": {
"$ref": "#/components/schemas/objs_enterprise_user"
},
"two_factor_type": {
"type": "string"
},
"is_primary_owner": {
"type": "boolean"
},
"is_ultra_restricted": {
"type": "boolean"
}
},
"description": "enterprise user"
}
]
}
}
objs_user_profile
{
"type": "object",
"title": "User profile object",
"required": [
"real_name",
"display_name",
"avatar_hash",
"real_name_normalized",
"display_name_normalized",
"title",
"phone",
"skype",
"status_text",
"status_emoji",
"fields"
],
"properties": {
"name": {
"type": "string",
"nullable": true
},
"team": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"email": {
"type": "string",
"format": "email",
"nullable": true
},
"phone": {
"type": "string"
},
"skype": {
"type": "string"
},
"title": {
"type": "string"
},
"bot_id": {
"$ref": "#/components/schemas/defs_bot_id"
},
"fields": {
"items": {
"type": "object"
},
"oneOf": [
{
"type": "object"
},
{
"type": "array",
"items": {}
}
],
"nullable": true
},
"updated": {
"type": "integer"
},
"user_id": {
"type": "string"
},
"image_24": {
"type": "string",
"format": "uri",
"nullable": true
},
"image_32": {
"type": "string",
"format": "uri",
"nullable": true
},
"image_48": {
"type": "string",
"format": "uri",
"nullable": true
},
"image_72": {
"type": "string",
"format": "uri",
"nullable": true
},
"pronouns": {
"type": "string"
},
"username": {
"type": "string",
"nullable": true
},
"image_192": {
"type": "string",
"format": "uri",
"nullable": true
},
"image_512": {
"type": "string",
"format": "uri",
"nullable": true
},
"last_name": {
"type": "string",
"nullable": true
},
"real_name": {
"type": "string"
},
"api_app_id": {
"$ref": "#/components/schemas/defs_optional_app_id"
},
"first_name": {
"type": "string",
"nullable": true
},
"image_1024": {
"type": "string",
"format": "uri",
"nullable": true
},
"avatar_hash": {
"type": "string"
},
"is_app_user": {
"type": "boolean"
},
"status_text": {
"type": "string"
},
"display_name": {
"type": "string"
},
"status_emoji": {
"type": "string"
},
"always_active": {
"type": "boolean"
},
"is_restricted": {
"type": "boolean",
"nullable": true
},
"image_original": {
"type": "string",
"format": "uri",
"nullable": true
},
"is_custom_image": {
"type": "boolean"
},
"guest_invited_by": {
"type": "string",
"nullable": true
},
"memberships_count": {
"type": "integer"
},
"status_expiration": {
"type": "integer"
},
"guest_expiration_ts": {
"type": "integer",
"nullable": true
},
"is_ultra_restricted": {
"type": "boolean",
"nullable": true
},
"status_default_text": {
"type": "string"
},
"real_name_normalized": {
"type": "string"
},
"status_default_emoji": {
"type": "string"
},
"status_text_canonical": {
"type": "string",
"nullable": true
},
"last_avatar_image_hash": {
"type": "string"
},
"display_name_normalized": {
"type": "string"
},
"status_default_text_canonical": {
"type": "string",
"nullable": true
}
}
}
objs_user_profile_short
{
"type": "object",
"required": [
"avatar_hash",
"image_72",
"first_name",
"real_name",
"display_name",
"team",
"name",
"is_restricted",
"is_ultra_restricted"
],
"properties": {
"name": {
"type": "string"
},
"team": {
"$ref": "#/components/schemas/defs_workspace_id"
},
"image_72": {
"type": "string",
"format": "uri"
},
"real_name": {
"type": "string"
},
"first_name": {
"type": "string",
"nullable": true
},
"avatar_hash": {
"type": "string"
},
"display_name": {
"type": "string"
},
"is_restricted": {
"type": "boolean"
},
"is_ultra_restricted": {
"type": "boolean"
},
"real_name_normalized": {
"type": "string"
},
"display_name_normalized": {
"type": "string"
}
}
}