Pipedrive API

Getting access, Developing, Testing

Back to Pipedrive

Add a channel

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.

Input

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

Output

type: object properties: success: type: boolean example: true data: type: object properties: id: type: string description: >- The unique channel ID used internally in omnichannel-api and the frontend of the extension name: type: string example: My Channel description: The name of the channel avatar_url: type: string example: http://some-domain.com/test.jpg description: The URL for an icon that represents your channel provider_channel_id: type: string format: string description: The channel ID you specified while creating the channel marketplace_client_id: type: string description: The client_id of your app in Pipedrive marketplace pd_company_id: type: integer example: 1 description: The ID of the user's company in Pipedrive pd_user_id: type: integer example: 1 description: The ID of the user in Pipedrive created_at: type: string format: date-time description: The date and time when your channel was created in the API provider_type: type: string enum: - facebook - whatsapp - other description: Value of the provider_type sent to this endpoint template_support: type: boolean description: Value of the template_support sent to this endpoint