User Muting

Endpoints:

• Get muted users
• Mute a user
• Unmute a user

Muting a user will prevent them from being visible to the muting user unless specifically requested.

GET /users/{user_id}/muted

Scope: any

Retrieve a list of muted users. Users may only see their own list of muted users.

URL Parameters

Name	Description
user_id	ID of the user whose list of muted users to retrieve

Example

curl "https://api.pnut.io/v1/users/me/muted" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "X-Pretty-Json: 1"

Returns a list of users

{
    "meta": {
        "more": false,
        "code": 200
    },
    "data": [
        {"...User Object..."}
    ]
}

PUT /users/{user_id}/mute

Token: user

Scope: follow

Mute a user. Muted users will not appear in future requests.

URL Parameters

Name	Description
user_id	ID of the user to mute

Example

curl "https://api.pnut.io/v1/users/@testuser/mute" \
    -X PUT \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "X-Pretty-Json: 1"

Returns the muted user

{
    "meta": {
        "code": 200
    },
    "data": {"...User Object..."}
}

DELETE /users/{user_id}/mute

Token: user

Scope: follow

Unmute a user.

URL Parameters

Name	Description
user_id	ID of the user to unmute

Example

curl "https://api.pnut.io/v1/users/@testuser/mute" \
    -X DELETE \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "X-Pretty-Json: 1"

Returns the unmuted user

{
    "meta": {
        "code": 200
    },
    "data": {"....User Object..."}
}