at.ducs.relationships.setRelationship Documentation (EN)

main procedure

No description available.

Input

Encodingapplication/json

type refat.ducs.relationships.setRelationship#type Required

No description available.

userId stringat-identifier Required

Either a DID or an AT Protocol handle.

Output

Encodingapplication/json

Schemaat.ducs.relationships.defs#relationship

Errors

relationshipUpdateFailed

relationshipNotUpdated

userNotFound

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",
      "required": [
        "userId",
        "type"
      ],
      "properties": {
        "type": {
          "ref": "at.ducs.relationships.setRelationship#type",
          "type": "ref"
        },
        "userId": {
          "type": "string",
          "format": "at-identifier"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "relationshipUpdateFailed"
    },
    {
      "name": "relationshipNotUpdated"
    },
    {
      "name": "userNotFound"
    }
  ],
  "output": {
    "schema": {
      "ref": "at.ducs.relationships.defs#relationship",
      "type": "ref"
    },
    "encoding": "application/json"
  }
}

type string

No description available.

Allowed Values (closed enum)

friend blocked unrelated

View raw schema

{
  "enum": [
    "friend",
    "blocked",
    "unrelated"
  ],
  "type": "string"
}