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

# Start a LinkedIn connect for a sender profile

> Connect a LinkedIn account to this sender profile: the browser is remembered for 24 hours, so the account it produces binds here instead of birthing a sender profile. One browser source per call (two is 422). proxy_country_code or custom_proxy_config answers a cloud-browser login link a human signs in to (result.mode connect). vendor_profile_id answers no link: its browser is found or created and run, the profile's signed-in session births the account (result.mode run: follow get_sender_profile_linkedin_connect_status until bound or failed), or the account gtm-api already holds on it binds at once (result.mode bound). A sender profile that already holds an account gets the re-login link of that account's browser (result.mode relogin; 409 linkedin_browser_missing: detach and connect again). A repeat while a browser is pending reuses it (a new link, never a second browser); on 503 linkedin_connect_unconfirmed call again in a minute, the browser gtm-api made is picked up.

Refusals: 422 proxy_pool_empty, vendor_profile_not_found, vendor_profile_no_run_access; 409 linkedin_profile_held_elsewhere, linkedin_profile_busy, linkedin_browser_no_server; 402 linkedin_sender_profiles_full (the plan's LinkedIn sender profiles are all in use) or subscription_required; 403 gtm_scope_missing; 501 while the gtm bridge is unconfigured.

Contract:
- MCP tool `start_sender_profile_linkedin_connect`, registry package `mcp.unibox/sender_profiles`, mount `unibox.sender-profiles`.
- Operation `action`, response envelope `action`.
- Flags: none.



## OpenAPI

````yaml /api-reference/unibox/openapi.yaml post /api/sender-profiles/{sid}/linkedin/start-connect
openapi: 3.0.3
info:
  title: 'GetSales public contract: gs.service.unibox'
  description: >-
    The team inbox and the AI SDR: every LinkedIn and email thread in one place
    (conversations, messages, the timeline events), the manual tasks a thread
    spawns, the sender profiles the team speaks through with their LinkedIn
    account and mailboxes, and the one agent per team with its scenarios, plans
    and runs.


    GENERATED. This document is projected from the Zod MCP tool registry in
    `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by
    hand; edit the tool definition and regenerate with `pnpm openapi:public`.


    Surface: the public `/api` contract of `gs.service.unibox`, 125 operations.
    This is the only OpenAPI document the platform publishes. Internal
    (`/internal`) and health endpoints are deliberately absent: they are not
    part of any contract, they can change without notice, and the service source
    is their only description.


    Conventions:

    - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header.

    - Every success body is an MCP envelope: `success: true` plus one typed
    `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`,
    `group_by`, `action`), and a `meta` block with `trace_id` for support.

    - Every failure is the same `McpError` envelope with a code from a fixed
    16-code taxonomy, so a client maps errors once.

    - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward
    `cursor`; `page_size: 0` returns counts only.

    - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`)
    travel as JSON text and array-valued ones repeat as `name[]=value`.

    - The MCP-only `_meta` field (usage analytics) never reaches the backend and
    is not part of this contract.
  version: '1.0'
  contact:
    name: GetSales
    url: https://getsales.io
    email: support@getsales.io
  license:
    name: Proprietary
    url: https://getsales.io/terms
servers:
  - url: https://beta.getsales.io/unibox/v1
    description: >-
      Production (the gateway path on the beta ring; the origin is provisioned
      per DEPLOY_MAP.md)
security:
  - BearerJwt: []
    TeamSid: []
tags:
  - name: agent_answers
    description: >-
      Registry package `mcp.unibox/agent_answers`, served on MCP mount
      `unibox.knowledge`.
  - name: agent_conversation_uploads
    description: >-
      Registry package `mcp.unibox/agent_conversation_uploads`, served on MCP
      mount `unibox.agent-memory`.
  - name: agent_examples
    description: >-
      Registry package `mcp.unibox/agent_examples`, served on MCP mount
      `unibox.agent-memory`.
  - name: agent_hints
    description: >-
      Registry package `mcp.unibox/agent_hints`, served on MCP mount
      `unibox.agent-memory`.
  - name: agent_plans
    description: >-
      Registry package `mcp.unibox/agent_plans`, served on MCP mount
      `unibox.agent`.
  - name: agent_runs
    description: >-
      Registry package `mcp.unibox/agent_runs`, served on MCP mount
      `unibox.agent-memory`.
  - name: agent_scenarios
    description: >-
      Registry package `mcp.unibox/agent_scenarios`, served on MCP mount
      `unibox.agent`.
  - name: agent_source_parses
    description: >-
      Registry package `mcp.unibox/agent_source_parses`, served on MCP mount
      `unibox.knowledge`.
  - name: agent_sources
    description: >-
      Registry package `mcp.unibox/agent_sources`, served on MCP mount
      `unibox.knowledge`.
  - name: agent_tests
    description: >-
      Registry package `mcp.unibox/agent_tests`, served on MCP mount
      `unibox.agent-memory`.
  - name: agents
    description: >-
      Registry package `mcp.unibox/agents`, served on MCP mount
      `unibox.website`.
  - name: conversation_events
    description: >-
      Registry package `mcp.unibox/conversation_events`, served on MCP mount
      `unibox.inbox`.
  - name: conversations
    description: >-
      Registry package `mcp.unibox/conversations`, served on MCP mount
      `unibox.inbox`.
  - name: messages
    description: >-
      Registry package `mcp.unibox/messages`, served on MCP mount
      `unibox.inbox`.
  - name: sender_profiles
    description: >-
      Registry package `mcp.unibox/sender_profiles`, served on MCP mount
      `unibox.sender-profiles`.
  - name: tasks
    description: Registry package `mcp.unibox/tasks`, served on MCP mount `unibox.inbox`.
  - name: timeline
    description: >-
      Registry package `mcp.unibox/timeline`, served on MCP mount
      `unibox.inbox`.
paths:
  /api/sender-profiles/{sid}/linkedin/start-connect:
    post:
      tags:
        - sender_profiles
      summary: Start a LinkedIn connect for a sender profile
      description: >-
        Connect a LinkedIn account to this sender profile: the browser is
        remembered for 24 hours, so the account it produces binds here instead
        of birthing a sender profile. One browser source per call (two is 422).
        proxy_country_code or custom_proxy_config answers a cloud-browser login
        link a human signs in to (result.mode connect). vendor_profile_id
        answers no link: its browser is found or created and run, the profile's
        signed-in session births the account (result.mode run: follow
        get_sender_profile_linkedin_connect_status until bound or failed), or
        the account gtm-api already holds on it binds at once (result.mode
        bound). A sender profile that already holds an account gets the re-login
        link of that account's browser (result.mode relogin; 409
        linkedin_browser_missing: detach and connect again). A repeat while a
        browser is pending reuses it (a new link, never a second browser); on
        503 linkedin_connect_unconfirmed call again in a minute, the browser
        gtm-api made is picked up.


        Refusals: 422 proxy_pool_empty, vendor_profile_not_found,
        vendor_profile_no_run_access; 409 linkedin_profile_held_elsewhere,
        linkedin_profile_busy, linkedin_browser_no_server; 402
        linkedin_sender_profiles_full (the plan's LinkedIn sender profiles are
        all in use) or subscription_required; 403 gtm_scope_missing; 501 while
        the gtm bridge is unconfigured.


        Contract:

        - MCP tool `start_sender_profile_linkedin_connect`, registry package
        `mcp.unibox/sender_profiles`, mount `unibox.sender-profiles`.

        - Operation `action`, response envelope `action`.

        - Flags: none.
      operationId: start_sender_profile_linkedin_connect
      parameters:
        - name: sid
          in: path
          required: true
          description: Sender profile sid (ub_sp_…).
          schema:
            type: string
            minLength: 18
            maxLength: 18
            pattern: ^ub_sp_
            description: Sender profile sid (ub_sp_…).
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartSenderProfileLinkedinConnectRequest'
      responses:
        '200':
          description: '`action` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartSenderProfileLinkedinConnectResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  schemas:
    StartSenderProfileLinkedinConnectRequest:
      type: object
      description: Request body of `start_sender_profile_linkedin_connect`.
      properties:
        proxy_country_code:
          type: string
          nullable: true
          minLength: 2
          maxLength: 2
          description: >-
            ISO 3166-1 alpha-2 country for a browser off the MANAGED proxy pool.
            Default US. Offer only what
            list_sender_profile_linkedin_proxy_countries reports in stock: a
            country with no free proxy is a 422 proxy_pool_empty on this field.
        custom_proxy_config:
          type: object
          nullable: true
          properties:
            ip:
              type: string
              maxLength: 255
              description: Proxy host or IP.
            port:
              type: integer
              minimum: 1
              maximum: 65535
              description: Proxy port.
            mode:
              type: string
              enum:
                - http
                - socks4
                - socks5
              description: >-
                Proxy protocol; default http. There is no https mode: GoLogin
                cannot apply one.
            username:
              type: string
              nullable: true
              maxLength: 255
              description: >-
                Proxy username; null = the proxy takes no credentials. Passed
                straight to gtm-api, never stored here.
            password:
              type: string
              nullable: true
              maxLength: 255
              description: >-
                Proxy password. Passed straight to gtm-api and never stored
                here.
          required:
            - ip
            - port
          description: >-
            Route the minted browser through the team's OWN proxy, not the
            managed pool; ip and port required when sent. Check it first with
            check_sender_profile_linkedin_proxy: the connect probes again and
            refuses a dead one (422 custom_proxy_unreachable_{kind}).
        vendor_profile_id:
          type: string
          nullable: true
          description: >-
            The team's OWN GoLogin profile id: 24 hex characters, the id shown
            in GoLogin, never the profile URL or a share link. Its proxy stays
            on the profile, so no proxy field may accompany it.
        history_since:
          type: string
          nullable: true
          pattern: ^(now|\d{4}-\d{2}-\d{2})$
          description: >-
            The account's history window: import its conversations from this day
            (YYYY-MM-DD) on, into the inbox and the people's activity, or none
            of the past with now (only what arrives after it lands). Omitted or
            null = all. Kept on the pending connect until then.
        history_scope:
          type: string
          nullable: true
          enum:
            - all
            - playtable_people
          description: >-
            The account's import scope: playtable_people (omitted or null, the
            default) takes only the conversations with a person the workspace
            keeps in a playtable, all every conversation. The pending connect
            keeps it until the account lands.
    StartSenderProfileLinkedinConnectResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        operation:
          type: string
          enum:
            - action
        action:
          type: string
          description: kebab-case verb; matches the route segment.
        item:
          type: object
          nullable: true
          additionalProperties: {}
        result:
          type: object
          properties:
            antidetect_browser_sid:
              type: string
              description: >-
                The browser the account comes through (ab_br_…): the cloud
                browser the login runs in, or gtm-api's browser on the team's
                own GoLogin profile. The sender profile remembers it so the
                created account binds here.
            connect_url:
              type: string
              nullable: true
              description: >-
                One-time link to the cloud browser: the human logs into LinkedIn
                there; it expires. null on a GoLogin profile (mode run or
                bound): nothing to open.
            connect_url_expires_at:
              type: string
              nullable: true
              description: ISO 8601 UTC expiry of the link; null when there is no link.
            mode:
              type: string
              description: >-
                connect = a new browser was minted and the link opens the login;
                relogin = the re-login link for the account this sender profile
                already holds; run = gtm-api's browser on the team's own GoLogin
                profile was started, no link, the profile's own signed-in
                session births the account (follow
                get_sender_profile_linkedin_connect_status); bound = the account
                gtm-api already held on that profile is on the sender profile
                now.
          required:
            - antidetect_browser_sid
            - connect_url
            - connect_url_expires_at
            - mode
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - operation
        - action
        - item
        - result
        - meta
    McpError:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
                - nothing_to_update
                - not_found
                - relation_not_found
                - invalid_transition
                - limit_exceeded
                - payment_required
                - duplicate_rejected
                - conflict
                - delete_blocked
                - unauthorized
                - forbidden
                - rate_limited
                - internal_error
                - service_unavailable
                - not_implemented
            message:
              type: string
            recoverable:
              type: boolean
            suggestion:
              type: string
            field_errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: object
                  properties:
                    rule:
                      type: string
                    message:
                      type: string
                  required:
                    - rule
                    - message
            blockers:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    description: >-
                      Machine-readable blocker type (active_flow, pending_tasks,
                      …).
                  severity:
                    type: string
                    enum:
                      - hard
                      - soft
                    description: >-
                      hard = external action required; soft = acknowledge is
                      enough.
                  description:
                    type: string
                  entity_sid:
                    type: string
                    nullable: true
                  count:
                    type: integer
                  resolution:
                    type: string
                    description: 'Hard: tool name to call. Soft: code for acknowledge[].'
                  resolution_hint:
                    type: string
                required:
                  - type
                  - severity
                  - description
                  - entity_sid
                  - resolution
                  - resolution_hint
            context:
              type: object
              additionalProperties: {}
          required:
            - code
            - message
            - recoverable
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - error
  responses:
    McpClientError:
      description: >-
        MCP error envelope. `error.code` is one of validation_failed,
        nothing_to_update, not_found, relation_not_found, invalid_transition,
        limit_exceeded, payment_required, duplicate_rejected, conflict,
        delete_blocked, unauthorized, forbidden, rate_limited, not_implemented.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
    McpServerError:
      description: >-
        MCP error envelope with `error.code` internal_error or
        service_unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
  securitySchemes:
    BearerJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token issued by gs.service.id. Its `access_identity` claim
        carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is
        authoritative.
    TeamSid:
      type: apiKey
      in: header
      name: Team-SID
      description: >-
        Team scope for tokens that do not carry one. Ignored when the token
        already names a team.

````

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