PeerTube · Example Payload

Contactadministrator

Contact

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

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

Raw ↑ 
{
  "operationId": "contactAdministrator",
  "method": "POST",
  "path": "/api/v1/server/contact",
  "summary": "Contact the instance administrators",
  "description": "",
  "tags": [
    "Contact"
  ],
  "parameters": [],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "fromName": {
          "type": "string",
          "description": "Display name of the sender"
        },
        "fromEmail": {
          "type": "string",
          "format": "email",
          "description": "Email address of the sender"
        },
        "subject": {
          "type": "string",
          "description": "Subject of the message"
        },
        "body": {
          "type": "string",
          "description": "Message body"
        }
      },
      "required": [
        "fromName",
        "fromEmail",
        "body"
      ]
    },
    "example": {}
  },
  "responses": {
    "204": {
      "description": "successful operation",
      "examples": {}
    },
    "403": {
      "description": "a contact form was already sent recently from this IP address",
      "examples": {}
    },
    "409": {
      "description": "contact form or SMTP is not configured on this instance",
      "examples": {}
    }
  }
}