io.atcr.hold.requestCrew Documentation (EN)

main procedure

Request crew membership for the hold. Authorization depends on the captain record: if allowAllCrew is true, any authenticated user can join; otherwise, only the owner can join.

Input

Encodingapplication/json

permissions array Optional

Requested permissions (default: ['blob:read', 'blob:write'])

role string Optional

Requested role (default: 'member')

maxLength: 32 bytes

Output

Encodingapplication/json

cid stringcid Optional

CID of the crew record

message string Optional

Human-readable status message

status string Required

Result status

Known values: created, already_member

uri stringat-uri Optional

AT-URI of the crew record (if created or already exists)

Errors

AuthRequired

RegistrationDisabled

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

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "properties": {
        "role": {
          "type": "string",
          "default": "member",
          "maxLength": 32,
          "description": "Requested role (default: 'member')"
        },
        "permissions": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 64
          },
          "description": "Requested permissions (default: ['blob:read', 'blob:write'])"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired"
    },
    {
      "name": "RegistrationDisabled"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "status"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "CID of the crew record"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the crew record (if created or already exists)"
        },
        "status": {
          "type": "string",
          "maxLength": 32,
          "description": "Result status",
          "knownValues": [
            "created",
            "already_member"
          ]
        },
        "message": {
          "type": "string",
          "maxLength": 256,
          "description": "Human-readable status message"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Request crew membership for the hold. Authorization depends on the captain record: if allowAllCrew is true, any authenticated user can join; otherwise, only the owner can join."
}