dev.knotless.putOrgMember

lexicons.knotless.dev

Documentation

The invitation is kept in the organization's space where its PDS has spaces, else in its public records. Invited again, an invitation that lapsed starts over.

main procedure

The invitation is kept in the organization's space where its PDS has spaces, else in its public records. Invited again, an invitation that lapsed starts over.

Input

Encodingapplication/json
member stringdid Required

The account to invite.

org stringdid Required

The organization.

role string Optional

Their role; member when absent.

maxLength: 64 bytes

Output

Encodingapplication/json
first boolean Required

Whether this made the account an organization.

had string Optional

The role they had before, if they had one.

Known values: admin, member
org string Required

The organization's handle, or its DID when none resolves back to it.

private boolean Required

Whether the invitation is in the organization's space, which only it and its members read; else in its public records.

role string Required

Their role now.

Known values: admin, member
was string Optional

Where they stood before: invited, lapsed (invited over 7 days ago), or a public or hidden member. Absent when they were not invited.

Known values: invited, lapsed, public, hidden
who string Required

The invitee's handle, or their DID when none resolves back to it.

Try It

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

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "The invitation is kept in the organization's space where its PDS has spaces, else in its public records. Invited again, an invitation that lapsed starts over.",
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "member": {
          "description": "The account to invite.",
          "format": "did",
          "type": "string"
        },
        "org": {
          "description": "The organization.",
          "format": "did",
          "type": "string"
        },
        "role": {
          "description": "Their role; member when absent.",
          "knownValues": [
            "admin",
            "member"
          ],
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "org",
        "member"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "first": {
          "description": "Whether this made the account an organization.",
          "type": "boolean"
        },
        "had": {
          "description": "The role they had before, if they had one.",
          "knownValues": [
            "admin",
            "member"
          ],
          "maxLength": 64,
          "type": "string"
        },
        "org": {
          "description": "The organization's handle, or its DID when none resolves back to it.",
          "maxLength": 300,
          "type": "string"
        },
        "private": {
          "description": "Whether the invitation is in the organization's space, which only it and its members read; else in its public records.",
          "type": "boolean"
        },
        "role": {
          "description": "Their role now.",
          "knownValues": [
            "admin",
            "member"
          ],
          "maxLength": 64,
          "type": "string"
        },
        "was": {
          "description": "Where they stood before: invited, lapsed (invited over 7 days ago), or a public or hidden member. Absent when they were not invited.",
          "knownValues": [
            "invited",
            "lapsed",
            "public",
            "hidden"
          ],
          "maxLength": 64,
          "type": "string"
        },
        "who": {
          "description": "The invitee's handle, or their DID when none resolves back to it.",
          "maxLength": 300,
          "type": "string"
        }
      },
      "required": [
        "org",
        "who",
        "role",
        "first",
        "private"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@