mutes.md 1.64 KB
Newer Older
Eugen Rochko's avatar
Eugen Rochko committed
1
---
2
title: Mutes
Eugen Rochko's avatar
Eugen Rochko committed
3 4
menu:
  docs:
5
    parent: rest-api
Eugen Rochko's avatar
Eugen Rochko committed
6 7
    weight: 10
---
Eugen Rochko's avatar
Eugen Rochko committed
8 9 10

## GET /api/v1/mutes

Eugen Rochko's avatar
Eugen Rochko committed
11 12
Accounts the user has muted.

Eugen Rochko's avatar
Eugen Rochko committed
13 14 15 16
Returns array of [Account]({{< relref "entities.md#account" >}})

### Resource information

17
{{< api_method_info auth="Yes" user="Yes" scope="read:mutes follow" version="0.0.0" >}}
Eugen Rochko's avatar
Eugen Rochko committed
18 19 20 21 22 23 24 25 26 27

### Parameters

|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `limit` | Maximum number of results | Optional | 40 |

### Pagination

{{< api_pagination >}}
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

## POST /api/v1/accounts/:id/mute

Mute an account.

Returns [Relationship]({{< relref "entities.md#relationship" >}})

### Resource information

{{< api_method_info auth="Yes" user="Yes" scope="write:mutes follow" version="0.0.0" >}}

### Parameters

|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `notifications` | Whether the mute will mute notifications or not | Optional | true |

## POST /api/v1/accounts/:id/unmute

Unmute an account.

Returns [Relationship]({{< relref "entities.md#relationship" >}})

### Resource information

{{< api_method_info auth="Yes" user="Yes" scope="write:mutes follow" version="0.0.0" >}}
Eugen Rochko's avatar
Eugen Rochko committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

## POST /api/v1/statuses/:id/mute

Mute the conversation the status is part of, to no longer be notified about it.

Returns [Status]({{< relref "entities.md#status" >}})

### Resource information

{{< api_method_info auth="Yes" user="Yes" scope="write write:mutes" version="0.0.0" >}}

## POST /api/v1/statuses/:id/unmute

Unmute the conversation the status is part of.

Returns [Status]({{< relref "entities.md#status" >}})

### Resource information

{{< api_method_info auth="Yes" user="Yes" scope="write write:mutes" version="0.0.0" >}}