Slack Participants API

The Participants API from Slack — 2 operation(s) for participants.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

slack-participants-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  version: '1.0'
  title: Slack Admin Access Participants API
  description: "The Slack Admin API is a set of privileged endpoints\x14primarily under admin.* with related SCIM and Audit Logs APIs\x14that lets Enterprise Grid owners and admins automate organization\x11 wide management and governance. It covers user lifecycle (provision, suspend, assign roles), workspace and channel administration across workspaces (create, move, archive channels; manage membership and settings), app governance (approve/deny or allowlist/ban apps and install them to workspaces), invite request handling, and security/compliance controls such as information barriers, session and authentication policies, and org\x11level analytics exports. These APIs require elevated admin scopes and are commonly used to power automated onboarding/offboarding, centralized channel and app controls, and integrations with identity, ITSM, and compliance systems."
tags:
- name: Participants
paths:
  /calls.participants.add:
    post:
      tags:
      - Participants
      description: Registers new participants added to a Call.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/calls.participants.add
      operationId: calls_participants_add
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `calls:write`'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - id
              - users
              type: object
              properties:
                id:
                  type: string
                  description: '`id` returned by the [`calls.add`](/methods/calls.add) method.'
                users:
                  type: string
                  description: The list of users to add as participants in the Call. [Read more on how to specify users here](/apis/calls#users).
          application/json:
            schema:
              required:
              - id
              - users
              type: object
              properties:
                id:
                  type: string
                  description: '`id` returned by the [`calls.add`](/methods/calls.add) method.'
                users:
                  type: string
                  description: The list of users to add as participants in the Call. [Read more on how to specify users here](/apis/calls#users).
        required: true
      responses:
        '200':
          description: Typical success response
          content:
            application/json:
              schema:
                title: Default success template
                required:
                - ok
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                additionalProperties: true
                description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
              example:
                ok: true
        default:
          description: Typical error response
          content:
            application/json:
              schema:
                title: Default error template
                required:
                - ok
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties: true
                description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
              example:
                error: invalid_auth
                ok: false
      security:
      - slackAuth:
        - calls:write
      summary: Slack Post Calls Participants Add
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        PascalCaseOperationTags: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /calls.participants.remove:
    post:
      tags:
      - Participants
      description: Registers participants removed from a Call.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/calls.participants.remove
      operationId: calls_participants_remove
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `calls:write`'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - id
              - users
              type: object
              properties:
                id:
                  type: string
                  description: '`id` returned by the [`calls.add`](/methods/calls.add) method.'
                users:
                  type: string
                  description: The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users).
          application/json:
            schema:
              required:
              - id
              - users
              type: object
              properties:
                id:
                  type: string
                  description: '`id` returned by the [`calls.add`](/methods/calls.add) method.'
                users:
                  type: string
                  description: The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users).
        required: true
      responses:
        '200':
          description: Typical success response
          content:
            application/json:
              schema:
                title: Default success template
                required:
                - ok
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                additionalProperties: true
                description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
              example:
                ok: true
        default:
          description: Typical error response
          content:
            application/json:
              schema:
                title: Default error template
                required:
                - ok
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties: true
                description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
              example:
                error: invalid_auth
                ok: false
      security:
      - slackAuth:
        - calls:write
      summary: Slack Post Calls Participants Remove
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        PascalCaseOperationTags: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK