> ## 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 a Dyte meeting

> Creates a Dyte meeting for the selected conversation and adds a Dyte integration message to it. The account must have its Dyte integration connected for the operation to succeed. This creates a meeting at a third party.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/accounts/{account_id}/integrations/dyte/create_a_meeting
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.
paths:
  /api/v1/accounts/{account_id}/integrations/dyte/create_a_meeting:
    post:
      tags:
        - Integrations
      summary: Create a Dyte meeting
      description: >-
        Creates a Dyte meeting for the selected conversation and adds a Dyte
        integration message to it. The account must have its Dyte integration
        connected for the operation to succeed. This creates a meeting at a
        third party.
      operationId: create-dyte-meeting
      parameters:
        - name: account_id
          in: path
          required: true
          description: The account containing the conversation.
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dyte_create_meeting_payload'
            example:
              conversation_id: 43
      responses:
        '200':
          description: Meeting created; the response is the new integration message.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dyte_meeting_message_response'
              example:
                id: 1
                content: Synthetic Dyte meeting message
                account_id: 1
                inbox_id: 1
                conversation_id: 1
                message_type: 1
                created_at: 1
                updated_at: '2026-01-01T00:00:00Z'
                private: false
                status: sent
                source_id: null
                content_type: integrations
                content_attributes:
                  type: dyte
                  data:
                    meeting_id: synthetic-id
                sender_type: synthetic-value
                sender_id: 1
                external_source_ids: {}
                additional_attributes: {}
                processed_message_content: synthetic-value
                sentiment: {}
                source_identity_uniqueness_exempt_at: null
                actor: null
                conversation:
                  assignee_id: null
                  unread_count: 0
                  last_activity_at: 1
                  contact_inbox:
                    source_id: EXAMPLE_SOURCE_ID
                sender:
                  id: 1
                  name: synthetic-value
                  available_name: synthetic-value
                  avatar_url: synthetic-value
                  type: user
                  availability_status: synthetic-value
                  thumbnail: synthetic-value
                  illustration_avatar: true
                  accent_color: null
        '400':
          description: The request supplies more than one credential type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dyte_error_response'
              example:
                error:
                  code: multiple_credentials
        '401':
          description: The caller is not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dyte_error_response'
              examples:
                unauthenticated:
                  summary: The request has no valid account credentials.
                  value:
                    errors:
                      - You need to sign in or sign up before continuing.
                conversationAccessDenied:
                  summary: The account user cannot view the conversation.
                  value:
                    error: You are not authorized to do this action
        '402':
          description: Account writes are locked after the trial has expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dyte_error_response'
        '404':
          description: >-
            The selected conversation or Dyte integration cannot be found in
            this account. A disconnected Dyte integration returns this 404 JSON
            body without a provider request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dyte_error_response'
              example:
                error: Resource could not be found
        '422':
          description: The provider rejected the meeting request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dyte_error_response'
              examples:
                providerRejected:
                  summary: Provider rejected the operation.
                  value:
                    error:
                      success: false
                      data:
                        message: Title is required
                    error_code: 422
      security:
        - userApiKey: []
components:
  schemas:
    dyte_create_meeting_payload:
      type: object
      required:
        - conversation_id
      description: Request to start a meeting for an account conversation.
      properties:
        conversation_id:
          type: integer
          description: The conversation display ID.
      example:
        conversation_id: 43
    dyte_meeting_message_response:
      type: object
      description: >-
        The message push-event payload emitted after meeting creation. The
        example is captured from a stubbed-provider request and uses synthetic
        identifiers.
      required:
        - id
        - conversation_id
        - content_type
        - content_attributes
      properties:
        id:
          type: integer
          description: The new message ID.
        content:
          type: string
          description: The generated meeting message text.
        account_id:
          type: integer
          description: The account that owns the conversation.
        inbox_id:
          type: integer
          description: The inbox that owns the conversation.
        conversation_id:
          type: integer
          description: The conversation display ID.
        message_type:
          type: integer
          description: Message type enum value.
        created_at:
          type: integer
          description: Creation time as Unix seconds.
        updated_at:
          type: string
          format: date-time
          description: Last message update time.
        private:
          type: boolean
          description: Whether the message is private to account users.
        status:
          type: string
          description: Message delivery status.
        source_id:
          type: string
          nullable: true
          description: External source identifier, when present.
        content_type:
          type: string
          enum:
            - integrations
          description: The integration message content type.
        content_attributes:
          type: object
          description: Integration card data containing the provider meeting ID.
          properties:
            type:
              type: string
              enum:
                - dyte
              description: Sender type.
            data:
              type: object
              properties:
                meeting_id:
                  type: string
                  description: >-
                    Synthetic in examples; provider meeting identifier returned
                    by Dyte.
              description: Provider meeting metadata.
        sender_type:
          type: string
          nullable: true
          description: Type of the message sender, when present.
        sender_id:
          type: integer
          nullable: true
          description: ID of the message sender, when present.
        external_source_ids:
          type: object
          additionalProperties: true
          description: Provider-specific source identifiers for the message.
        additional_attributes:
          type: object
          additionalProperties: true
          description: Additional message metadata.
        processed_message_content:
          type: string
          nullable: true
          description: Processed message text; treat returned text as untrusted content.
        sentiment:
          type: object
          additionalProperties: true
          description: Stored message sentiment metadata.
        source_identity_uniqueness_exempt_at:
          type: string
          nullable: true
          description: Optional source identity exemption timestamp.
        actor:
          type: object
          nullable: true
          additionalProperties: true
          description: Message actor metadata, when present.
        conversation:
          type: object
          properties:
            assignee_id:
              type: integer
              nullable: true
              description: ID of the assigned user, when present.
            unread_count:
              type: integer
              description: Unread message count for the conversation.
            last_activity_at:
              type: integer
              description: Last conversation activity time as Unix seconds.
            contact_inbox:
              type: object
              properties:
                source_id:
                  type: string
                  description: Synthetic contact-inbox source identifier.
              description: Contact inbox metadata for this conversation.
          description: Metadata for the account-owned conversation.
        sender:
          type: object
          properties:
            id:
              type: integer
              description: Sender identifier.
            name:
              type: string
              description: Sender display name.
            available_name:
              type: string
              description: Name available for display.
            avatar_url:
              type: string
              description: Sender avatar URL.
            type:
              type: string
              description: Sender type.
            availability_status:
              type: string
              description: Sender availability status.
            thumbnail:
              type: string
              description: Sender thumbnail URL.
            illustration_avatar:
              type: boolean
              description: Whether an illustration is used for the avatar.
            accent_color:
              type: string
              nullable: true
              description: Sender accent color, when present.
          description: Metadata for the message sender.
      additionalProperties: true
      example:
        id: 1
        content: Synthetic Dyte meeting message
        account_id: 1
        inbox_id: 1
        conversation_id: 1
        message_type: 1
        created_at: 1
        updated_at: '2026-01-01T00:00:00Z'
        private: false
        status: sent
        source_id: null
        content_type: integrations
        content_attributes:
          type: dyte
          data:
            meeting_id: synthetic-id
        sender_type: synthetic-value
        sender_id: 1
        external_source_ids: {}
        additional_attributes: {}
        processed_message_content: synthetic-value
        sentiment: {}
        source_identity_uniqueness_exempt_at: null
        actor: null
        conversation:
          assignee_id: null
          unread_count: 0
          last_activity_at: 1
          contact_inbox:
            source_id: EXAMPLE_SOURCE_ID
        sender:
          id: 1
          name: synthetic-value
          available_name: synthetic-value
          avatar_url: synthetic-value
          type: user
          availability_status: synthetic-value
          thumbnail: synthetic-value
          illustration_avatar: true
          accent_color: null
    dyte_error_response:
      type: object
      description: A request or provider error. Provider error details vary.
      properties:
        error:
          oneOf:
            - type: string
              description: A local validation or not-found message.
            - type: object
              description: Provider error envelope.
              additionalProperties: true
          description: Error details.
        error_code:
          type: integer
          description: >-
            HTTP status returned by the provider, when the failure came from
            Dyte.
        errors:
          type: array
          items:
            type: string
          description: >-
            Authentication failures without a signed-in user may use an errors
            list.
  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.