{ "opencollection": "1.0.0", "info": { "name": "Pipedrive API v1 Activities Channels API", "version": "1.0.0" }, "items": [ { "info": { "name": "Channels", "type": "folder" }, "items": [ { "info": { "name": "Add a channel", "type": "http" }, "http": { "method": "POST", "url": "https://api.pipedrive.com/v1/channels", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "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)." }, { "info": { "name": "Delete a channel", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pipedrive.com/v1/channels/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the channel provided by the integration" } ], "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Deletes an existing messenger’s channel and all related entities (conversations and messages). 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)." }, { "info": { "name": "Receives an incoming message", "type": "http" }, "http": { "method": "POST", "url": "https://api.pipedrive.com/v1/channels/messages/receive", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Adds a message to a conversation. 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)." }, { "info": { "name": "Delete a conversation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pipedrive.com/v1/channels/:channel-id/conversations/:conversation-id", "params": [ { "name": "channel-id", "value": "", "type": "path", "description": "The ID of the channel provided by the integration" }, { "name": "conversation-id", "value": "", "type": "path", "description": "The ID of the conversation provided by the integration" } ], "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Deletes an existing conversation. 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)." } ] } ], "bundled": true }