Skip to main content
PUT
Add bot to conversation

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

bot_id
string
required

Query Parameters

conversation_id
integer
required

Channel conversation ID

Response

The bot, with the channel in its conversations.

A messaging bot.

archived_at
string<date-time> | null
required

When the bot was archived, or null while it is active.

avatar_background_color
string | null
required

Background color shown behind the bot's avatar.

avatar_emoji
string | null
required

Emoji shown as the bot's avatar.

conversation
object | null
required

Your one-to-one conversation with the bot, or null when you have none.

conversations
object[]
required

Conversations the bot's recipient belongs to, such as the channels a broadcast bot posts into.

description
string | null
required

What the bot does.

id
integer
required

The bot ID.

image_url
string | null
required

URL of the bot's avatar image.

recipient
object | null
required

The messaging recipient that represents the bot in conversations.

title
string
required

The bot's display name. Unique among your company's active bots.

type
string
required

ResponseBot (replies through a webhook in one-to-one conversations) or BroadcastBot (posts into channel conversations).

webhook_external_uri
string | null
required

For a response bot, the URL its webhook delivers messages to; otherwise null.

webhook_http_method
string | null
required

For a response bot, the HTTP method its webhook uses (post, put, or get); otherwise null.