POST /channels/messages/receive
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.
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 |
|---|---|---|---|
id |
String | Yes |
The ID of the message |
sender_id |
String | Yes |
The ID of the provider's user that sent the message |
reply_by |
String | No |
The date and time when the message can no longer receive a reply, in UTC. Format: YYYY-MM-DD HH:MM |
channel_id |
String | Yes |
The channel ID as in the provider |
attachments[] |
Array | No |
The list of attachments available in the message |
attachments[].id |
String | Yes |
The ID of the attachment |
attachments[].name |
String | No |
The name of the attachment |
attachments[].size |
Number | No |
The size of the attachment |
attachments[].preview_url |
String | No |
A URL to a preview picture of the file |
attachments[].url |
String | Yes |
A URL to the file |
attachments[].type |
String | Yes |
The mime-type of the attachment |
attachments[].link_expires |
Boolean | No |
If true, it will use the getMessageById endpoint for fetching updated attachment's urls. Find out more here Default value: false |
message |
String | Yes |
The body of the message |
conversation_link |
String | No |
A URL that can open the conversation in the provider's side |
status |
String | Yes |
The status of the message Possible values:
|
created_at |
String | Yes |
The date and time when the message was created in the provider, in UTC. Format: YYYY-MM-DD HH:MM |
conversation_id |
String | Yes |
The ID of the conversation |
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.