PIpipedrive
Channels

Receives an incoming message

Changed on

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.

post/channels/messages/receive

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

idstring required

The ID of the message

channel_idstring required

The channel ID as in the provider

sender_idstring required

The ID of the provider's user that sent the message

conversation_idstring required

The ID of the conversation

messagestring required

The body of the message

status'sent' | 'delivered' | 'read' | 'failed' required

The status of the message

created_atstring date-time required

The date and time when the message was created in the provider, in UTC. Format: YYYY-MM-DD HH:MM

reply_bystring date-time

The date and time when the message can no longer receive a reply, in UTC. Format: YYYY-MM-DD HH:MM

conversation_linkstring url

A URL that can open the conversation in the provider's side

Response

The message was registered in the conversation

successboolean

If the request was successful or not

Changes

  • cc7952f2605bRevision changes
    • info

      endpoint deprecated

  • 5f19f075613eRevision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from 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