social.coves.aggregator.updateConfig

coves.social

Documentation

Update configuration for an enabled aggregator. Updates the authorization record's config field. Requires moderator permissions.

main procedure

Update configuration for an enabled aggregator. Updates the authorization record's config field. Requires moderator permissions.

Input

Encodingapplication/json
aggregatorDid stringdid Required

DID of the aggregator

community stringat-identifier Required

DID or handle of the community

config unknown Required

New aggregator-specific configuration. Must conform to the aggregator's configSchema.

Output

Encodingapplication/json
cid stringcid Required

CID of the updated authorization record

uri stringat-uri Required

AT-URI of the updated authorization record

Errors

NotAuthorized Caller is not a moderator of this community
AuthorizationNotFound Aggregator is not enabled for this community
InvalidConfig Config does not match aggregator's configSchema
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 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "community",
        "aggregatorDid",
        "config"
      ],
      "properties": {
        "config": {
          "type": "unknown",
          "description": "New aggregator-specific configuration. Must conform to the aggregator's configSchema."
        },
        "community": {
          "type": "string",
          "format": "at-identifier",
          "description": "DID or handle of the community"
        },
        "aggregatorDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the aggregator"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "NotAuthorized",
      "description": "Caller is not a moderator of this community"
    },
    {
      "name": "AuthorizationNotFound",
      "description": "Aggregator is not enabled for this community"
    },
    {
      "name": "InvalidConfig",
      "description": "Config does not match aggregator's configSchema"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "authorization"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "CID of the updated authorization record"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the updated authorization record"
        },
        "authorization": {
          "ref": "social.coves.aggregator.defs#authorizationView",
          "type": "ref",
          "description": "The updated authorization details"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Update configuration for an enabled aggregator. Updates the authorization record's config field. Requires moderator permissions."
}

Lexicon Garden

@