PIpipedrive
Channels

Add a channel

Changed on

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.

post/channels

Request

  • Base URL
    https://api.pipedrive.com/v1
  • Auth
    • API key in header x-api-token
    • or OAuth 2
      Authorization code: https://oauth.pipedrive.com/oauth/authorize
      Token URL: https://oauth.pipedrive.com/oauth/token scopes: messengers-integration

Request body

namestring required

The name of the channel

provider_channel_idstring required

The channel ID

avatar_urlstring url

The URL for an icon that represents your channel

template_supportboolean

If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more here.

provider_type'facebook' | 'whatsapp' | 'other'

It controls the icons (like the icon next to the conversation)

Example request

{
  "name": "My Channel"
}

Response

The channel registered

successboolean

Example response

{
  "success": true,
  "data": {
    "name": "My Channel",
    "avatar_url": "http://some-domain.com/test.jpg",
    "pd_company_id": 1,
    "pd_user_id": 1
  }
}

Changes

  • cc7952f2605bRevision changes
    • info

      endpoint deprecated

  • 5f19f075613eRevision changes
    • breaking

      the response's property type changed from array to object for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status