Misskey · Example Payload

Misskey Post_Admin_Announcements___Create Example

No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:announcements*

Open-SourceSocial NetworksFediverseActivityPubDecentralized

Misskey Post___Admin___Announcements___Create Example is an example object payload from Misskey, with 7 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

endpointmethodoperationIdsummarydescriptionrequestBodyresponseExample

Example Payload

{
  "endpoint": "/admin/announcements/create",
  "method": "POST",
  "operationId": "post___admin___announcements___create",
  "summary": "admin/announcements/create",
  "description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:announcements*",
  "requestBody": {
    "contentType": "application/json",
    "example": {},
    "schema": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "minLength": 1
        },
        "text": {
          "type": "string",
          "minLength": 1
        },
        "imageUrl": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 0
        },
        "icon": {
          "type": "string",
          "enum": [
            "info",
            "warning",
            "error",
            "success"
          ],
          "default": "info"
        },
        "display": {
          "type": "string",
          "enum": [
            "normal",
            "banner",
            "dialog"
          ],
          "default": "normal"
        },
        "forExistingUsers": {
          "type": "boolean",
          "default": false
        },
        "needConfirmationToRead": {
          "type": "boolean",
          "default": false
        },
        "needEnrollmentTutorialToRead": {
          "type": "boolean",
          "default": false
        },
        "closeDuration": {
          "type": "number",
          "default": 0
        },
        "displayOrder": {
          "type": "number",
          "default": 0
        },
        "silence": {
          "type": "boolean",
          "default": false
        },
        "userId": {
          "type": [
            "string",
            "null"
          ],
          "format": "misskey:id",
          "default": null
        }
      },
      "required": [
        "title",
        "text",
        "imageUrl"
      ]
    }
  },
  "responseExample": {
    "status": "400",
    "contentType": "application/json",
    "example": {}
  }
}