> ## 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.

# Join the workspace's shared Slack channel

> Make sure the caller is on their way into the workspace's shared Slack channel. The page calls this the first time it loads: with no channel yet it starts the run that creates one and invites the caller, and answers `provisioning` for the page to poll. With a channel ready it sends the caller their own invitation, which is also how a resend works. Idempotent, so it answers 200 rather than 201.

The invitation goes to the caller's own verified email and nowhere else. A refusal Slack itself made — their Slack being on a free plan, for instance — is not an error: it comes back in the body with a sentence to show them.



## OpenAPI

````yaml /openapi.json post /design-partner/slack-channel/invite/
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 Getting started checklist: a workspace's progress through the six
      steps from its first people search to its first launched sequence.
    name: onboarding
  - description: Sender profiles, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - 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 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: 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: >-
      The per-table AI Assistant: named conversations, the column suggestions a
      build turn produces, and the questions an analyze turn answers.
    name: table-assistant
  - 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:
  /design-partner/slack-channel/invite/:
    post:
      tags:
        - design-partner
      summary: Join the workspace's shared Slack channel
      description: >-
        Make sure the caller is on their way into the workspace's shared Slack
        channel. The page calls this the first time it loads: with no channel
        yet it starts the run that creates one and invites the caller, and
        answers `provisioning` for the page to poll. With a channel ready it
        sends the caller their own invitation, which is also how a resend works.
        Idempotent, so it answers 200 rather than 201.


        The invitation goes to the caller's own verified email and nowhere else.
        A refusal Slack itself made — their Slack being on a free plan, for
        instance — is not an error: it comes back in the body with a sentence to
        show them.
      operationId: invite_to_design_partner_slack_channel
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DesignPartnerSlackReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not found
        '409':
          description: The invitation cannot be sent as things stand.
        '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: []
        - HTTPBearer: []
components:
  schemas:
    DesignPartnerSlackReadSchema:
      description: >-
        The workspace's shared Slack channel, and THIS caller's invitation to
        it.


        Two independent facts rather than one status: the channel belongs to the

        organization, the invitation belongs to the person. A colleague of
        whoever

        created the channel sees it exists and is offered their own invitation,

        instead of being told they are already somewhere they cannot see.
      properties:
        channel_failure_message:
          anyOf:
            - type: string
            - type: 'null'
          description: What to tell the reader when provisioning failed. Null otherwise.
          title: Channel Failure Message
        channel_name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The channel's name, without the leading hash. Null until it is
            ready.
          title: Channel Name
        channel_state:
          description: >-
            Where the workspace's channel is. 'none' means nobody has asked yet,
            and the page asks the moment it loads. 'provisioning' is the run
            that creates it, which the page polls. 'failed' carries a sentence.
          enum:
            - none
            - provisioning
            - ready
            - failed
          title: Channel State
          type: string
        channel_url:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            A link that opens the channel in the reader's Slack. Null until it
            is ready.
          title: Channel Url
        invite_can_retry:
          description: >-
            Whether pressing the button again could plausibly work. False for a
            refusal about our own Slack workspace's settings, which no retry
            fixes.
          title: Invite Can Retry
          type: boolean
        invite_email:
          anyOf:
            - type: string
            - type: 'null'
          description: The address the invitation went to.
          title: Invite Email
        invite_message:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            What to tell the reader when Slack refused, already written for a
            person rather than a log. Null when nothing was refused.
          title: Invite Message
        invite_sent_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When Slack accepted the invitation.
          title: Invite Sent At
        invite_status:
          description: >-
            This caller's own invitation. Per person, because Slack binds an
            invitation to one email address.
          enum:
            - none
            - sent
            - refused
          title: Invite Status
          type: string
        partner_joined:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            Whether anybody from the partner's workspace is actually in the
            channel. Null when we could not tell: there is no Slack event
            subscription, so this is a live read that is allowed to fail.
          title: Partner Joined
      required:
        - channel_state
        - channel_failure_message
        - channel_name
        - channel_url
        - partner_joined
        - invite_status
        - invite_email
        - invite_sent_at
        - invite_message
        - invite_can_retry
      title: DesignPartnerSlackReadSchema
      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
    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

````