# blue.catbird.circle.activateCircle

> Published by [catbird.blue](https://lexicon.garden/identity/did:plc:xg4h4n7w5mh3m4uoi27me4hh)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.activateCircle)
- [Documentation](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.activateCircle/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.activateCircle/examples)

## Definitions

### `blue.catbird.circle.activateCircle`

**Type**: `procedure`

Ask this service to begin indexing a Circle Space. The service verifies the Space independently against the owner's PDS; it does not trust the caller's claim that the Space exists. Idempotent: activating an already-active Circle returns its current summary.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `space` | `string` (space-ref) | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `circle` | `ref` → `blue.catbird.circle.defs#circleSummary` | Yes |  |

#### Errors

- **AuthorizationRequired**: This service holds no usable OAuth grant for a participant of the Space, so it cannot obtain a Space credential.
- **NotAuthorized**: The caller is not on the Space's member list.
- **SpaceNotFound**
- **SpaceNotEligible**: The Space exists but is not a usable Circle: its app access does not name this service, or its metadata record is absent.
- **UnsupportedPDS**
- **ProtocolRevisionMismatch**
- **UpstreamUnavailable**

## Raw Schema

```json
{
  "id": "blue.catbird.circle.activateCircle",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "space"
          ],
          "properties": {
            "space": {
              "type": "string",
              "format": "space-ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "AuthorizationRequired",
          "description": "This service holds no usable OAuth grant for a participant of the Space, so it cannot obtain a Space credential."
        },
        {
          "name": "NotAuthorized",
          "description": "The caller is not on the Space's member list."
        },
        {
          "name": "SpaceNotFound"
        },
        {
          "name": "SpaceNotEligible",
          "description": "The Space exists but is not a usable Circle: its app access does not name this service, or its metadata record is absent."
        },
        {
          "name": "UnsupportedPDS"
        },
        {
          "name": "ProtocolRevisionMismatch"
        },
        {
          "name": "UpstreamUnavailable"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "circle"
          ],
          "properties": {
            "circle": {
              "ref": "blue.catbird.circle.defs#circleSummary",
              "type": "ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Ask this service to begin indexing a Circle Space. The service verifies the Space independently against the owner's PDS; it does not trust the caller's claim that the Space exists. Idempotent: activating an already-active Circle returns its current summary."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```