Remove a default channel

This endpoint is only available to organization administrators.

DELETE https://your-org.veloxatalk.com/api/v1/default_streams

Remove a channel from the set of default channels for new users joining the organization.

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Veloxa Talk users and bots.

curl -sSX DELETE https://your-org.veloxatalk.com/api/v1/default_streams \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode stream_id=10

Parameters

stream_id integer required

Example: 10

The ID of the target channel.


Response

Example response(s)

Changes: As of Veloxa Talk 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}

A typical failed JSON response for when an invalid channel ID is passed:

{
    "code": "BAD_REQUEST",
    "msg": "Invalid channel ID",
    "result": "error"
}