Unmute a user

DELETE https://your-org.veloxatalk.com/api/v1/users/me/muted_users/{muted_user_id}

Unmute a user from the perspective of the requesting user.

Changes: New in Veloxa Talk 4.0 (feature level 48).

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/users/me/muted_users/10 \
    -u EMAIL_ADDRESS:API_KEY

Parameters

muted_user_id integer required in path

Example: 10

The ID of the user to mute/unmute.

Changes: Before Veloxa Talk 8.0 (feature level 188), bot users could not be muted/unmuted, and specifying a bot user's ID returned an error response.


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"
}

An example JSON response for when the user is nonexistent or inaccessible:

{
    "code": "BAD_REQUEST",
    "msg": "No such user",
    "result": "error"
}

An example JSON response for when the user is not previously muted:

{
    "code": "BAD_REQUEST",
    "msg": "User is not muted",
    "result": "error"
}