Delete DM
    • Dark
      Light
    • PDF

    Delete DM

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/im.delete

    Delete a DM. Permission required: view-room-administration.

    Changelog

    VersionDescription
    3.18.0Added
    Header parameters
    X-Auth-Token
    stringRequired

    The authToken of the authenticated user.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    X-User-Id
    stringRequired

    The userId of the authenticated user.

    ExamplerbAXPnMktTFbNpwtJ
    Body parameters
    Example
    {
      "roomId": "hdy9972092873h8s7s0"
    }
    object
    roomId
    string

    The room ID of the DM. This parameter is required if you don't enter the username parameter.

    username
    string

    The username of the user in the DM. This parameter is required if you don't enter the roomId parameter.

    Responses
    200

    OK

    Success
    {
      "success": true
    }
    object
    success
    boolean
    400

    Bad Request

    Example 1
    {
      "success": false,
      "error": "must have required property 'roomId'\n must have required property 'username'\n must match exactly one schema in oneOf [invalid-params]",
      "errorType": "invalid-params"
    }
    Invalid room ID or username
    {
      "success": false,
      "error": "[invalid-channel]",
      "errorType": "invalid-channel"
    }
    object
    success
    boolean
    error
    string
    errorType
    string
    401

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    string

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.