> ## 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 New Conversation > Creating a conversation in tied requires a source id. Learn more about source_id: https://docs.tied.com/channels/api ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/accounts/{account_id}/conversations 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. paths: /api/v1/accounts/{account_id}/conversations: parameters: - $ref: '#/components/parameters/account_id' post: tags: - Conversations summary: Create New Conversation description: |- Creating a conversation in tied requires a source id. Learn more about source_id: https://docs.tied.com/channels/api operationId: newConversation requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/conversation_create_payload' responses: '200': description: Success content: application/json: schema: type: object properties: id: type: number description: ID of the conversation account_id: type: number description: Account Id inbox_id: type: number description: ID of the inbox example: meta: sender: additional_attributes: {} availability_status: offline email: sam.whitfield4821@example.com id: 146 name: Sam Whitfield phone_number: '+14155550147' blocked: false identifier: null thumbnail: '' thumbnail_background_color: null domain_logo_avatar: false customer_verified: true custom_attributes: {} created_at: 1789957536 channel: Channel::Api hmac_verified: false id: 168 messages: [] account_id: 1 uuid: 00000000-0000-4000-8000-000000000000 additional_attributes: {} agent_last_seen_at: 0 assignee_last_seen_at: 0 can_reply: true contact_last_seen_at: 0 custom_attributes: {} inbox_id: 8 labels: [] muted: false snoozed_until: null status: open created_at: 1789957536 updated_at: 1789957536.878486 timestamp: 1789957536 first_reply_created_at: 0 unread_count: 0 last_non_activity_message: null last_activity_at: 1789957536 priority: null waiting_since: 1789957536 sla_policy_id: null '403': description: Access denied content: application/json: schema: $ref: '#/components/schemas/error_message' security: - userApiKey: [] - agentBotApiKey: [] components: parameters: account_id: in: path name: id schema: type: integer required: true description: The numeric ID of the account schemas: conversation_create_payload: type: object required: - source_id - inbox_id properties: source_id: type: string description: Conversation source id example: '1234567890' inbox_id: type: integer description: >- Id of inbox in which the conversation is created
Allowed Inbox Types: Website, Phone, Api, Email example: 1 contact_id: type: integer description: Contact Id for which conversation is created example: 1 additional_attributes: type: object description: Lets you specify attributes like browser information example: browser: Chrome browser_version: 89.0.4389.82 os: Windows os_version: '10' custom_attributes: type: object description: >- The object to save custom attributes for conversation, accepts custom attributes key and value example: attribute_key: attribute_value priority_conversation_number: 3 status: type: string enum: - open - resolved - pending description: Specify the conversation whether it's pending, open, closed example: open assignee_id: type: integer description: Agent Id for assigning a conversation to an agent example: 1 team_id: type: integer description: Team Id for assigning a conversation to a team\ example: 1 snoozed_until: type: string format: date-time description: Snoozed until date time example: '2030-07-21T17:32:28Z' message: type: object description: The initial message to be sent to the conversation required: - content properties: content: type: string description: The content of the message example: Hello, how can I help you? template_params: type: object description: The template params for the message in case of whatsapp Channel properties: name: type: string description: Name of the template example: sample_issue_resolution category: type: string description: Category of the template example: UTILITY language: type: string description: Language of the template example: en_US processed_params: type: object description: >- The processed param values for template variables in template example: '1': Tied error_message: type: object description: >- The shape returned by `render_unauthorized`, `render_not_found_error` and `render_could_not_create_error`. properties: error: type: string description: A single human-readable message. example: Resource could not be found 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. agentBotApiKey: type: apiKey in: header name: api_access_token description: >- This token should be provided by system admin or obtained via rails console. This token can be used to build bot integrations and can only access limited apis. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.