---
title: How to set up an API channel?
description: How to set up an API channel?
---

[Skip to content](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#main-content)

English

Show submenu for translations

![logo2.png\]](https://help.brandwizard.io/hs-fs/hubfs/logo2.png?height=40&name=logo2.png)

Open main navigation

Close main navigation

- English
  
  Show submenu for translations
- [Go to brandwizard.io](https://brandwizard.io/)

[Go to brandwizard.io](https://brandwizard.io/)

 Hello. How can we help you?

- There are no suggestions because the search field is empty.

1. [Help Center](https://help.brandwizard.io/knowledge?hsLang=en)
2. [Multichat](https://help.brandwizard.io/knowledge/multichat?hsLang=en)
3. [Adding inboxes](https://help.brandwizard.io/knowledge/multichat?hsLang=en#adding-inboxes)

# How to set up an API channel?

In this article, you will learn the following information:

- [**How to set up an API channel?**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#How_to_set_up_an_API_channel)
- [**How to send a message through the API channel?**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#How_to_send_a_message_through_the_API_channel) 
    - [**Creating a contact**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#Creating_a_contact)
    - [**Creating a conversation**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#Creating_a_conversation)
    - [**Creating a message**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#Creating_a_message)
- [**Additional channel settings**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#Additional_channel_settings) 
    - [**"Settings" section**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#Settings_section)
    - [**"Collaborators" section**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#Collaborators_section)
    - [**"Business hours" section**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#Business_hours_section)
    - [**"CSAT" section**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#CSAT_section)
    - [**"Configuration" section**](https://help.brandwizard.io/knowledge/how-to-set-up-an-api-channel#Configuration_section)

---

 

### **How to set up an API channel?**

 

To create and configure an inbound API channel, go to **Settings → Inboxes → Add Inbox**.

 

![](https://help.brandwizard.io/hs-fs/hubfs/%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5-png-Mar-24-2026-09-53-05-4728-AM.png?width=670&height=261&name=%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5-png-Mar-24-2026-09-53-05-4728-AM.png)

 

Select API.

 

![](https://help.brandwizard.io/hs-fs/hubfs/%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5-png-Mar-24-2026-09-53-26-5646-AM.png?width=670&height=538&name=%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5-png-Mar-24-2026-09-53-26-5646-AM.png)

 

Specify the channel name and the webhook URL where you wish to receive callback events. Click **Create API Channel.**

 

**![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/25585485385f6daa9c3a19d3c7666bf803fe22a9)**

 

Add agents to your API channel.

 

![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/0ff0e512b97d66944b7d2bf0f6854eaae8e90f35)

 

You have successfully created an API inbox.

 

---

 

### **How to send a message through the API channel?**

 

To send a message through the API, create a contact, initiate a conversation, and then send the message.

API requests require an `api_access_token` in the request header. To obtain this token, contact the BrandWizard manager.

 

---

 

#### **Creating a contact**

 

To create a contact, send the API source ID along with other specified parameters. This will automatically generate a request. The response will look like this:

 

```
{  "email": "string",  "name": "string",  "phone_number": "string",  "thumbnail": "string",  "additional_attributes": {},  "contact_inboxes": [    {      "source_id": "string",      "inbox": {        "id": 0,        "name": "string",        "website_url": "string",        "channel_type": "string",        "avatar_url": "string",        "widget_color": "string",        "website_token": "string",        "enable_auto_assignment": true,        "web_widget_script": "string",        "welcome_title": "string",        "welcome_tagline": "string",        "greeting_enabled": true,        "greeting_message": "string"      }    }  ],  "id": 0,  "availability_status": "string"}
```

 

As shown, in the response you will see `contact_inboxes`, and each will have its own `source_id`. The `source_id` can be considered as the request identifier. You will use this `source_id` to create a new conversation, as described below.

 

---

 

#### **Creating a conversation**

 

Use the `source_id` obtained in the previous step. You will receive a `conversation_id`, which can be used to create a message.

 

```
{  "id": 0}
```

 

---

 

#### **Creating a message**

 

There are two types of messages:

- **Incoming**: a message from the user.
- **Outgoing**: a message from the agent.

An example response upon successful sending:

 

```
{    "id": 0,    "content": "This is an incoming message via API channel",    "inbox_id": 0,    "conversation_id": 0,    "message_type": 0,    "content_type": null,    "content_attributes": {},    "created_at": 0,    "private": false,    "sender": {        "id": 0,        "name": "Pranav",        "type": "contact"    }}
```

 

If everything is successful, you will see the conversation in the conversation management panel, and you will also be notified about new messages via the URL provided when creating the API channel.

 

---

 

### **Additional channel settings**

 

The created API channel should appear in the list under **Inboxes**. To view or change additional settings, go to **Settings → Inboxes**, then click the gear icon on the API channel.

 

![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/d6d37fd54401f4b2e72986406c152971560cd6b7)

 

You will see the following page:

 

![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/1b0ab8cd54ba74ffd4db235267e427f61fd50d59)

 

---

 

#### **"Settings" section**

 

- **Channel Avatar**. Add an image of the inbox. Image requirements: 
    - Size: 15 MB.
    - Format: JPEG/PNG.
- **Inbox Name**. Change the inbox name if needed.
- **Webhook URL**. If necessary, change the webhook URL.
- **Enable channel greeting**. After activation, BrandWi will send a welcome message for new conversations created via your API channel.
- **Channel greeting message**. This field appears if you enable the channel greeting. Write a response that the client will see after sending their first message, e.g., "BrandWizard usually responds within a few minutes."
- **Lock to single conversation:** 
    - If you select **Disabled** – after closing the dialogue, new messages from clients will be received as separate new dialogues.
    - If you select **Enabled** – after closing the dialogue, new messages will return to the existing dialogue, automatically reopening it.

After making changes, click **Update**.

 

![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/1b0ab8cd54ba74ffd4db235267e427f61fd50d59)

 

---

 

#### **"Collaborators" section**

 

Click on the **Collaborators** tab. Here you can add or remove agents from the channel. You can also enable or disable automatic assignment of new conversations to agents added to this inbox. If needed, limit the maximum number of conversations from the inbox that can be automatically assigned to an agent. Click **Update** to save changes.

 

![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/a6508835beb69ac572cabb4d36210ff4abb5bb47)

 

---

 

#### **"Business hours" section**

 

Go to the **Business hours** tab. In this section, you can set your team's working hours related to the API channel. To activate the working hours mode, check the **Enable business availability for this inbox**.

- Once checked, you'll be able to write a message for clients to see during non-working hours.
- You can also set working hours for each day of the week, considering the selected time zone.

After adjusting the settings, click the **Update business hours settings** button.

 

![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/62b05bb5e2b6deaf8428ff13a4bbb6ceed990ce2)

 

---

 

#### **"CSAT" section**

 

Enable CSAT. After that, your customer satisfaction survey will be automatically sent at the end of the conversation. CSAT results can be viewed later in the **Reports** section.

 

![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/c43303ea3fe319cf5f534656d8a12a51a75b8c9f)

 

---

 

#### **"Configuration" section**

 

Here, you can find the inbox identifier and the user authentication key. You can also enable mandatory user identity verification.

 

![](https://roketdata.helpdeskeddy.com/ru/file/kb_inline_image/0fbee1995312ed19387105a5dae1530f9fc4a2da)

- [General questions about the service](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#main-content)

    - [FAQ](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#faq)
    - [Creating and editing a company](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#creating-and-editing-a-company)
    - [Working with sources](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#working-with-sources)
    - [Work with reviews](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#work-with-reviews)
    - [Working with a Photo tool](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#working-with-a-photo-tool)
    - [Google](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#google)
    - [2GIS (URBI)](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#2gis-urbi)
    - [Facebook](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#facebook)
    - [Yandex](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#yandex)
    - [API](https://help.brandwizard.io/knowledge/general-questions-about-the-service?hsLang=en#api)
- [Where to start?](https://help.brandwizard.io/knowledge/where-to-start?hsLang=en)
- [Dashboard](https://help.brandwizard.io/knowledge/dashboard?hsLang=en)
- [My companies](https://help.brandwizard.io/knowledge/my-companies?hsLang=en)
- [Create/Edit company in Personal account](https://help.brandwizard.io/knowledge/create-edit-company-in-personal-account?hsLang=en)
- [Sources](https://help.brandwizard.io/knowledge/sources?hsLang=en)
- [Review Center](https://help.brandwizard.io/knowledge/review-center?hsLang=en)
- [Tags](https://help.brandwizard.io/knowledge/tags?hsLang=en)
- [Auto-replies](https://help.brandwizard.io/knowledge/auto-replies?hsLang=en)
- [Statistics](https://help.brandwizard.io/knowledge/statistics?hsLang=en)
- [Reputation Analytics](https://help.brandwizard.io/knowledge/reputation-analytics?hsLang=en)
- [Competitors](https://help.brandwizard.io/knowledge/competitors?hsLang=en)
- [Reviews generator](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#main-content)

    - [QR Codes](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#qr-codes)
    - [Analytics](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#analytics)
    - [Promo codes](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#promo-codes)
    - [Questionnaires](https://help.brandwizard.io/knowledge/reviews-generator?hsLang=en#questionnaires)
- [Questions & Answers](https://help.brandwizard.io/knowledge/questions-answers?hsLang=en)
- [Photo & Video](https://help.brandwizard.io/knowledge/photo-video?hsLang=en)
- [Presence analytics](https://help.brandwizard.io/knowledge/presence-analytics?hsLang=en)
- [Reviews widget](https://help.brandwizard.io/knowledge/reviews-widget?hsLang=en)
- [Store locator](https://help.brandwizard.io/knowledge/store-locator?hsLang=en)
- [Multichat](https://help.brandwizard.io/knowledge/multichat?hsLang=en#main-content)

    - [Where to start?](https://help.brandwizard.io/knowledge/multichat?hsLang=en#where-to-start)
    - [Adding inboxes](https://help.brandwizard.io/knowledge/multichat?hsLang=en#adding-inboxes)
    - [Conversations](https://help.brandwizard.io/knowledge/multichat?hsLang=en#conversations)
    - [Contacts](https://help.brandwizard.io/knowledge/multichat?hsLang=en#contacts)
    - [Settings](https://help.brandwizard.io/knowledge/multichat?hsLang=en#settings)
    - [Reports](https://help.brandwizard.io/knowledge/multichat?hsLang=en#reports)
    - [Additional features](https://help.brandwizard.io/knowledge/multichat?hsLang=en#additional-features)
- [Posts](https://help.brandwizard.io/knowledge/posts?hsLang=en)
- [Duplicates & Fakes](https://help.brandwizard.io/knowledge/duplicates-fakes?hsLang=en)
- [Products & Prices](https://help.brandwizard.io/knowledge/products-prices?hsLang=en)
- [Plans & Limits](https://help.brandwizard.io/knowledge/plans-limits?hsLang=en)
- [Profile](https://help.brandwizard.io/knowledge/profile?hsLang=en)
- [Users](https://help.brandwizard.io/knowledge/users?hsLang=en)
- [Account settings](https://help.brandwizard.io/knowledge/account-settings?hsLang=en)
- [Groups of companies section](https://help.brandwizard.io/knowledge/groups-of-companies-section?hsLang=en)
- [Notifications settings](https://help.brandwizard.io/knowledge/notifications-settings?hsLang=en)

# BrandWizard

brandwizard.io Help Center

Copyright © 2026, BrandWizard