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

# Check account health

> Refreshes account health and readiness information for a connected account.



## OpenAPI

````yaml /api/openapi.json post /v1/accounts/{accountId}/health
openapi: 3.1.0
info:
  title: Kavenio API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://kavenio.com/terms
  description: Generated OpenAPI document for the stable Kavenio public API.
servers:
  - url: https://api.kavenio.com
security:
  - bearerAuth: []
tags:
  - name: API keys
    description: Manage Kavenio API keys for the authenticated user.
  - name: Integrations
    description: Connect automation clients and manage workflow subscriptions.
  - name: Feature requests
    description: Submit feature requests from authenticated users.
  - name: Posts
    description: Create, schedule, update, and manage post lifecycle actions.
  - name: Queue
    description: Manage reusable post queue schedules and preview slots.
  - name: Media
    description: Upload, presign, and validate media assets.
  - name: Validation
    description: Validate post payloads and platform content length limits.
  - name: Connect
    description: Start and complete account connection flows.
  - name: Accounts
    description: Manage connected social accounts and account health.
  - name: Telegram
    description: Manage Telegram-specific connected account settings.
  - name: Discord
    description: Manage Discord messages, roles, pins, events, and settings.
  - name: Google Business
    description: Manage Google Business locations, reviews, and helpers.
  - name: Ads
    description: Create, read, cancel, and inspect advertising resources.
  - name: Ad audiences
    description: Manage advertising audiences and audience members.
  - name: Ad catalogs
    description: Inspect advertising catalogs and product sets.
  - name: Ad targeting
    description: Search targeting entities and estimate audience reach.
  - name: Ad conversions
    description: Manage conversion destinations and send conversion events.
  - name: Ad leads
    description: Manage lead forms and retrieve advertising leads.
  - name: Tracking tags
    description: Manage Meta tracking tags and tag sharing.
  - name: Platform credentials
    description: Manage organization platform app credentials.
  - name: Analytics
    description: Read provider analytics and operational inbox data.
  - name: WhatsApp conversions
    description: Read and send WhatsApp conversion events.
  - name: Activity
    description: Read operational activity events.
  - name: Webhooks
    description: Manage webhook endpoints and delivery logs.
paths:
  /v1/accounts/{accountId}/health:
    post:
      tags:
        - Accounts
      summary: Check account health
      description: >-
        Refreshes account health and readiness information for a connected
        account.
      operationId: checkAccountHealth
      parameters:
        - in: path
          name: accountId
          schema:
            type: string
            minLength: 16
            maxLength: 16
            pattern: ^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]{16}$
          required: true
      responses:
        '200':
          description: Account health returned.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      ok:
                        type: boolean
                        x-kavenio-const: true
                      data:
                        type: object
                        properties:
                          account:
                            type: object
                            properties:
                              id:
                                type: string
                                minLength: 16
                                maxLength: 16
                                pattern: >-
                                  ^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]{16}$
                              organizationId:
                                type: string
                                minLength: 1
                              profileId:
                                type: string
                                minLength: 1
                                maxLength: 255
                              platform:
                                type: string
                                enum:
                                  - twitter
                                  - facebook
                                  - instagram
                                  - linkedin
                                  - tiktok
                                  - youtube
                                  - threads
                                  - reddit
                                  - pinterest
                                  - bluesky
                                  - mastodon
                                  - googlebusiness
                                  - telegram
                                  - snapchat
                                  - discord
                                  - whatsapp
                                  - metaads
                                  - googleads
                                  - tiktokads
                                  - linkedinads
                                  - pinterestads
                                  - xads
                              providerAccountId:
                                type: string
                                minLength: 1
                              username:
                                type: string
                                minLength: 1
                              displayName:
                                type: string
                                minLength: 1
                              profilePicture:
                                type: string
                                format: uri
                              profileUrl:
                                type: string
                                format: uri
                              parentAccountId:
                                type: string
                                minLength: 16
                                maxLength: 16
                                pattern: >-
                                  ^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]{16}$
                              enabled:
                                type: boolean
                              isActive:
                                type: boolean
                              status:
                                type: string
                                enum:
                                  - connected
                                  - disconnected
                                  - needs_reconnect
                                  - revoked
                              tokenExpiresAt:
                                type: string
                                minLength: 1
                              scopes:
                                type: array
                                items:
                                  type: string
                              permissions:
                                type: array
                                items:
                                  type: string
                              metadata:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties: {}
                              readiness:
                                type: object
                                properties:
                                  platform:
                                    type: string
                                    enum:
                                      - twitter
                                      - facebook
                                      - instagram
                                      - linkedin
                                      - tiktok
                                      - youtube
                                      - threads
                                      - reddit
                                      - pinterest
                                      - bluesky
                                      - mastodon
                                      - googlebusiness
                                      - telegram
                                      - snapchat
                                      - discord
                                      - whatsapp
                                      - metaads
                                      - googleads
                                      - tiktokads
                                      - linkedinads
                                      - pinterestads
                                      - xads
                                  ready:
                                    type: boolean
                                  status:
                                    type: string
                                    enum:
                                      - ready
                                      - needs_setup
                                      - needs_reconnect
                                      - blocked
                                      - unsupported
                                      - unknown
                                  checkedAt:
                                    type: string
                                    minLength: 1
                                  reconnectRecommended:
                                    type: boolean
                                  selectedDestinationId:
                                    type: string
                                    minLength: 1
                                  selectedDestinationName:
                                    type: string
                                    minLength: 1
                                  missingScopes:
                                    type: array
                                    items:
                                      type: string
                                      minLength: 1
                                  missingPermissions:
                                    type: array
                                    items:
                                      type: string
                                      minLength: 1
                                  missingDestinations:
                                    type: array
                                    items:
                                      type: string
                                      minLength: 1
                                  issues:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        code:
                                          type: string
                                          minLength: 1
                                        message:
                                          type: string
                                          minLength: 1
                                      required:
                                        - code
                                        - message
                                      additionalProperties: false
                                  capabilities:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          enum:
                                            - publish
                                            - schedule
                                            - media_upload
                                            - video_upload
                                            - photo_upload
                                            - first_comment
                                            - playlist
                                            - page_selection
                                            - account_selection
                                            - creator_info
                                            - location_selection
                                            - location_management
                                            - reviews
                                            - analytics
                                            - verification
                                            - place_actions
                                            - lifecycle_edit
                                            - lifecycle_unpublish
                                            - direct_messages
                                        supported:
                                          type: boolean
                                        status:
                                          type: string
                                          enum:
                                            - ready
                                            - needs_setup
                                            - needs_reconnect
                                            - blocked
                                            - unsupported
                                            - unknown
                                        reason:
                                          type: string
                                          minLength: 1
                                        requiredScopes:
                                          type: array
                                          items:
                                            type: string
                                            minLength: 1
                                        requiredPermissions:
                                          type: array
                                          items:
                                            type: string
                                            minLength: 1
                                      required:
                                        - key
                                        - supported
                                      additionalProperties: false
                                required:
                                  - platform
                                  - ready
                                  - status
                                additionalProperties: false
                              adAccountsCacheExpiresAt:
                                type: string
                                minLength: 1
                              lastError:
                                type: string
                                minLength: 1
                              lastHealthCheckedAt:
                                type: string
                                minLength: 1
                              createdBy:
                                type: string
                                minLength: 1
                              createdAt:
                                type: string
                                minLength: 1
                              updatedAt:
                                type: string
                                minLength: 1
                            required:
                              - id
                              - organizationId
                              - platform
                              - providerAccountId
                              - enabled
                              - isActive
                              - status
                              - scopes
                              - permissions
                              - metadata
                              - createdBy
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                          healthy:
                            type: boolean
                          checkedAt:
                            type: string
                            minLength: 1
                          issues:
                            type: array
                            items:
                              type: object
                              properties:
                                code:
                                  type: string
                                  minLength: 1
                                message:
                                  type: string
                                  minLength: 1
                              required:
                                - code
                                - message
                              additionalProperties: false
                          readiness:
                            type: object
                            properties:
                              platform:
                                type: string
                                enum:
                                  - twitter
                                  - facebook
                                  - instagram
                                  - linkedin
                                  - tiktok
                                  - youtube
                                  - threads
                                  - reddit
                                  - pinterest
                                  - bluesky
                                  - mastodon
                                  - googlebusiness
                                  - telegram
                                  - snapchat
                                  - discord
                                  - whatsapp
                                  - metaads
                                  - googleads
                                  - tiktokads
                                  - linkedinads
                                  - pinterestads
                                  - xads
                              ready:
                                type: boolean
                              status:
                                type: string
                                enum:
                                  - ready
                                  - needs_setup
                                  - needs_reconnect
                                  - blocked
                                  - unsupported
                                  - unknown
                              checkedAt:
                                type: string
                                minLength: 1
                              reconnectRecommended:
                                type: boolean
                              selectedDestinationId:
                                type: string
                                minLength: 1
                              selectedDestinationName:
                                type: string
                                minLength: 1
                              missingScopes:
                                type: array
                                items:
                                  type: string
                                  minLength: 1
                              missingPermissions:
                                type: array
                                items:
                                  type: string
                                  minLength: 1
                              missingDestinations:
                                type: array
                                items:
                                  type: string
                                  minLength: 1
                              issues:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    code:
                                      type: string
                                      minLength: 1
                                    message:
                                      type: string
                                      minLength: 1
                                  required:
                                    - code
                                    - message
                                  additionalProperties: false
                              capabilities:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      enum:
                                        - publish
                                        - schedule
                                        - media_upload
                                        - video_upload
                                        - photo_upload
                                        - first_comment
                                        - playlist
                                        - page_selection
                                        - account_selection
                                        - creator_info
                                        - location_selection
                                        - location_management
                                        - reviews
                                        - analytics
                                        - verification
                                        - place_actions
                                        - lifecycle_edit
                                        - lifecycle_unpublish
                                        - direct_messages
                                    supported:
                                      type: boolean
                                    status:
                                      type: string
                                      enum:
                                        - ready
                                        - needs_setup
                                        - needs_reconnect
                                        - blocked
                                        - unsupported
                                        - unknown
                                    reason:
                                      type: string
                                      minLength: 1
                                    requiredScopes:
                                      type: array
                                      items:
                                        type: string
                                        minLength: 1
                                    requiredPermissions:
                                      type: array
                                      items:
                                        type: string
                                        minLength: 1
                                  required:
                                    - key
                                    - supported
                                  additionalProperties: false
                            required:
                              - platform
                              - ready
                              - status
                            additionalProperties: false
                        required:
                          - account
                          - healthy
                          - checkedAt
                          - issues
                        additionalProperties: false
                    required:
                      - ok
                      - data
                    additionalProperties: false
                  - type: object
                    properties:
                      ok:
                        type: boolean
                        x-kavenio-const: false
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            minLength: 1
                          message:
                            type: string
                            minLength: 1
                          details: {}
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - ok
                      - error
                    additionalProperties: false
        '401':
          description: Authentication failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    x-kavenio-const: false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        minLength: 1
                      message:
                        type: string
                        minLength: 1
                      details: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
        '404':
          description: Connected account not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    x-kavenio-const: false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        minLength: 1
                      message:
                        type: string
                        minLength: 1
                      details: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
        '422':
          description: Path parameter validation failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    x-kavenio-const: false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        minLength: 1
                      message:
                        type: string
                        minLength: 1
                      details: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
        '500':
          description: Account health check failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    x-kavenio-const: false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        minLength: 1
                      message:
                        type: string
                        minLength: 1
                      details: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Clerk session or OAuth token

````