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

# Connect the Outlook mailbox of your Microsoft sign-in

> Connects the Outlook mailbox of the Microsoft account the person linked in Clerk, after re-authorizing it with `mail_scopes`. 403 when the account does not grant send and read: usually the organization's admin must approve Oneprofile first (`POST /mailboxes/microsoft/approval/`).



## OpenAPI

````yaml /openapi.json post /mailboxes/microsoft/connect/
openapi: 3.1.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: >-
    REST API reference for Oneprofile, the GTM data layer for your CRM. Manage
    tables, enrichments, and integrations. Authenticate with an API key to get
    started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: API Reference | Oneprofile
  version: '0.0'
servers:
  - url: https://api.getoneprofile.ai
security: []
tags:
  - description: >-
      The docked AI Assistant: its general chat about the workspace and the
      product, streamed as Server-Sent Events, and the one list of a person's
      threads across every assistant, with pin, rename, delete and the
      search-to-table link.
    name: assistant
  - description: >-
      The messages a person keeps to send the assistant again: the ones the
      workspace saved and the ones that ship with the product, with save,
      rename, edit and delete.
    name: assistant-prompt
  - description: >-
      Granted workspace actions: what the AI Assistant proposed or applied in a
      conversation, the approve and dismiss decisions on each card, the
      workspace's spend threshold and default grants, and the eight verbs.
    name: workspace-actions
  - description: >-
      The Getting started checklist: a workspace's progress through the six
      steps from its first people search to its first launched sequence.
    name: onboarding
  - description: Senders, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: >-
      The workspace's recontact rule: how long before anyone hears from us
      again.
    name: contact_cooldown
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The outbound agent behind a sequence: the voice it writes in, its
      per-message prompts, what it wrote and what people told it.
    name: outbound-agents
  - description: >-
      The LinkedIn channel: connecting an account to a sender, its safety limits
      and history, and the protocol the browser extension speaks.
    name: linkedin
  - description: >-
      The approval queue: everything waiting on a person across every sender and
      channel, and the workspace's manual or automatic modes per channel.
    name: outreach
  - description: 'The unified outreach inbox: threads, replies, labels, events.'
    name: inbox
  - description: 'The AI reply layer: workspace settings, drafts, and approval.'
    name: inbox-ai
  - description: Notification rules, per-user preferences, and the Slack connection.
    name: notifications
  - description: Endpoints for seeing all available integration types.
    name: integration-types
  - description: Endpoints for listing, checking and deleting integrations.
    name: integrations
  - description: >-
      Create, preview and update an integration of any type: the body's
      integration_type picks the config and credentials it takes.
    name: integration-specific
  - description: Endpoints for the generic OAuth install/claim app-listings engine.
    name: app-listings
  - description: Endpoints for creating and managing API keys.
    name: apikey
  - description: >-
      AI apps connected to the workspace: Claude, ChatGPT, Claude Code or any
      other MCP client a person signed in to Oneprofile's MCP server with.
    name: ai_apps
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: >-
      Accounts: every company the workspace's tables name, with the people at
      it, its key facts, its tables, its org chart and what went to its people;
      the tables that feed it (Sources) and the merges a person made.
    name: accounts
  - description: Endpoints for creating and managing tables.
    name: tables
  - description: Endpoints for table columns, formula previews, and on-demand column runs.
    name: table-columns
  - description: Endpoints for table rows and manual cell edits.
    name: table-rows
  - description: Endpoints for observing and cancelling table recompute runs.
    name: table-runs
  - description: >-
      Endpoints for org-shared per-column display preferences: hidden, pinned,
      width, and colour tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organisation calls each colour. Org-level, not per-table.
    name: table-column-color-labels
  - description: >-
      Endpoints for the enrichment action catalog, model list, presets, draft
      generation, and saved agents.
    name: table-enrichments
  - description: >-
      Endpoints for an agent's Preview: example rows run one at a time, and a
      Looks good on each. Needs work lives under agent-learnings.
    name: agent-training
  - description: >-
      An agent's learnings, the one-line rules it follows on every output, and
      the thumbs down that teaches them: give one with what was wrong, list the
      ones on a subject, Undo one, and price the redo it would run.
    name: agent-learnings
  - description: >-
      The durable audit trail of a table's enrichment actions: configured,
      edited, run, cancelled, and settled cost.
    name: table-enrichment-audit-logs
  - description: Endpoints for saving and applying column templates.
    name: table-templates
  - description: Server-sent change feed for a table's grid.
    name: table-events
  - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.'
    name: table-views
  - description: >-
      Endpoints for PER-USER table preferences: favourites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organisation legitimately see different answers.
    name: table-user-prefs
  - description: >-
      Endpoints for building a table from an uploaded CSV: upload and preview
      the inferred columns, commit the reviewed mapping, then poll the row load.
    name: table-imports
  - description: Endpoint for downloading a table's rows as CSV.
    name: table-export
  - description: >-
      Endpoints for the integration a table imports from: attach and preview it,
      promote imported fields into columns, and run the import on demand.
    name: table-sources
  - description: >-
      Endpoints for the webhook URL an app or a tool of your own sends records
      to: what can send them, make the URL, show it again, replace it, revoke
      it, save the app's secrets, resume a paused feed, and read and retry the
      deliveries that did not fit.
    name: table-webhooks
  - description: >-
      Endpoints for a table's recurring import cadence: set it, pause it, and
      read the next fire times.
    name: table-schedules
  - description: >-
      Endpoints for pushing a table's rows out to a connected integration: list
      writable destinations, derive their write capabilities, and map export
      columns.
    name: table-writeback
  - description: >-
      Endpoints backing a lookup column's setup: the connections whose records a
      column could read, and the identity fields one record type can be looked
      up by.
    name: table-integration-lookup
  - description: >-
      Endpoints for sourcing leads from the lead database: count and preview
      matches, land them in a table, and keep saved searches. Alongside people
      and company searches, leads can be sourced from buying signals (what a
      company or person just did), with a catalogue endpoint behind the picker
      that builds them.
    name: find-leads
  - description: >-
      Endpoints for discovering a domain's subdomains from public certificate
      logs and landing the results in a table.
    name: find-subdomains
  - description: Endpoints for the credit balance meter and usage reporting.
    name: credits
  - description: >-
      Endpoints for the workspace referral program: the shareable link, the
      friends who joined through it, and claiming a code after signup.
    name: referral
  - description: >-
      Endpoints for the affiliate program's own dashboard: enrolling and
      claiming a code, the summary, stats and activity feed, the commission
      ledger, and identity verification and payouts.
    name: affiliate
  - description: >-
      Endpoints for recording where a new workspace came from: the marketing
      page or campaign its signup link carried, sent once after signup.
    name: attribution
  - description: >-
      Endpoints for the design partner program's customer surface: whether this
      workspace is a design partner, the badges its feedback has earned, and
      sending and reading that feedback.
    name: design-partner
  - description: >-
      Endpoints for the org-level AI business context (company description,
      ideal customer profile, buyer personas, interest signals and social
      proof), plus domain-based generation and the reference documents whose
      summaries ride alongside those fields.
    name: ai-context
  - description: >-
      Endpoints for the signed-in user's Google Drive connection: starting and
      finishing the OAuth grant, checking or dropping it, and minting the
      short-lived token the Google Picker needs.
    name: google-drive
paths:
  /mailboxes/microsoft/connect/:
    post:
      tags:
        - senders
      summary: Connect the Outlook mailbox of your Microsoft sign-in
      description: >-
        Connects the Outlook mailbox of the Microsoft account the person linked
        in Clerk, after re-authorizing it with `mail_scopes`. 403 when the
        account does not grant send and read: usually the organization's admin
        must approve Oneprofile first (`POST /mailboxes/microsoft/approval/`).
      operationId: connect_microsoft_mailbox
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MicrosoftConnectSchema'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailboxReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Send and read were not granted.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Outlook is not available here.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Not a work account.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          description: Microsoft or Clerk could not be reached.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    MicrosoftConnectSchema:
      description: Connect the Outlook mailbox of the signed-in person's Microsoft account.
      properties:
        external_account_id:
          anyOf:
            - maxLength: 128
              type: string
            - type: 'null'
          description: >-
            Which of the person's linked Microsoft accounts (Clerk's external
            account id); omitted, the first that grants send and read.
          title: External Account Id
        sender_profile_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: Attach the new mailbox to this sender on connect.
          title: Sender Profile Id
      title: MicrosoftConnectSchema
      type: object
    MailboxReadSchema:
      properties:
        bounce_rate:
          anyOf:
            - type: number
            - type: 'null'
          description: DSNs / accepted sends, lifetime.
          title: Bounce Rate
        connection_status:
          $ref: '#/components/schemas/MailboxConnectionStatus'
        created_at:
          format: date-time
          title: Created At
          type: string
        daily_send_limit:
          description: The daily send limit set on the mailbox.
          title: Daily Send Limit
          type: integer
        daily_send_limit_cap:
          anyOf:
            - $ref: '#/components/schemas/DailySendLimitCap'
            - type: 'null'
          description: >-
            Why today's ceiling is below 2,000: `personal_gmail`, or
            `new_mailbox` for a mailbox in its first 30 days. Null when it is
            not.
        daily_send_limit_ceiling:
          description: >-
            The most the mailbox may send today, whatever its limit says: 500
            for personal Gmail and for a mailbox in its first 30 days after it
            was first connected, 2,000 otherwise.
          title: Daily Send Limit Ceiling
          type: integer
        daily_send_limit_max:
          description: >-
            The most `daily_send_limit` may be set to: 500 for a personal Gmail
            address, 2,000 for any other mailbox.
          title: Daily Send Limit Max
          type: integer
        disconnected_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Disconnected At
        disconnected_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Disconnected Reason
        effective_daily_send_limit:
          description: >-
            What the mailbox may send today: its limit, held under today's
            ceiling. Usage and capacity count against this.
          title: Effective Daily Send Limit
          type: integer
        email_address:
          title: Email Address
          type: string
        id:
          format: uuid
          title: Id
          type: string
        last_verified_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the grant last passed its check.
          title: Last Verified At
        provider:
          $ref: '#/components/schemas/MailboxProvider'
        reply_rate:
          anyOf:
            - type: number
            - type: 'null'
          description: Genuine replies / accepted sends, lifetime.
          title: Reply Rate
        sender_profile_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Sender Profile Id
        updated_at:
          format: date-time
          title: Updated At
          type: string
        usage:
          anyOf:
            - $ref: '#/components/schemas/MailboxUsageReadSchema'
            - type: 'null'
      required:
        - id
        - sender_profile_id
        - provider
        - email_address
        - connection_status
        - daily_send_limit
        - daily_send_limit_max
        - daily_send_limit_ceiling
        - daily_send_limit_cap
        - effective_daily_send_limit
        - disconnected_at
        - disconnected_reason
        - created_at
        - updated_at
      title: MailboxReadSchema
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
        - detail
      title: UnauthorizedResponse
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
        - detail
      title: ForbiddenResponse
      type: object
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
        - detail
      title: NotFoundResponse
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: >-
            The detail of the error. This is the error message to show to the
            user. You should also use the issues field to show more detailed
            error messages per field. Use this field for a single liner error
            message.
          title: Detail
          type: string
        issues:
          description: >-
            The issues that caused the error. There can be multiple issues. Each
            issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
        - detail
        - issues
      title: UnprocessableEntityResponse
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
        - detail
      title: ServerErrorResponse
      type: object
    MailboxConnectionStatus:
      description: Whether the mailbox's grant currently authenticates.
      enum:
        - connected
        - disconnected
      title: MailboxConnectionStatus
      type: string
    DailySendLimitCap:
      description: >-
        Why a mailbox sends under the capped ceiling (500 a day) today, below
        Google Workspace's 2,000.


        ``PERSONAL_GMAIL``: a gmail.com or googlemail.com address, which Google
        holds to

        500 a day; its own limit can never be set higher. ``NEW_MAILBOX``: any
        other

        mailbox in its first 30 days after it was first connected to Oneprofile,
        the

        stand-in for a new or trial Workspace account, whose age Gmail does not
        tell

        us. Its own limit may be set higher and takes effect once the 30 days
        are over.
      enum:
        - personal_gmail
        - new_mailbox
        - onmicrosoft_domain
      title: DailySendLimitCap
      type: string
    MailboxProvider:
      description: >-
        Which email provider a mailbox connects through.


        Every provider is implemented behind ``providers.EmailProviderBase``, so
        callers

        never see which one a mailbox uses.


        ``GOOGLE_WORKSPACE`` holds a per-mailbox OAuth grant (consent screen,

        refresh token). ``GOOGLE_WORKSPACE_DWD`` holds no grant at all: tokens
        are

        minted on demand via domain-wide delegation as the platform service

        account, so its rows carry an empty ``refresh_token`` forever. It is the
        path

        imported fleets (e.g. InboxKit) connect through. ``GOOGLE_CLERK`` is the
        Google

        sign-in itself: the onboarding wizard's person consents to Gmail once,
        at sign-up,

        and Clerk keeps that grant, so the row's ``refresh_token`` holds the
        Clerk user id

        whose Google connection each fresh token is read from.


        ``MICROSOFT_CLERK`` is the Microsoft 365 twin of ``GOOGLE_CLERK``:
        Outlook through

        Microsoft Graph, with the grant held by the person's Clerk Microsoft
        sign-in. The row's

        ``refresh_token`` holds the Clerk user id and ``provider_account_id``
        the Clerk

        external account the token is read from. ``MICROSOFT_365_APP`` is the
        twin of

        ``GOOGLE_WORKSPACE_DWD``: Graph with an application token for a tenant
        whose admin

        granted Oneprofile once, so its rows carry an empty ``refresh_token``
        too.
      enum:
        - google_workspace
        - google_workspace_dwd
        - google_clerk
        - microsoft_clerk
        - microsoft_365_app
      title: MailboxProvider
      type: string
    MailboxUsageReadSchema:
      description: >-
        Volume only; the ceiling it runs against is the mailbox's
        `effective_daily_send_limit`.
      properties:
        sent_today:
          title: Sent Today
          type: integer
        sent_yesterday:
          title: Sent Yesterday
          type: integer
      required:
        - sent_today
        - sent_yesterday
      title: MailboxUsageReadSchema
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: >-
            The location of the error. Always contains 1 or 2 elements. The
            first element is the type of location (e.g. 'body', 'query', 'path',
            'header'). The second element is the name of the field that caused
            the error. If the error is not related to a specific field, the
            second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: >-
            The type of the error. Useful for frontend code to handle different
            types of errors.
          title: Type
          type: string
      required:
        - loc
        - msg
        - type
        - input
      title: UnprocessableEntityIssue
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http

````

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