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

# Intercom Create Conversation: Inputs, Cost & CLI Example

> Creates a conversation. Intercom Intercom Create Conversation docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=intercom_create_conversation:{"from":{},"body":"{{body}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                      | Type      | Required | Default | Description                                                                                                                                                                                                       |
| ------------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.from`            | `object`  | Yes      |         |                                                                                                                                                                                                                   |
| `payload.body`            | `string`  | Yes      |         | The content of the message. HTML is not supported.                                                                                                                                                                |
| `payload.subject`         | `string`  | No       |         | The title of the email. Only applicable if the message type is email.                                                                                                                                             |
| `payload.attachment_urls` | `array`   | No       |         | A list of image URLs that will be added as attachments. You can include up to 10 URLs.                                                                                                                            |
| `payload.created_at`      | `integer` | No       |         | The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.",
    "properties": {
      "from": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The role associated to the contact - user or lead.",
            "enum": [
              "lead",
              "user",
              "contact"
            ]
          },
          "id": {
            "type": "string",
            "description": "The identifier for the contact which is given by Intercom.",
            "minLength": 24,
            "maxLength": 24,
            "format": "uuid"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "additionalProperties": false
      },
      "body": {
        "type": "string",
        "description": "The content of the message. HTML is not supported."
      },
      "subject": {
        "type": "string",
        "description": "The title of the email. Only applicable if the message type is email."
      },
      "attachment_urls": {
        "type": "array",
        "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.",
        "maxItems": 10,
        "items": {
          "type": "string",
          "format": "uri"
        }
      },
      "created_at": {
        "type": "integer",
        "description": "The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom.",
        "format": "date-time"
      }
    },
    "required": [
      "from",
      "body"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                                                                                                   |
| ------------- | -------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes      |         | Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact. |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging).                                                                                |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the message"
          },
          "id": {
            "type": "string",
            "description": "The id representing the message."
          },
          "created_at": {
            "type": "integer",
            "description": "The time the conversation was created.",
            "format": "date-time"
          },
          "subject": {
            "type": "string",
            "description": "The subject of the message. Only present if message_type: email."
          },
          "body": {
            "type": "string",
            "description": "The message body, which may contain HTML."
          },
          "message_type": {
            "type": "string",
            "description": "The type of message that was sent. Can be email, inapp, facebook or twitter.",
            "enum": [
              "email",
              "inapp",
              "facebook",
              "twitter"
            ]
          },
          "conversation_id": {
            "type": "string",
            "description": "The associated conversation_id"
          }
        },
        "required": [
          "type",
          "id",
          "created_at",
          "body",
          "message_type"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute intercom_create_conversation --payload '{
  "from": {},
  "body": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.