> ## 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. # Set the sender's approval setting from the extension > Writes the sender's LinkedIn approval setting (`run_mode`), the same setting the sender's LinkedIn page writes, so the two surfaces have one source of truth rather than two that drift. An empty body reads the state without changing it. With a lease nonce, the answer also says whether this browser holds the lease, and which browser does when it does not. ## OpenAPI ````yaml /openapi.json post /linkedin/agent/state/ 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 approval 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 creating and managing integrations. name: integrations - 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: >- The Model Context Protocol endpoint: use Oneprofile from Claude Code, Claude Desktop, Cursor or any other MCP client, with an API key as the bearer token. name: mcp - description: Endpoints for managing billing and subscription information. name: billing - 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 teaching a saved agent from example rows: training sessions, per-row feedback, and the proposed prompt to approve. name: agent-training - 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 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 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: /linkedin/agent/state/: post: tags: - linkedin summary: Set the sender's approval setting from the extension description: >- Writes the sender's LinkedIn approval setting (`run_mode`), the same setting the sender's LinkedIn page writes, so the two surfaces have one source of truth rather than two that drift. An empty body reads the state without changing it. With a lease nonce, the answer also says whether this browser holds the lease, and which browser does when it does not. operationId: linkedin_agent_set_state requestBody: content: application/json: schema: $ref: '#/components/schemas/AgentSetStateSchema' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AgentStateSchema' description: Successful Response '401': content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' description: The agent token is invalid, revoked, or expired. '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' description: Forbidden '422': content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityResponse' description: Invalid request made to the API. '500': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Internal server error. '502': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Bad gateway error. '503': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Service unavailable. security: - APIKeyHeader: [] components: schemas: AgentSetStateSchema: properties: lease_nonce: anyOf: - maxLength: 64 minLength: 8 type: string - type: 'null' description: >- This browser's lease identity. When given, lease_granted in the answer says whether this browser holds the lease; when absent it is always true. title: Lease Nonce run_mode: anyOf: - $ref: '#/components/schemas/LinkedInApprovalMode' - {} description: >- The sender's LinkedIn approval setting, as the side panel sets it: the same setting the sender's LinkedIn page sets. Absent leaves it untouched. title: Run Mode title: AgentSetStateSchema type: object AgentStateSchema: description: >- The authoritative run state, returned on every heartbeat. ``account_mismatch`` is the hard stop: the browser is signed in as somebody other than the account we are bound to, and acting would send this customer's outreach from the wrong identity. ``run_mode`` is the sender's LinkedIn approval setting in force (manual for a sender who never set one): the side panel shows it and can change it. Approval happens on Oneprofile's Tasks page before a step is queued, so a step handed to the browser runs whichever it says. ``queued_count`` counts steps waiting for a browser, not one running in one. properties: account_mismatch: title: Account Mismatch type: boolean approvals_waiting: default: 0 description: >- How many of this sender's LinkedIn steps wait for a person on Oneprofile's Tasks page, less those a paused sequence or paused contact holds; the side panel offers Approve tasks while any do. title: Approvals Waiting type: integer attempts_enabled: default: false description: >- Whether a build that reports attempts (attempts:v1) reports a run cut off without an error from LinkedIn to /actions/{id}/attempts/ and runs the step again only on the answer. The same switch as resume_enabled. title: Attempts Enabled type: boolean checkpoint: title: Checkpoint type: boolean config_version: description: >- The version of the selector and pacing config this server serves. A browser running any other version, older or newer, fetches the config again. title: Config Version type: integer lease_granted: title: Lease Granted type: boolean lease_holder_label: anyOf: - type: string - type: 'null' description: >- When lease_granted is false, what the browser holding the lease calls itself (for example 'Chrome on macOS'); null when that is not known. title: Lease Holder Label poll_after_seconds: description: >- How long to wait before the next check-in: the account's own time between steps, never more, and never so long the browser stops reading as active. At most 15 seconds while work is about to run (the time between steps is running out, a step may start now, or one is running with more behind it), so a missed wake-up costs seconds rather than a whole interval. title: Poll After Seconds type: integer queued_count: title: Queued Count type: integer resume_enabled: default: false description: >- Whether a build that resumes steps (resume:v1) may resume one that stopped without an error from LinkedIn. Off, a stopped step fails for a person to retry, as it did before; the grant and the saved results stay on either way. title: Resume Enabled type: boolean run_mode: $ref: '#/components/schemas/LinkedInApprovalMode' running_claim: anyOf: - enum: - renewed - lost type: string - type: 'null' description: >- For a check-in that named a running step: renewed while that claim is still this browser's, lost once it is not (settled, rejected, or lapsed while the browser was gone), and the browser then stops the step before it changes anything more. Null for a check-in that named none. title: Running Claim unpaced_waiting: default: false description: >- A step that waits for no gap between steps (one the Oneprofile team fired to test the sender) could be handed out now: ask for it alone (unmetered_only) without waiting out this browser's own gap. title: Unpaced Waiting type: boolean usage: default: [] items: $ref: '#/components/schemas/LinkedInKindUsageReadSchema' title: Usage type: array usage_resets_at: anyOf: - format: date-time type: string - type: 'null' description: >- When today's counts in usage start over: 00:00 in the sender's timezone. Older servers leave it out, and a client then reads the next UTC midnight. title: Usage Resets At wait: anyOf: - $ref: '#/components/schemas/LinkedInWaitReadSchema' - type: 'null' description: >- What the next step is waiting on, and until when, as this browser sees it (another browser holding the lease reads as lease_held_elsewhere); null while nothing is queued. required: - run_mode - checkpoint - lease_granted - account_mismatch - queued_count - poll_after_seconds - config_version title: AgentStateSchema 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 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 LinkedInApprovalMode: description: >- Whether a person approves a sender's LinkedIn steps before they run, or they run on their own. The sender's own LinkedIn setting, kept on the sender beside their email modes so the approval queue reads one home for both. The absence of one (``SenderProfileDTO.linkedin_approval_mode`` is None) reads as MANUAL: nothing runs on somebody's LinkedIn unattended until they have said so. The approval queue still tells "never set" apart from "chose manual", which is the level its settings surfaces name. enum: - manual - auto title: LinkedInApprovalMode type: string LinkedInKindUsageReadSchema: description: |- One limit's spend, today and over the rolling week. One entry per limit, so there is no ``inmail`` entry: InMails spend the message limit and are counted in the ``send_message`` entry. properties: daily_limit: title: Daily Limit type: integer kind: $ref: '#/components/schemas/LinkedInActionKind' remaining_today: description: >- What may still run today: the daily limit's headroom, held to the weekly limit's when that is nearer. title: Remaining Today type: integer used_this_week: default: 0 description: Spent over today and the six days before it. title: Used This Week type: integer used_today: title: Used Today type: integer weekly_limit: anyOf: - type: integer - type: 'null' description: The ceiling over any seven days; null when there is none. title: Weekly Limit required: - kind - used_today - daily_limit - remaining_today title: LinkedInKindUsageReadSchema type: object LinkedInWaitReadSchema: description: What the account's next step is waiting on, and until when. properties: next_at: anyOf: - format: date-time type: string - type: 'null' description: >- When the next step may start: the end of the time between steps for pacing, the reset for daily_cap and weekly_cap, when the hours open for outside_window, and null otherwise. title: Next At reason: $ref: '#/components/schemas/LinkedInWaitReason' description: >- The one reason the next step has not started, highest first: not_connected, checkpoint, lease_held_elsewhere (another browser drives the account), in_flight (a step is running), outside_window (the work that could run waits for its sequences' sending hours, in the sender's timezone), idle (nothing is queued; a step that waits for a person waits on Tasks before it is queued), daily_cap, weekly_cap or kind_disabled (every kind that could run is held by a limit, or a limit set to zero), pacing (the time between steps), or ready. resets_at: anyOf: - format: date-time type: string - type: 'null' description: >- The moment a daily or weekly limit next frees a slot, midnight in the sender's timezone; null for every other reason. A moment, never 'today' or 'tomorrow'. title: Resets At required: - reason - next_at - resets_at title: LinkedInWaitReadSchema 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 LinkedInActionKind: description: >- What the browser agent is being asked to do. The four ``CHECK_*``/``READ_*`` kinds are housekeeping: they read our own outbound invitations, our own newest connections and our own conversations to detect what the contact did, so they are free and deliberately excluded from the priced kinds below. ``CHECK_CONNECTIONS`` reads the first batch of the sender's connections list, newest first: a person found there has accepted, whenever the invitation went out. It is how an acceptance is noticed at all once an invitation has fallen out of the ten rows the sent list shows a background tab. ``CHECK_INBOX`` scans the conversation list for threads with new inbound activity; ``READ_CONVERSATION`` opens one of them and reads it in full. The split keeps LinkedIn activity proportional to real replies: the cheap scan runs on every sweep, the expensive read only where the scan saw a change. ``LIKE_LATEST_POST`` targets the contact's most recent post at the moment the browser runs it. A contact with no posts is not a failure: the driver reports the action ``SKIPPED``, and the sequence advances either way. Every profile-targeted outcome carries the facts the browser read off the profile, including the three-state Premium "Open Profile" reading; see the section comment above the outcome models. enum: - profile_view - connection_request - send_message - inmail - withdraw_connection_request - follow_contact - like_latest_post - check_sent_invitations - check_connections - check_inbox - read_conversation title: LinkedInActionKind type: string LinkedInWaitReason: description: >- Why an account's next step has not started, as one reason, highest first. ``OUTSIDE_WINDOW`` is work that could run but for its run window, shut now in the sender's timezone (2026-10-01); ``IDLE`` is nothing waiting in line. ``DAILY_CAP``, ``WEEKLY_CAP`` and ``KIND_DISABLED`` are named only when every kind that could be handed out is held by one. ``PACING`` is the time between steps, ``READY`` a step that may start now. enum: - not_connected - checkpoint - lease_held_elsewhere - in_flight - outside_window - idle - daily_cap - weekly_cap - kind_disabled - pacing - ready title: LinkedInWaitReason type: string securitySchemes: APIKeyHeader: in: header name: X-API-Key type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.