Authentication is required.


GET /api/v2/muted_items
List logged-in account's Muted Item


GET /api/v2/muted_items/:id
Show a Muted Item

Examples

GET /api/v2/muted-items/1
200
{
  "data": {
    "id": "1",
    "type": "muted-items",
    "links": {
      "self": "http://test.host/api/v2/muted-items/1"
    },
    "attributes": {
      "expire-at": "2017-09-28T10:51:42.912+08:00",
      "updated-at": "2017-08-29T10:51:42.917+08:00"
    },
    "relationships": {
      "muted-account": {
        "links": {
          "self": "http://test.host/api/v2/muted-items/1/relationships/muted-account",
          "related": "http://test.host/api/v2/muted-items/1/muted-account"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Muted Item ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/muted_items
Create logged-in account's Muted Item

Examples

POST /api/v2/muted-items
{
  "data": {
    "type": "muted-items",
    "attributes": {
      "expire-at": "2017-09-28 10:51:44 +0800",
      "updated-at": null
    },
    "relationships": {
      "muted-account": {
        "data": {
          "type": "accounts",
          "id": "1484"
        }
      }
    }
  }
}
201
{
  "data": {
    "id": "4",
    "type": "muted-items",
    "links": {
      "self": "http://test.host/api/v2/muted-items/4"
    },
    "attributes": {
      "expire-at": "2017-09-28T10:51:44.000+08:00",
      "updated-at": "2017-08-29T10:51:44.234+08:00"
    },
    "relationships": {
      "muted-account": {
        "links": {
          "self": "http://test.host/api/v2/muted-items/4/relationships/muted-account",
          "related": "http://test.host/api/v2/muted-items/4/muted-account"
        }
      }
    }
  }
}

Params

Param name Description
data
required

Muted Item information

Validations:

  • Must be a Hash

data[type]
required

Validations:

data[relationships]
required

Validations:

  • Must be a Hash

data[relationships][muted_account]
required

Validations:

  • Must be a Hash

data[relationships][muted_account][data]
required

Validations:

  • Must be a Hash

data[relationships][muted_account][data][type]
required

Muted Account type, which is `accounts`

Validations:

  • Must be a String

data[relationships][muted_account][data][id]
required

Account ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /apiv2/muted_items/:id
Update a Muted Item

Examples

PATCH /api/v2/muted-items/12
{
  "data": {
    "id": "12",
    "type": "muted-items",
    "attributes": {
      "expire-at": "2017-11-29 10:51:47 +0800",
      "updated-at": "2017-08-29 10:51:47 +0800"
    },
    "relationships": {}
  }
}
200
{
  "data": {
    "id": "12",
    "type": "muted-items",
    "links": {
      "self": "http://test.host/api/v2/muted-items/12"
    },
    "attributes": {
      "expire-at": "2017-11-29T10:51:47.000+08:00",
      "updated-at": "2017-08-29T10:51:47.000+08:00"
    },
    "relationships": {
      "muted-account": {
        "links": {
          "self": "http://test.host/api/v2/muted-items/12/relationships/muted-account",
          "related": "http://test.host/api/v2/muted-items/12/muted-account"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Muted Item ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Muted Item information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][muted_account]
optional

Validations:

  • Must be a Hash

data[relationships][muted_account][data]
optional

Validations:

  • Must be a Hash

data[relationships][muted_account][data][type]
optional

Muted Account type, which is `accounts`

Validations:

  • Must be a String

data[relationships][muted_account][data][id]
optional

Account ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


DELETE /apiv2/muted_items/:id
Delete a Muted Item

Examples

DELETE /api/v2/muted-items/9
204
{}

Params

Param name Description
id
required

Muted Item ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.