Discord Partner Sdk API

openapi: 3.2.0
info:
  title: Discord HTTP API (Preview) Partner Sdk API
  description: Preview of the Discord v10 HTTP API specification. See https://discord.com/developers/docs for more details.
  termsOfService: https://discord.com/developers/docs/policies-and-agreements/developer-terms-of-service
  license:
    name: MIT
    identifier: MIT
  version: '10'
servers:
- url: https://discord.com/api/v10
tags:
- name: Partner Sdk
paths:
  /partner-sdk/dms/{user_id_1}/{user_id_2}/messages/{message_id}/moderation-metadata:
    parameters:
    - name: user_id_1
      in: path
      schema:
        $ref: '#/components/schemas/SnowflakeType'
      required: true
    - name: user_id_2
      in: path
      schema:
        $ref: '#/components/schemas/SnowflakeType'
      required: true
    - name: message_id
      in: path
      schema:
        $ref: '#/components/schemas/SnowflakeType'
      required: true
    put:
      description: Update the external moderation metadata for a user message (DM).
      operationId: update_user_message_external_moderation_metadata
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: The moderation metadata attached to the message
              additionalProperties:
                type: string
                maxLength: 2000
              maxProperties: 5
          application/x-www-form-urlencoded:
            schema:
              type: object
              description: The moderation metadata attached to the message
              additionalProperties:
                type: string
                maxLength: 2000
              maxProperties: 5
          multipart/form-data:
            schema:
              type: object
              description: The moderation metadata attached to the message
              additionalProperties:
                type: string
                maxLength: 2000
              maxProperties: 5
        required: true
      responses:
        '204':
          description: 204 response for update_user_message_external_moderation_metadata
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-RateLimit-Reset-After:
              $ref: '#/components/headers/X-RateLimit-Reset-After'
            X-RateLimit-Bucket:
              $ref: '#/components/headers/X-RateLimit-Bucket'
        '429':
          $ref: '#/components/responses/ClientRatelimitedResponse'
        4XX:
          $ref: '#/components/responses/ClientErrorResponse'
      security:
      - BotToken: []
      tags:
      - Partner Sdk
      summary: Update user message external moderation metadata
      x-summary-source: derived
  /partner-sdk/provisional-accounts/unmerge:
    post:
      operationId: partner_sdk_unmerge_provisional_account
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  $ref: '#/components/schemas/SnowflakeType'
                client_secret:
                  type:
                  - string
                  - 'null'
                  maxLength: 1024
                external_auth_token:
                  type: string
                  minLength: 1
                  maxLength: 10240
                external_auth_type:
                  $ref: '#/components/schemas/ApplicationIdentityProviderAuthType'
              required:
              - client_id
              - external_auth_token
              - external_auth_type
        required: true
      responses:
        '204':
          description: 204 response for partner_sdk_unmerge_provisional_account
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-RateLimit-Reset-After:
              $ref: '#/components/headers/X-RateLimit-Reset-After'
            X-RateLimit-Bucket:
              $ref: '#/components/headers/X-RateLimit-Bucket'
        '429':
          $ref: '#/components/responses/ClientRatelimitedResponse'
        4XX:
          $ref: '#/components/responses/ClientErrorResponse'
      security:
      - {}
      - BotToken: []
      tags:
      - Partner Sdk
      summary: Partner sdk unmerge provisional account
      x-summary-source: derived
  /partner-sdk/provisional-accounts/unmerge/bot:
    post:
      operationId: bot_partner_sdk_unmerge_provisional_account
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                external_user_id:
                  type: string
                  minLength: 1
                  maxLength: 1024
              required:
              - external_user_id
        required: true
      responses:
        '204':
          description: 204 response for bot_partner_sdk_unmerge_provisional_account
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-RateLimit-Reset-After:
              $ref: '#/components/headers/X-RateLimit-Reset-After'
            X-RateLimit-Bucket:
              $ref: '#/components/headers/X-RateLimit-Bucket'
        '429':
          $ref: '#/components/responses/ClientRatelimitedResponse'
        4XX:
          $ref: '#/components/responses/ClientErrorResponse'
      security:
      - BotToken: []
      tags:
      - Partner Sdk
      summary: Bot partner sdk unmerge provisional account
      x-summary-source: derived
  /partner-sdk/token:
    post:
      operationId: partner_sdk_token
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  $ref: '#/components/schemas/SnowflakeType'
                client_secret:
                  type:
                  - string
                  - 'null'
                  maxLength: 1024
                external_auth_token:
                  type: string
                  minLength: 1
                  maxLength: 10240
                external_auth_type:
                  $ref: '#/components/schemas/ApplicationIdentityProviderAuthType'
              required:
              - client_id
              - external_auth_token
              - external_auth_type
        required: true
      responses:
        '200':
          description: 200 response for partner_sdk_token
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-RateLimit-Reset-After:
              $ref: '#/components/headers/X-RateLimit-Reset-After'
            X-RateLimit-Bucket:
              $ref: '#/components/headers/X-RateLimit-Bucket'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisionalTokenResponse'
        '429':
          $ref: '#/components/responses/ClientRatelimitedResponse'
        4XX:
          $ref: '#/components/responses/ClientErrorResponse'
      security:
      - {}
      - BotToken: []
      tags:
      - Partner Sdk
      summary: Partner sdk token
      x-summary-source: derived
  /partner-sdk/token/bot:
    post:
      operationId: bot_partner_sdk_token
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                provisional_user_id:
                  oneOf:
                  - type: 'null'
                  - $ref: '#/components/schemas/SnowflakeType'
                external_user_id:
                  type: string
                  minLength: 1
                  maxLength: 1024
                preferred_global_name:
                  type:
                  - string
                  - 'null'
                  minLength: 1
                  maxLength: 32
              required:
              - external_user_id
        required: true
      responses:
        '200':
          description: 200 response for bot_partner_sdk_token
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-RateLimit-Reset-After:
              $ref: '#/components/headers/X-RateLimit-Reset-After'
            X-RateLimit-Bucket:
              $ref: '#/components/headers/X-RateLimit-Bucket'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisionalTokenResponse'
        '429':
          $ref: '#/components/responses/ClientRatelimitedResponse'
        4XX:
          $ref: '#/components/responses/ClientErrorResponse'
      security:
      - BotToken: []
      tags:
      - Partner Sdk
      summary: Bot partner sdk token
      x-summary-source: derived
components:
  headers:
    X-RateLimit-Reset-After:
      schema:
        type: number
      description: The duration in seconds until the current ratelimit window resets
    X-RateLimit-Limit:
      schema:
        type: integer
      description: The maximum number of requests that can be made in the current ratelimit window
    X-RateLimit-Remaining:
      schema:
        type: integer
      description: The number of requests remaining in the current ratelimit window
    X-RateLimit-Bucket:
      schema:
        type: string
      description: The bucket that the request belongs to
    X-RateLimit-Reset:
      schema:
        type: number
      description: A unix timestamp in seconds at which the current ratelimit window resets
  schemas:
    InnerErrors:
      type: object
      properties:
        _errors:
          type: array
          description: The list of errors for this field
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
      required:
      - _errors
    ErrorResponse:
      type: object
      description: Errors object returned by the Discord API
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          errors:
            $ref: '#/components/schemas/ErrorDetails'
    ErrorDetails:
      oneOf:
      - type: object
        additionalProperties:
          $ref: '#/components/schemas/ErrorDetails'
      - $ref: '#/components/schemas/InnerErrors'
    SnowflakeType:
      type: string
      pattern: ^(0|[1-9][0-9]*)$
      format: snowflake
    ApplicationIdentityProviderAuthType:
      type: string
      oneOf:
      - title: OIDC
        const: OIDC
      - title: EPIC_ONLINE_SERVICES_ACCESS_TOKEN
        const: EPIC_ONLINE_SERVICES_ACCESS_TOKEN
      - title: EPIC_ONLINE_SERVICES_ID_TOKEN
        const: EPIC_ONLINE_SERVICES_ID_TOKEN
      - title: STEAM_SESSION_TICKET
        const: STEAM_SESSION_TICKET
      - title: UNITY_SERVICES_ID_TOKEN
        const: UNITY_SERVICES_ID_TOKEN
      - title: DISCORD_BOT_ISSUED_ACCESS_TOKEN
        const: DISCORD_BOT_ISSUED_ACCESS_TOKEN
      - title: APPLE_ID_TOKEN
        const: APPLE_ID_TOKEN
      - title: PLAYSTATION_NETWORK_ID_TOKEN
        const: PLAYSTATION_NETWORK_ID_TOKEN
    RatelimitedResponse:
      type: object
      description: Ratelimit error object returned by the Discord API
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          retry_after:
            type: number
            description: The number of seconds to wait before retrying your request
          global:
            type: boolean
            description: Whether you are being ratelimited by the global ratelimit or a per-endpoint ratelimit
        required:
        - retry_after
        - global
    Error:
      type: object
      description: A single error, either for an API response or a specific field.
      properties:
        code:
          type: integer
          description: Discord internal error code. See error code reference
        message:
          type: string
          description: Human-readable error message
      required:
      - code
      - message
    ProvisionalTokenResponse:
      type: object
      properties:
        token_type:
          type: string
        access_token:
          type: string
        expires_in:
          type: integer
          format: int32
        scope:
          type: string
        id_token:
          type: string
        refresh_token:
          type:
          - string
          - 'null'
        scopes:
          type:
          - array
          - 'null'
          items:
            type: string
        expires_at_s:
          type:
          - integer
          - 'null'
          format: int32
      required:
      - token_type
      - access_token
      - expires_in
      - scope
      - id_token
  responses:
    ClientRatelimitedResponse:
      description: Client ratelimited response
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-RateLimit-Reset-After:
          $ref: '#/components/headers/X-RateLimit-Reset-After'
        X-RateLimit-Bucket:
          $ref: '#/components/headers/X-RateLimit-Bucket'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RatelimitedResponse'
    ClientErrorResponse:
      description: Client error response
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-RateLimit-Reset-After:
          $ref: '#/components/headers/X-RateLimit-Reset-After'
        X-RateLimit-Bucket:
          $ref: '#/components/headers/X-RateLimit-Bucket'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BotToken:
      type: apiKey
      description: Discord bot token
      name: Authorization
      in: header
    OAuth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://discord.com/api/oauth2/authorize
          refreshUrl: https://discord.com/api/oauth2/token
          scopes:
            activities.invites.write: allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
            activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
            activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
            applications.builds.read: allows your app to read build data for a user's applications
            applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
            applications.commands: allows your app to use commands in a guild
            applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
            applications.entitlements: allows your app to read entitlements for a user's applications
            applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
            bot: for oauth2 bots, this puts the bot in the user's selected guild by default
            connections: allows /users/@me/connections to return linked third-party accounts
            dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
            email: enables /users/@me to return an email
            gdm.join: allows your app to join users to a group dm
            guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
            guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
            guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
            identify: allows /users/@me without email
            messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
            openid: for OpenID Connect, this allows your app to receive user id and basic profile information
            relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
            rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
            rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
            rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
            rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
            rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
            rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
            rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
            rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
            rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
            voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
            webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants
        clientCredentials:
          tokenUrl: https://discord.com/api/oauth2/token
          refreshUrl: https://discord.com/api/oauth2/token
          scopes:
            activities.invites.write: allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
            activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
            activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
            applications.builds.read: allows your app to read build data for a user's applications
            applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
            applications.commands: allows your app to use commands in a guild
            applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
            applications.commands.update: allows your app to update its commands using a Bearer token - client credentials grant only
            applications.entitlements: allows your app to read entitlements for a user's applications
            applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
            bot: for oauth2 bots, this puts the bot in the user's selected guild by default
            connections: allows /users/@me/connections to return linked third-party accounts
            dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
            email: enables /users/@me to return an email
            gdm.join: allows your app to join users to a group dm
            guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
            guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
            guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
            identify: allows /users/@me without email
            messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
            openid: for OpenID Connect, this allows your app to receive user id and basic profile information
            relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
            rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
            rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
            rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
            rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
            rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
            rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
            rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
            rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
            rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
            voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
            webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants
        authorizationCode:
          authorizationUrl: https://discord.com/api/oauth2/authorize
          tokenUrl: https://discord.com/api/oauth2/token
          refreshUrl: https://discord.com/api/oauth2/token
          scopes:
            activities.invites.write: allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
            activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
            activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
            applications.builds.read: allows your app to read build data for a user's applications
            applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
            applications.commands: allows your app to use commands in a guild
            applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
            applications.entitlements: allows your app to read entitlements for a user's applications
            applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
            bot: for oauth2 bots, this puts the bot in the user's selected guild by default
            connections: allows /users/@me/connections to return linked third-party accounts
            dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
            email: enables /users/@me to return an email
            gdm.join: allows your app to join users to a group dm
            guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
            guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
            guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
            identify: allows /users/@me without email
            messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
            openid: for OpenID Connect, this allows your app to receive user id and basic profile information
            relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
            role_connections.write: allows your app to update a user's connection and metadata for the app
            rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
            rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
            rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
            rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
            rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
            rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
            rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
            rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
            rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
            voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
            webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants
externalDocs:
  url: https://discord.com/developers/docs
  description: Discord Developer Documentation
x-provenance:
  method: harvested
  publisher: Discord
  source: https://raw.githubusercontent.com/discord/discord-api-spec/HEAD/specs/openapi_preview.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)