Slack Web API
  1. conversations
Slack Web API
  • admin.apps
    • /admin.apps.approve
      POST
    • /admin.apps.restrict
      POST
  • admin.apps.approved
    • /admin.apps.approved.list
      GET
  • admin.apps.requests
    • /admin.apps.requests.list
      GET
  • admin.apps.restricted
    • /admin.apps.restricted.list
      GET
  • admin.conversations
    • /admin.conversations.archive
      POST
    • /admin.conversations.convertToPrivate
      POST
    • /admin.conversations.create
      POST
    • /admin.conversations.delete
      POST
    • /admin.conversations.disconnectShared
      POST
    • /admin.conversations.getConversationPrefs
      GET
    • /admin.conversations.getTeams
      GET
    • /admin.conversations.invite
      POST
    • /admin.conversations.rename
      POST
    • /admin.conversations.search
      GET
    • /admin.conversations.setConversationPrefs
      POST
    • /admin.conversations.setTeams
      POST
    • /admin.conversations.unarchive
      POST
  • admin.conversations.ekm
    • /admin.conversations.ekm.listOriginalConnectedChannelInfo
  • admin.conversations.restrictAccess
    • /admin.conversations.restrictAccess.addGroup
    • /admin.conversations.restrictAccess.listGroups
    • /admin.conversations.restrictAccess.removeGroup
  • admin.emoji
    • /admin.emoji.add
    • /admin.emoji.addAlias
    • /admin.emoji.list
    • /admin.emoji.remove
    • /admin.emoji.rename
  • admin.inviteRequests
    • /admin.inviteRequests.approve
    • /admin.inviteRequests.deny
    • /admin.inviteRequests.list
  • admin.inviteRequests.approved
    • /admin.inviteRequests.approved.list
  • admin.inviteRequests.denied
    • /admin.inviteRequests.denied.list
  • admin.teams.admins
    • /admin.teams.admins.list
  • admin.teams
    • /admin.teams.create
    • /admin.teams.list
  • admin.teams.owners
    • /admin.teams.owners.list
  • admin.teams.settings
    • /admin.teams.settings.info
    • /admin.teams.settings.setDefaultChannels
    • /admin.teams.settings.setDescription
    • /admin.teams.settings.setDiscoverability
    • /admin.teams.settings.setIcon
    • /admin.teams.settings.setName
  • admin.usergroups
    • /admin.usergroups.addChannels
    • /admin.usergroups.addTeams
    • /admin.usergroups.listChannels
    • /admin.usergroups.removeChannels
  • admin.users
    • /admin.users.assign
    • /admin.users.invite
    • /admin.users.list
    • /admin.users.remove
    • /admin.users.setAdmin
    • /admin.users.setExpiration
    • /admin.users.setOwner
    • /admin.users.setRegular
  • admin.users.session
    • /admin.users.session.invalidate
    • /admin.users.session.reset
  • api
    • /api.test
  • apps.event.authorizations
    • /apps.event.authorizations.list
  • apps.permissions
    • /apps.permissions.info
    • /apps.permissions.request
  • apps.permissions.resources
    • /apps.permissions.resources.list
  • apps.permissions.scopes
    • /apps.permissions.scopes.list
  • apps.permissions.users
    • /apps.permissions.users.list
    • /apps.permissions.users.request
  • apps
    • /apps.uninstall
  • auth
    • /auth.revoke
    • /auth.test
  • bots
    • /bots.info
  • calls
    • /calls.add
    • /calls.end
    • /calls.info
    • /calls.update
  • calls.participants
    • /calls.participants.add
    • /calls.participants.remove
  • chat
    • /chat.delete
    • /chat.deleteScheduledMessage
    • /chat.getPermalink
    • /chat.meMessage
    • /chat.postEphemeral
    • /chat.postMessage
    • /chat.scheduleMessage
    • /chat.unfurl
    • /chat.update
  • chat.scheduledMessages
    • /chat.scheduledMessages.list
  • conversations
    • /conversations.archive
      POST
    • /conversations.close
      POST
    • /conversations.create
      POST
    • /conversations.history
      GET
    • /conversations.info
      GET
    • /conversations.invite
      POST
    • /conversations.join
      POST
    • /conversations.kick
      POST
    • /conversations.leave
      POST
    • /conversations.list
      GET
    • /conversations.mark
      POST
    • /conversations.members
      GET
    • /conversations.open
      POST
    • /conversations.rename
      POST
    • /conversations.replies
      GET
    • /conversations.setPurpose
      POST
    • /conversations.setTopic
      POST
    • /conversations.unarchive
      POST
  • dialog
    • /dialog.open
  • dnd
    • /dnd.endDnd
    • /dnd.endSnooze
    • /dnd.info
    • /dnd.setSnooze
    • /dnd.teamInfo
  • emoji
    • /emoji.list
  • files.comments
    • /files.comments.delete
  • files
    • /files.delete
    • /files.info
    • /files.list
    • /files.revokePublicURL
    • /files.sharedPublicURL
    • /files.upload
  • files.remote
    • /files.remote.add
    • /files.remote.info
    • /files.remote.list
    • /files.remote.remove
    • /files.remote.share
    • /files.remote.update
  • migration
    • /migration.exchange
  • oauth
    • /oauth.access
    • /oauth.token
  • oauth.v2
    • /oauth.v2.access
  • pins
    • /pins.add
    • /pins.list
    • /pins.remove
  • reactions
    • /reactions.add
    • /reactions.get
    • /reactions.list
    • /reactions.remove
  • reminders
    • /reminders.add
    • /reminders.complete
    • /reminders.delete
    • /reminders.info
    • /reminders.list
  • rtm
    • /rtm.connect
  • search
    • /search.messages
  • stars
    • /stars.add
    • /stars.list
    • /stars.remove
  • team
    • /team.accessLogs
    • /team.billableInfo
    • /team.info
    • /team.integrationLogs
  • team.profile
    • /team.profile.get
  • usergroups
    • /usergroups.create
    • /usergroups.disable
    • /usergroups.enable
    • /usergroups.list
    • /usergroups.update
  • usergroups.users
    • /usergroups.users.list
    • /usergroups.users.update
  • users
    • /users.conversations
    • /users.deletePhoto
    • /users.getPresence
    • /users.identity
    • /users.info
    • /users.list
    • /users.lookupByEmail
    • /users.setActive
    • /users.setPhoto
    • /users.setPresence
  • users.profile
    • /users.profile.get
    • /users.profile.set
  • views
    • /views.open
    • /views.publish
    • /views.push
    • /views.update
  • workflows
    • /workflows.stepCompleted
    • /workflows.stepFailed
    • /workflows.updateStep
  1. conversations

/conversations.invite

POST
/conversations.invite
conversations
Invites users to a channel.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://slack.com/api/conversations.invite'
Response Response Example
200 - response
{
    "channel": {
        "created": 1449252889,
        "creator": "W012A3BCD",
        "id": "C012AB3CD",
        "is_archived": false,
        "is_channel": true,
        "is_ext_shared": false,
        "is_general": true,
        "is_group": false,
        "is_im": false,
        "is_member": true,
        "is_mpim": false,
        "is_org_shared": false,
        "is_pending_ext_shared": false,
        "is_private": false,
        "is_read_only": false,
        "is_shared": false,
        "last_read": "1502126650.228446",
        "locale": "en-US",
        "name": "general",
        "name_normalized": "general",
        "num_members": 23,
        "pending_shared": [],
        "previous_names": [
            "specifics",
            "abstractions",
            "etc"
        ],
        "purpose": {
            "creator": "W012A3BCD",
            "last_set": 1449709364,
            "value": "This part of the workspace is for fun. Make fun here."
        },
        "topic": {
            "creator": "W012A3BCD",
            "last_set": 1449709364,
            "value": "For public discussion of generalities"
        },
        "unlinked": 0
    },
    "ok": true
}

Request

Header Params
token
string 
optional
Authentication token. Requires scope: conversations:write
Body Params application/x-www-form-urlencoded
channel
string 
optional
The ID of the public or private channel to invite user(s) to.
users
string 
optional
A comma separated list of user IDs. Up to 1000 users may be listed.

Responses

🟢200Typical success response when an invitation is extended
application/json
Body
Schema for successful response from conversations.invite method
channel
array [anyOf] 
required
object 
Conversation object
optional
object 
Conversation MPIM Object
optional
object 
Conversation IM Channel Object from conversations.* methods
optional
ok
enum<boolean> 
required
Allowed value:
true
🔴500Typical error response when an invite is attempted on a conversation type that does not support it
Previous
/conversations.info
Next
/conversations.join
Built with