POST /channels
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.
Servers
- https://api.pipedrive.com/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
template_support |
Boolean | No |
If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more here. Default value: false |
name |
String | Yes |
The name of the channel |
avatar_url |
String | No |
The URL for an icon that represents your channel |
provider_type |
String | No |
It controls the icons (like the icon next to the conversation) Possible values:
Default value: "other" |
provider_channel_id |
String | Yes |
The channel ID |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.