# fyi.opensocial.updateProfile

> Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.updateProfile)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.updateProfile/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.updateProfile/examples)

## Definitions

### `fyi.opensocial.updateProfile`

**Type**: `procedure`

Replace the profile: name, description, join policy. Requires group.configure. Fields are inlined rather than referencing fyi.opensocial.profile, because a record def cannot be used as an input object — mirrors createGroup.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `avatar` | `blob` | No | The group's avatar, as returned by uploadImage. Omit to keep the current one; null to clear it. |
| `banner` | `blob` | No | The group's banner, as returned by uploadImage. Omit to keep the current one; null to clear it. |
| `description` | `string` | No |  |
| `displayName` | `string` | Yes |  |
| `group` | `string` (did) | Yes | The group DID. Every method is served by the group's host and authorized against that group's roles. |
| `joinPolicy` | `string` | No |  |
| `url` | `string` (uri) | No | The group's own site. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Replace the profile: name, description, join policy. Requires group.configure. Fields are inlined rather than referencing fyi.opensocial.profile, because a record def cannot be used as an input object — mirrors createGroup.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "avatar": {
              "accept": [
                "image/png",
                "image/jpeg"
              ],
              "description": "The group's avatar, as returned by uploadImage. Omit to keep the current one; null to clear it.",
              "maxSize": 1000000,
              "type": "blob"
            },
            "banner": {
              "accept": [
                "image/png",
                "image/jpeg"
              ],
              "description": "The group's banner, as returned by uploadImage. Omit to keep the current one; null to clear it.",
              "maxSize": 1000000,
              "type": "blob"
            },
            "description": {
              "maxGraphemes": 300,
              "maxLength": 3000,
              "type": "string"
            },
            "displayName": {
              "maxGraphemes": 64,
              "maxLength": 640,
              "type": "string"
            },
            "group": {
              "description": "The group DID. Every method is served by the group's host and authorized against that group's roles.",
              "format": "did",
              "type": "string"
            },
            "joinPolicy": {
              "knownValues": [
                "fyi.opensocial.profile#open",
                "fyi.opensocial.profile#request",
                "fyi.opensocial.profile#invite"
              ],
              "type": "string"
            },
            "url": {
              "description": "The group's own site.",
              "format": "uri",
              "type": "string"
            }
          },
          "required": [
            "group",
            "displayName"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cid": {
              "format": "cid",
              "type": "string"
            },
            "uri": {
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "uri",
            "cid"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "fyi.opensocial.updateProfile",
  "lexicon": 1
}
```