Mailbox

Get one mail message

Changed on

Returns data about a specific mail message.

get/mailbox/mailMessages/{id}

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: mail:read, mail:full

Path parameters

idinteger required

The ID of the mail message to fetch

Query parameters

include_body0 | 1

Whether to include the full message body or not. 0 = Don't include, 1 = Include.

Response

The mail messages that are being synced with Pipedrive

successboolean

If the response is successful or not

statusCodeinteger

The email service specific status code and it is returned through the response body.

statusTextstring

The status text of the response.

servicestring

The service name of the response.

Changes

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • info

      added the optional property // to the response with the status