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

# Create integration request

> Any account member may submit demand. Creates IntegrationRequest on Current.account with Current.user; account_id/user_id in the body are ignored. Catalogue keys normalize known apps; otherwise app_name is squished and matched case-insensitively or stored as typed. Appears in the super-admin integration requests view. Grants no connection or entitlement. Validation returns message and attributes (invalid attribute names), not per-field messages. Connected-app credentials are held by the integration provider and are not returned by any of these operations. ENG-5874 / ENG-5831 track consistent unknown-provider and field-level validation behavior; this documents current behavior.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/accounts/{account_id}/integrations/requests
openapi: 3.0.4
info:
  title: Tied API
  description: >-
    The Tied REST API. Three families of endpoint, each with its own credential:
    **Application** for everything inside an account, **Platform** for
    provisioning accounts and users, and **Client** for acting as a contact from
    your own surface.
  version: 1.1.0
  termsOfService: https://tied.com/legal
  contact:
    email: hello@tied.com
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://app.tied.com
    description: Tied cloud
security: []
tags:
  - name: Account AgentBots
    description: Account-specific Agent Bots
  - name: Agents
    description: Agent management APIs
  - name: Canned Responses
    description: Pre-defined responses for common queries
  - name: Contacts
    description: Contact management APIs
  - name: Contact Labels
    description: Manage contact labels
  - name: Conversation Assignments
    description: Manage conversation assignments
  - name: Conversation Labels
    description: Manage conversation labels
  - name: Conversations
    description: Conversation management APIs
  - name: Custom Attributes
    description: Custom fields for contacts and conversations
  - name: Custom Filters
    description: Saved filters for conversations
  - name: Inboxes
    description: Communication channels setup
  - name: Integrations
    description: Third-party integrations
  - name: Messages
    description: Message management APIs
  - name: Profile
    description: User profile APIs
  - name: Reports
    description: Analytics and reporting APIs
  - name: Teams
    description: Team management APIs
  - name: Webhooks
    description: Event notification webhooks
  - name: Automation Rule
    description: Workflow automation rules
  - name: Help Center
    description: Knowledge base management
  - name: Contacts API
    description: Public contact APIs
  - name: Conversations API
    description: Public conversation APIs
  - name: Messages API
    description: Public message APIs
  - name: CSAT Survey Page
    description: Customer satisfaction survey
  - name: Account
    description: >-
      The authenticated user's own account — read and update account settings.
      Distinct from the Platform family's **Accounts**, which provisions
      accounts across an installation.
  - name: Audit Logs
    description: Read the account's audit trail
  - name: Inbox API
    description: Public inbox lookup by channel identifier
  - name: Labels
    description: >-
      Create and manage the account's labels. Applying one to a conversation or
      contact is a separate endpoint under those resources.
  - name: Macros
    description: >-
      Saved multi-step actions an agent — or an integration — can run against
      one or more conversations.
  - name: Campaigns
    description: Ongoing website campaigns and one-off SMS and WhatsApp sends.
  - name: Contact Notes
    description: Internal notes on a contact. Never visible to the contact.
  - name: Help Center Categories
    description: Categories group a portal's articles, one tree per allowed locale.
  - name: Help Center Articles
    description: The articles a portal publishes, and their draft and archived states.
  - name: Summary Reports
    description: Per-agent, per-team, per-inbox and per-label totals for a period, as JSON.
  - name: Live Reports
    description: Right-now queue counts. No date range — these describe the present.
  - name: CSAT
    description: >-
      The satisfaction ratings contacts have submitted, and the metrics computed
      from them.
  - name: Notifications
    description: >-
      The per-user notification feed, its read and snooze state, and the
      settings that decide what lands in it.
  - name: Conversation Participants
    description: >-
      The agents watching a conversation. Participants get notified about it
      without being assigned to it.
  - name: Draft Messages
    description: >-
      The unsent reply held for a conversation. Stored in Redis, one per
      conversation.
  - name: Search
    description: >-
      One search service across conversations, contacts, messages and Help
      Center articles.
  - name: Dashboard Apps
    description: Embedded pages that appear as a tab beside a conversation.
  - name: Assignment Policies
    description: How conversations are handed out, and which inbox uses which policy.
  - name: Files
    description: Storing a file so another endpoint can attach it.
  - name: Bot Flows
    description: >-
      Scripted conversation flows, their versions, and the publish and rollback
      that move between them.
  - name: Billing
    description: >-
      Credit balance, usage, invoices, spend controls and the provider-hosted
      payment flows.
  - name: AMB Templates
    description: >-
      Saved Apple Messages primitive payloads an agent can reuse from the
      composer.
  - name: AMB Onboarding
    description: The in-flight Apple Messages for Business registration for an account.
  - name: Widget Session
    description: Starting a widget session and reading the visitor it belongs to.
  - name: Widget Conversation
    description: The visitor's conversation and its messages.
  - name: Widget Context
    description: Campaigns, agents, labels, events and uploads for a widget session.
  - name: CSAT Survey
    description: The public, unauthenticated survey a contact answers from a link.
  - name: Workspace
    description: Scheduling and cancelling deletion of the whole workspace.
  - name: Widget Integrations
    description: Provider actions available to a visitor session in its own conversation.
  - name: Orchestration Studio
    description: >-
      Administrator-only read APIs for Orchestration Studio cases and knowledge
      sources.
  - name: Topic Analytics
    description: Account Topics readiness, labeling health and usage aggregates.
  - name: Analytics V2
    description: >-
      Account-scoped metrics, anonymized benchmarks and audited conversation
      drilldown.
  - name: Knowledge proposals
    description: Administrator-only proposal review and revision decisions.
  - name: Model settings
    description: Administrator-only routing profiles and Tied-hosted catalogue.
paths:
  /api/v1/accounts/{account_id}/integrations/requests:
    post:
      tags:
        - Integrations
      summary: Create integration request
      description: >-
        Any account member may submit demand. Creates IntegrationRequest on
        Current.account with Current.user; account_id/user_id in the body are
        ignored. Catalogue keys normalize known apps; otherwise app_name is
        squished and matched case-insensitively or stored as typed. Appears in
        the super-admin integration requests view. Grants no connection or
        entitlement. Validation returns message and attributes (invalid
        attribute names), not per-field messages. Connected-app credentials are
        held by the integration provider and are not returned by any of these
        operations. ENG-5874 / ENG-5831 track consistent unknown-provider and
        field-level validation behavior; this documents current behavior.
      operationId: create-integration-request
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: integer
          description: Route account; caller must be a member.
      requestBody:
        required: false
        description: >-
          Flat JSON. Nested controller-name envelopes alone are ignored by
          current permit lists; unpermitted fields are ignored.
        content:
          application/json:
            schema:
              type: object
              properties:
                catalog_key:
                  type: string
                  nullable: true
                  description: 'catalog key: flat permitted field.'
                app_name:
                  type: string
                  nullable: true
                  description: 'app name: flat permitted field.'
                  maxLength: 100
                website:
                  type: string
                  nullable: true
                  description: 'website: flat permitted field.'
                  maxLength: 255
                urgency:
                  type: string
                  nullable: true
                  description: 'urgency: flat permitted field.'
                  enum:
                    - nice_to_have
                    - this_quarter
                    - blocking
                    - null
                note:
                  type: string
                  nullable: true
                  description: 'note: flat permitted field.'
                  maxLength: 2000
      responses:
        '201':
          description: Current response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketplaceRequest'
              example:
                id: 28
                requested_app: Synthetic request
                created_at: '2026-10-22T02:04:56.004Z'
          x-current-examples:
            agent:
              capture_file: >-
                docs/platform-api/marketplace-evidence/create-integration-request-agent.json
              body:
                id: 29
                requested_app: Synthetic request
                created_at: '2026-10-22T02:04:56.770Z'
            tenant-isolation:
              capture_file: >-
                docs/platform-api/marketplace-evidence/create-integration-request-tenant-isolation.json
              body:
                id: 30
                requested_app: synthetic
                created_at: '2026-10-22T02:05:09.596Z'
          x-example-provenance:
            capture_file: >-
              docs/platform-api/marketplace-evidence/create-integration-request-default.json
            synthetic: true
            scrubbed: true
        '401':
          description: >-
            Unauthenticated, non-member or unauthorized role; auth uses
            errors[], membership/policy uses error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketplaceAuthError'
          x-current-examples:
            foreign:
              capture_file: >-
                docs/platform-api/marketplace-evidence/create-integration-request-foreign.json
              body:
                error: You are not authorized to access this account
            unauthenticated:
              capture_file: >-
                docs/platform-api/marketplace-evidence/create-integration-request-unauthenticated.json
              body:
                errors:
                  - You need to sign in or sign up before continuing.
        '402':
          description: >-
            Trial-expired account lock after authentication and membership,
            before action authorization or validation; no marketplace state
            changes or cleanup jobs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketplaceTrialLock'
          x-current-examples:
            trial-locked:
              capture_file: >-
                docs/platform-api/marketplace-evidence/create-integration-request-trial-locked.json
              body:
                error: trial_expired_locked
                message: >-
                  This workspace trial has ended. Restore billing from the
                  billing page to continue.
        '422':
          description: Model validation messages and invalid attribute names.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketplaceRequestError'
          x-current-examples:
            invalid:
              capture_file: >-
                docs/platform-api/marketplace-evidence/create-integration-request-invalid.json
              body:
                message: >-
                  Requested app can't be blank, Urgency is not included in the
                  list
                attributes:
                  - requested_app
                  - urgency
            nested:
              capture_file: >-
                docs/platform-api/marketplace-evidence/create-integration-request-nested.json
              body:
                message: Requested app can't be blank
                attributes:
                  - requested_app
      security:
        - userApiKey: []
components:
  schemas:
    MarketplaceRequest:
      type: object
      properties:
        id:
          type: integer
          description: id from the current marketplace serializer.
        requested_app:
          type: string
          description: requested app from the current marketplace serializer.
        created_at:
          type: string
          format: date-time
          description: created at from the current marketplace serializer.
      required:
        - id
        - requested_app
        - created_at
    MarketplaceAuthError:
      oneOf:
        - $ref: '#/components/schemas/MarketplaceError'
        - type: object
          properties:
            errors:
              type: array
              items:
                type: string
          required:
            - errors
    MarketplaceTrialLock:
      type: object
      properties:
        error:
          type: string
          description: Trial-expired lock refusal code.
          enum:
            - trial_expired_locked
        message:
          type: string
          description: Exact shared billing restoration guidance.
          enum:
            - >-
              This workspace trial has ended. Restore billing from the billing
              page to continue.
      required:
        - error
        - message
      additionalProperties: false
    MarketplaceRequestError:
      type: object
      required:
        - message
        - attributes
      properties:
        message:
          type: string
          description: Joined model validation messages.
        attributes:
          type: array
          items:
            type: string
          description: Names of invalid model attributes; no per-field message map.
    MarketplaceError:
      type: object
      properties:
        error:
          type: string
          description: error from the current marketplace serializer.
      required:
        - error
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        This token can be obtained by visiting the profile page or via rails
        console. Provides access to  endpoints based on the user permissions
        levels. This token can be saved by an external system when user is
        created via API, to perform activities on behalf of the user.

````

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