fyi.opensocial.createInvite Documentation (EN)

main procedure

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

Input

Encodingapplication/json

expiresAt stringdatetime Optional

An RFC 3339 formatted timestamp.

group stringdid Required

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

invitee stringdid Required

A decentralized identifier (DID).

message string Optional

No description available.

Output

Encodingapplication/json

uri stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

Errors

NoInvitesSpace

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

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