Neynar · Example Payload

Publish Mute

Adds a mute for a given FID. This is an allowlisted API, reach out if you want access.

Mute

Publish Mute is an example object payload from Neynar, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

{
  "operationId": "publish-mute",
  "method": "POST",
  "path": "/v2/farcaster/mute/",
  "summary": "Mute FID",
  "description": "Adds a mute for a given FID. This is an allowlisted API, reach out if you want access.",
  "tags": [
    "Mute"
  ],
  "parameters": [],
  "requestBody": {
    "required": true,
    "schema": {
      "$ref": "#/components/schemas/MuteReqBody"
    },
    "example": null
  },
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/MuteResponse"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    },
    "404": {
      "description": "Resource not found",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    },
    "500": {
      "description": "Server Error",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}