> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sharedgraph.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Edit your profile

> Edit your profile. The actor comes from the authorization grant. Required scope: profile:write. Same validation and intent/revision contract as account profile controls. Omitted fields stay unchanged; null clears bio or website. App-driven edits require publishing; a paused switch returns 429 publishing_paused.



## OpenAPI

````yaml /openapi.json patch /api/profile
openapi: 3.1.0
info:
  title: SharedGraph public application API
  version: pilot
  description: >-
    Pilot: breaking changes are possible and announced in the changelog.
    SharedGraph is a common social network used through independently operated
    applications. Supported integration: server-backed confidential OAuth client
    using authorization code with S256 PKCE. Anonymous public reads are a pilot
    convenience: 120 requests/minute per connecting address, with a tighter
    shared 30/minute events+reconcile budget. Signed-in views must preserve
    bearer safety rules and never fall back to anonymous after a refusal. No
    account-management, moderator, operator, registration or debug API is part
    of this reference. Provider browser helpers use account cookies; token
    endpoints use Basic; social private reads and mutations use bearer.
    x-app-generation is an application BFF session signal, not a core response
    header. Error catalog below records the pilot domain and OAuth protocol
    refusals; provider error descriptions are diagnostic text, not a stable
    machine identifier.
servers:
  - url: https://api.sharedgraph.com
    description: Hosted pilot network
security:
  - BearerAuth: []
tags:
  - name: Social
  - name: OAuth
  - name: Discovery
paths:
  /api/profile:
    patch:
      tags:
        - Social
      summary: Edit your profile
      description: >-
        Edit your profile. The actor comes from the authorization grant.
        Required scope: profile:write. Same validation and intent/revision
        contract as account profile controls. Omitted fields stay unchanged;
        null clears bio or website. App-driven edits require publishing; a
        paused switch returns 429 publishing_paused.
      operationId: patch_api_profile
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditProfile'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileReceipt'
          headers:
            x-sharedgraph-actor-id:
              description: >-
                The actor this response was read under; present when a Bearer
                credential was admitted, at the same SQL admission as the body.
              schema:
                type: string
                minLength: 1
            x-sharedgraph-app-id:
              description: The application of the admitted credential.
              schema:
                type: string
                minLength: 1
            x-sharedgraph-grant-id:
              description: The grant of the admitted credential.
              schema:
                type: string
                minLength: 1
            x-sharedgraph-scopes:
              description: >-
                The effective scopes of the admitted credential, space
                separated.
              schema:
                type: string
        '400':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Refusal; see the error catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - BearerAuth: []
components:
  schemas:
    EditProfile:
      type: object
      properties:
        intentId:
          type: string
          minLength: 1
          maxLength: 100
        revision:
          type: integer
          minimum: 1
        displayName:
          type: string
          minLength: 1
          maxLength: 100
        bio:
          type:
            - string
            - 'null'
          maxLength: 500
        website:
          type:
            - string
            - 'null'
          maxLength: 500
      required:
        - intentId
        - revision
      additionalProperties: false
    ProfileReceipt:
      type: object
      properties:
        profile:
          type: object
          properties:
            revision:
              type: integer
              minimum: 1
          required:
            - revision
          additionalProperties: false
      required:
        - profile
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          enum:
            - unknown_or_immutable_field
            - invalid_text
            - invalid_json
            - intent_required
            - unsupported_audience
            - invalid_parent
            - revision_required
            - self_relation
            - self_block
            - invalid_report
            - invalid_cursor
            - authentication_required
            - auth_unavailable
            - authority_unavailable
            - capability_required
            - not_owner
            - interaction_unavailable
            - social_authority_required
            - not_found
            - intent_conflict
            - revision_conflict
            - post_deleted
            - post_unavailable
            - parent_unavailable
            - effect_mismatch
            - domain_plan_too_large
            - publishing_paused
            - pilot_rate_limited
            - protected_read_unavailable
            - protected_read_storage_unavailable
            - recovery_unavailable
            - domain_storage_unavailable
            - pilot_storage_unavailable
            - pilot_limits_unavailable
            - trusted_address_unavailable
            - origin_required
            - origin_mismatch
            - restriction_witness_required
            - restriction_witness_unavailable_or_incomplete
            - recovery_state_missing
            - recovery_publication_changed
            - recovery_quarantined
            - lifecycle_revision_conflict
            - witness_prepare_mismatch
            - ambiguous_acceptance_requires_independent_proof
            - witness_acceptance_mismatch
            - witness_finalize_unconfirmed
            - invalid_request
            - invalid_client
            - invalid_grant
            - invalid_scope
            - unsupported_grant_type
            - unsupported_response_type
            - access_denied
            - temporarily_unavailable
            - server_error
            - invalid_token
            - unsupported_token_type
            - invalid_target
            - invalid_signature
            - invalid_redirect_uri
            - invalid_request_uri
            - request_not_supported
            - request_uri_not_supported
            - login_required
            - interaction_required
            - account_selection_required
            - consent_required
            - invalid_page_cursor
            - invalid_website
        message:
          type: string
        error_description:
          type: string
        error_uri:
          type: string
          format: uri
      required:
        - error
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Audited access token bound to the current application, actor and
        immutable grant.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.