Neynar · Example Payload

Publish Bans

Bans a list of FIDs from the app associated with your API key. Banned users, their casts and reactions will not appear in feeds.

Ban

Publish Bans 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-bans",
  "method": "POST",
  "path": "/v2/farcaster/ban/",
  "summary": "Ban FIDs from app",
  "description": "Bans a list of FIDs from the app associated with your API key. Banned users, their casts and reactions will not appear in feeds.",
  "tags": [
    "Ban"
  ],
  "parameters": [],
  "requestBody": {
    "required": true,
    "schema": {
      "$ref": "#/components/schemas/BanReqBody"
    },
    "example": null
  },
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/BanResponse"
      },
      "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
    }
  }
}