---
title: "Add a channel"
method: POST
path: "/channels"
tags: ["Channels"]
deprecated: true
---

# Add a channel

`POST /channels`

> **Deprecated.**

Adds a new messaging channel, only admins are able to register new channels. It will use the getConversations endpoint to fetch conversations, participants and messages afterward. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

## Request body

- object
  - `name` string, required — The name of the channel
  - `provider_channel_id` string, required — The channel ID
  - `avatar_url` string, url — The URL for an icon that represents your channel
  - `template_support` boolean — If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension).
  - `provider_type` 'facebook' | 'whatsapp' | 'other' — It controls the icons (like the icon next to the conversation)

## Response `200`

The channel registered

- object
  - `success` boolean
  - `data` object
    - `id` string — The unique channel ID used internally in omnichannel-api and the frontend of the extension
    - `name` string — The name of the channel
    - `avatar_url` string — The URL for an icon that represents your channel
    - `provider_channel_id` string, string — The channel ID you specified while creating the channel
    - `marketplace_client_id` string — The client_id of your app in Pipedrive marketplace
    - `pd_company_id` integer — The ID of the user's company in Pipedrive
    - `pd_user_id` integer — The ID of the user in Pipedrive
    - `created_at` string, date-time — The date and time when your channel was created in the API
    - `provider_type` 'facebook' | 'whatsapp' | 'other' — Value of the provider_type sent to this endpoint
    - `template_support` boolean — Value of the template_support sent to this endpoint

## Other responses

- `400` — Bad Request
- `403` — Forbidden

---

[API](https://skmtc.net/pipedrive/apis/pipedrive-api-v1.md) · [All operations](https://skmtc.net/pipedrive/apis/pipedrive-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pipedrive/pipedrive-api-v1/revisions/bf863a979545/schema)