# Markdown

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

You can use Markdown syntax to add style, linking, and user interaction to Chatbot messages in the Zoom Client.

With the Markdown syntax, you can also use the `@` symbol to notify or mention a person or group of people in a Zoom Chat channel.

## Using Markdown in messages

To enable Markdown, set `"is_markdown_support": true` in the [Chatbot message request body](/docs/chat/send-edit-and-delete-messages#send-messages).

You can apply Markdown to the [header](/docs/chat/customizing-messages/message-with-header), [subheader](/docs/chat/customizing-messages/message-with-sub-header), [text](/docs/chat/customizing-messages/message-with-text) (without using the `"link"` property), and [form field](/docs/chat/customizing-messages/message-with-form-field) (when `"editable"` is set to `false`) message types.

The [footer](/docs/chat/customizing-messages/message-with-footer) message type also supports the "[link](#link)" Markdown style.

**NOTE:** When using Markdown, setting the message `"style"` (`"color"`, `"bold"`, `"italic"`) is unsupported.

For the header, sub header, and text, add the Markdown as a string for the value of the `"text"` key.

```json
{
    "robot_jid": "{{bot_jid}}",
    "to_jid": "{{to_jid}}",
    "account_id": "{{account_id}}",
    "is_markdown_support": true,
    "content": {
        "head": {
            "text": "_this header is italic_",
            "sub_head": {
                "text": "~this sub header has a strikethrough~"
            }
        },
        "body": [
            {
                "type": "message",
                "text": "*this text is bold*"
            }
        ]
    }
}
```

For the form field, add the Markdown as a string for the value of the `"value"` key.

```json
{
    "robot_jid": "{{bot_jid}}",
    "to_jid": "{{to_jid}}",
    "account_id": "{{account_id}}",
    "is_markdown_support": true,
    "content": {
        "body": [
            {
                "type": "fields",
                "items": [
                    {
                        "key": "Code",
                        "value": "``console.log('this form field value is monospace')`",
                        "editable": false
                    }
                ]
            }
        ]
    }
}
```

For the footer, add the Markdown as a string for the value of the `"footer"` key.

```json
{
    "robot_jid": "{{bot_jid}}",
    "to_jid": "{{to_jid}}",
    "account_id": "{{account_id}}",
    "is_markdown_support": true,
    "content": {
        "body": [
            {
                "type": "section",
                "sections": [],
                "footer": "<https://zoom.us>"
            }
        ]
    }
}
```

## Supported Markdown reference

Here is the supported Markdown functionality reference. Choose each respective style to see how it looks in Zoom Chat.

<table>
  <thead>
    <tr class="header">
      <th>Style</th>
      <th>Syntax</th>
      <th>Works With</th>
    </tr>
  </thead>
  <tbody>
    <tr class="odd">
      <td>
        [Bold](#bold")
      </td>
      <td>
        `**this text is bold**`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
      </td>
    </tr>
    <tr class="even">
      <td>
        [Italic](#italic")
      </td>
      <td>
        `_this text is italic_`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
      </td>
    </tr>
    <tr class="odd">
      <td>
        [Strikethrough](#strikethrough")
      </td>
      <td>
        `~this text has a strikethrough~`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
      </td>
    </tr>
    <tr class="even">
      <td>
        [Monospace](#monospace")
      </td>
      <td>
        `this text is monospace`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
      </td>
    </tr>
    <tr class="odd">
      <td>
        [Block quote](#block-quote")
      </td>
      <td>
        `> this text is a block quote`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
      </td>
    </tr>
    <tr class="even">
      <td>
        [Link](#link")
      </td>
      <td>
        `<https://zoom.us>`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
        - [Footer](/docs/chat/customizing-messages/message-with-footer)
      </td>
    </tr>
    <tr class="odd">
      <td>
        [Chat link](#chat-link")
      </td>
      <td>
          `<#{channel_jid or user_jid}|Name Here>`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
      </td>
    </tr>
    <tr class="odd">
      <td>
        [Profile card](#profile-link")
      </td>
      <td>
          `<profile:{user_jid}|Name Here>`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
      </td>
    </tr>
    <tr class="even">
      <td>
        [Mention all (@all)](#mention-all-all")
      </td>
      <td>
          `<!all>`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
      </td>
    </tr>
    <tr class="odd">
      <td>
        [Mention individual (@name)](#mention-individual-name")
      </td>
      <td>
          `<!user_jid|Name Here>`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
      </td>
    </tr>
    <tr class="even">
      <td>
        [Image](#image")
      </td>
      <td>
        `<img:https://domain.ext/image.png|alt text>`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
      </td>
    </tr>
    <tr class="odd">
      <td>
        [Inline image](#inline-image")
      </td>
      <td>
          `This text has an inline image <img:https://domain.ext/image.png|alt
                    text>`
      </td>
      <td>
        - [Header](/docs/chat/customizing-messages/message-with-header)
        - [Sub Header](/docs/chat/customizing-messages/message-with-sub-header)
        - [Text](/docs/chat/customizing-messages/message-with-text)
        - [Form Field](/docs/chat/customizing-messages/message-with-form-field)
        - [Footer](/docs/chat/customizing-messages/message-with-footer)
      </td>
    </tr>
  </tbody>
</table>

To escape Markdown syntax, put a `\` in front of the character. For example, to display `*` in a message, add a slash in front of it `\*`.

### Example request body

```json
{
    "robot_jid": "{{bot_jid}}",
    "to_jid": "{{to_jid}}",
    "account_id": "{{account_id}}",
    "is_markdown_support": true,
    "content": {
        "head": {
            "text": "_this header is italic_",
            "sub_head": {
                "text": "~this sub header has a strikethrough~"
            }
        },
        "body": [
            {
                "type": "section",
                "sections": [
                    {
                        "type": "message",
                        "text": "*this text is bold*"
                    },
                    {
                        "type": "fields",
                        "items": [
                            {
                                "key": "Code",
                                "value": "`console.log('this form field value is monospace')`",
                                "editable": false
                            }
                        ]
                    }
                ],
                "footer": "<https://zoom.us>"
            }
        ]
    }
}
```

## Render in Zoom Chat

### Bold

Makes the text bold.

Syntax:

```markdown
_this text is bold_
```

Example:

![](/img/1566940355574.png)

---

### Italic

Makes the text italic.

Syntax:

```markdown
_this text is italic_
```

Example:

![](/img/1566940428623.png)

---

### Strikethrough

Gives the text a strikethrough.

Syntax:

```markdown
~this text has a strikethrough~
```

Example:

![](/img/1566940727935.png)

---

### Monospace

Makes the text monospace, good for code snippits.

Syntax:

```markdown
` `this text is monospace` `
```

Example:

![](/img/1566940809570.png)

---

### Block quote

Indents and gives the text italics.

Syntax:

```markdown
> this text is a block quote
```

Example:

![](/img/1566940849078.png)

---

### Link

Displays a clickable url.

Syntax:

```markdown
<https://zoom.us>
```

Example:

![](/img/1566940883586.png)

---

### Chat link

Adds a Zoom Chat message link to text. Displays a
channel when hovered. Navigates to a chat channel when
clicked.

Syntax:

```markdown
<#{channel_jid or user_jid}|Name Here>
```

Example:

![](/img/Link-to-team-chat-message.png)

---

### Profile card

Adds a profile card to text. Displays the users profile when hovered. Navigates to a chat with the user when
clicked.

Syntax:

```markdown
<profile:{user_jid}|Name Here>
```

Example:

![](/img/1566942165694.png)

---

### Mention all (@all)

Notifies everyone in a channel.

Syntax:

```markdown
<!all>
```

Example:

![](/img/1566941087567.png)

---

### Mention individual (@name)

Notifies an individual user in a channel.

Syntax:

```markdown
<!user_jid|Name Here>
```

Example:

![](/img/1566941124905.png)

---

### Image

Sends an image. Alternative text can be added for accessibility and
screen readers by adding a `|` and text after the image url.

Syntax:

```markdown
<img:https://marketplace.zoom.us/competition/images/zoom.png|zoom logo>
```

Example:

![](/img/1575498795338.png)

---

### Inline image

Sends an inline image. Alternative text can be added for accessibility
and screen readers by adding a `|` and text after the image url.

Syntax:

```markdown
This text has an inline image <img:https://marketplace.zoom.us/competition/images/zoom.png|zoom logo>
```

Example:

![](/img/1575498871394.png)