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

> ## Agent Instructions
> Base URL: https://api.social-api.ai/v1. Send your API key in the Authorization header: Authorization: Bearer <your API key>.
> Every error response from /v1 is JSON: { "error": { "code", "message", "meta" (optional) }, "request_id" }. Branch on error.code; use error.message only for logs.
> A 429 response carries a Retry-After header, in seconds, when the limit has a known wait. Authenticated responses can carry X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset for the per-minute request budget your SocialAPI account shares across every API key (see /guides/rate-limits).
> Paginated list endpoints return next_cursor, at the top level or inside pagination (see /guides/pagination). Pass it as the cursor query parameter to get the next page. An absent or empty next_cursor means you have the last page.
> Treat every ID as an opaque string: do not parse it or assume a format.
> Support differs by platform and by operation. Check /platforms/overview before assuming an operation works on a platform. An unsupported operation returns 501 with error.code resource.not_supported.

# Update current user

> Updates the authenticated user's profile. Supports setting onboarding=false to mark onboarding as complete, and optionally recording use_case, referral, job_role and signup_metadata. The response reflects the current billing_blocked state, unaffected by this update. The response includes the caller's team role: "admin", "developer", or "" for the account owner.



## OpenAPI

````yaml /api-reference/openapi.json patch /users/me
openapi: 3.0.0
info:
  description: >-
    Unified social media inbox API. Read and respond to comments, DMs, reviews,
    and mentions across Instagram, Facebook, Threads, Google Business Profile,
    TikTok, LinkedIn, and YouTube through a single REST API. X/Twitter and
    Trustpilot coming soon.
  title: SocialAPI.AI
  contact:
    name: SocialAPI.AI Support
    email: support@social-api.ai
  license:
    name: MIT
  version: '1.0'
servers:
  - url: https://api.social-api.ai/v1
security: []
paths:
  /users/me:
    patch:
      tags:
        - Users
      summary: Update current user
      description: >-
        Updates the authenticated user's profile. Supports setting
        onboarding=false to mark onboarding as complete, and optionally
        recording use_case, referral, job_role and signup_metadata. The response
        reflects the current billing_blocked state, unaffected by this update.
        The response includes the caller's team role: "admin", "developer", or
        "" for the account owner.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api_endpoints.PatchMeRequest'
        description: Fields to update
        required: true
      responses:
        '200':
          description: Updated user profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.UserMeResponse'
        '400':
          description: Invalid request body or onboarding value
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_endpoints.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    api_endpoints.PatchMeRequest:
      type: object
      properties:
        job_role:
          description: >-
            JobRole records what best describes the user. Surrounding whitespace
            is

            trimmed, an empty value leaves the current one unchanged, and values

            longer than 120 characters are truncated.
          type: string
          example: Founder / CEO
        lock_accounts_to_brand:
          description: >-
            LockAccountsToBrand toggles whether a social account already
            connected to

            one brand may be re-connected (moved) to a different brand. When
            true, such

            a connect attempt is rejected with 409 account.already_linked.
          type: boolean
          example: true
        onboarding:
          type: boolean
          example: false
        referral:
          type: string
          example: Google search
        signup_metadata:
          description: >-
            SignupMetadata adds keys to the signup answers on record: a shallow

            merge, so keys sent replace the same keys and others are kept. At
            most

            4096 bytes once encoded.
          type: object
          additionalProperties: {}
        use_case:
          type: string
          example: Managing my own brand's social accounts
    api_endpoints.UserMeResponse:
      type: object
      properties:
        allowed_platforms:
          type: array
          items:
            type: string
          example:
            - instagram
            - facebook
        avatar_url:
          type: string
          example: https://example.com/avatar.jpg
        beta_tester:
          type: boolean
          example: false
        billing_block_reason:
          description: |-
            BillingBlockReason is why access is paused, empty when it is not.
            "past_due": a payment failed, and settling it restores access.
            "ban": the account was suspended for a Terms of Service violation.
            Paying does not lift it, and every route except this one returns
            403 auth.suspended. Contact support to appeal.
          type: string
          example: past_due
        billing_blocked:
          description: >-
            BillingBlocked is true when API access and webhook delivery are
            paused.

            Read BillingBlockReason to tell why and whether paying lifts it.
          type: boolean
          example: false
        billing_blocked_at:
          description: BillingBlockedAt is when the block began, or null when not blocked.
          type: string
        billing_currency:
          description: >-
            BillingCurrency is the currency your subscription is billed in:
            "usd"

            or "eur". A subscription never changes currency, so plan changes are

            priced in it. Kept after a cancellation; "" when you never
            subscribed.
          type: string
          example: usd
        email:
          type: string
          example: user@example.com
        experiment_enrolled:
          description: >-
            ExperimentEnrolled is true only when ExperimentVariant was assigned
            by

            the experiment itself. False means the "control" above is a fallback

            (not enrolled, flag off, or evaluation failed) and must not be
            recorded

            as the caller's arm.
          type: boolean
          example: false
        experiment_variant:
          description: >-
            ExperimentVariant is the caller's variant for staged feature
            rollouts:

            "control" or "treatment". "control" unless the caller is enrolled.
          type: string
          example: control
        facebook_page_selection:
          description: >-
            FacebookPageSelection, when true, makes a Facebook connection (and
            an

            Instagram connection through Facebook Login) end with

            status=selection_required so you choose the Pages. Read-only.
          type: boolean
          example: false
        id:
          type: string
          example: 550e8400-e29b-41d4-a716-446655440000
        job_role:
          description: |-
            JobRole is what best describes the user, as answered during
            onboarding. Null until answered.
          type: string
          example: Founder / CEO
        lock_accounts_to_brand:
          description: >-
            LockAccountsToBrand, when true, rejects connecting a social account
            that is

            already connected to another of your brands (409
            account.already_linked)

            instead of moving it. Default false.
          type: boolean
          example: false
        onboarding:
          type: boolean
          example: true
        plan:
          type: string
          example: free
        role:
          description: |-
            Role is the caller's team role: "admin", "developer", or "" for the
            account Owner, who holds no Role. An API key and an OAuth token both
            read "".
          type: string
          example: admin
        signup_metadata:
          description: |-
            SignupMetadata holds open-ended answers recorded at signup, such as
            referral_source and search_query. An empty object until answered.
          type: object
          additionalProperties: {}
        use_case:
          type: string
          example: Managing clients' accounts (agency)
    api_endpoints.ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/api_endpoints.ErrorBody'
        request_id:
          description: >-
            RequestID matches the X-Request-ID response header. Include it when
            contacting support.
          type: string
          example: 01HZ9X3Q4R5M6N7P8V2K0W1J
    api_endpoints.ErrorBody:
      type: object
      properties:
        code:
          type: string
          example: resource.not_found
        message:
          type: string
          example: Account not found
        meta:
          type: object
          additionalProperties: {}
  securitySchemes:
    BearerAuth:
      description: >-
        Prefix your API key with "Bearer ". Example: `Authorization: Bearer
        sapi_key_...`
      type: apiKey
      name: Authorization
      in: header

````

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