MenuMethods

Procedure · POST

group.opensocial.createInvite

Write an invite into someone's own invites space.

Write an invite into someone's own invites space. Requires invite.

Requires
invite

Input

groupstring · didrequired

The group DID. Every method is served by the group's host and authorized against that group's roles.

inviteestring · didrequired
messagestring
expiresAtstring · datetime

Output

uristring · at-urirequired

Errors

  • NoInvitesSpace

Schema

Lexicon JSON
{
  "lexicon": 1,
  "id": "group.opensocial.createInvite",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Write an invite into someone's own invites space. Requires invite.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "group",
            "invitee"
          ],
          "properties": {
            "group": {
              "type": "string",
              "format": "did",
              "description": "The group DID. Every method is served by the group's host and authorized against that group's roles."
            },
            "invitee": {
              "type": "string",
              "format": "did"
            },
            "message": {
              "type": "string"
            },
            "expiresAt": {
              "type": "string",
              "format": "datetime"
            }
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "uri"
          ],
          "properties": {
            "uri": {
              "type": "string",
              "format": "at-uri"
            }
          }
        }
      },
      "errors": [
        {
          "name": "NoInvitesSpace"
        }
      ]
    }
  }
}

← All methods