Mailbox

Mailbox was designed to be the email control hub inside Pipedrive. Pipedrive supports all major providers (including Gmail, Outlook and also custom IMAP/SMTP). There are 2 options for syncing user emails: 2-way sync: Mail Connection is established with the mail provider (example Gmail). There can be only 1 active Mail Connection per user in company. 1-way sync: SmartBCC feature which stores the copies of email messages to Pipedrive by adding the SmartBCC specific address to mail recipients.

Get one mail message

Copy link
Copy to clipboard
GET

/v1/mailbox/mailMessages/{id}

Returns data about specific mail message.

Path parameters

id

integer

required

ID of the mail message to fetch.

Query parameters

include_body

number

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

Default

1

Values

0

1

Response
200

The mail messages that are being synced with Pipedrive

Expand all
Copy code
    • true
    • 2000
    • "Success"
    • "email-api"
    • { ... }

    Get mail threads

    Copy link
    Copy to clipboard
    GET

    /v1/mailbox/mailThreads

    Returns mail threads in specified folder ordered by most recent message within.

    Query parameters

    folder

    string

    required

    Type of folder to fetch.

    Default

    inbox

    Values

    inbox

    drafts

    sent

    archive

    start

    integer

    Pagination start

    Default

    0

    limit

    integer

    Items shown per page

    Response
    200

    Get mail threads

    Expand all
    Copy code
      • true
      • [ ... ]

      Get one mail thread

      Copy link
      Copy to clipboard
      GET

      /v1/mailbox/mailThreads/{id}

      Returns specific mail thread.

      Path parameters

      id

      integer

      required

      ID of the mail thread

      Response
      200

      Get mail threads

      Expand all
      Copy code
        • true
        • { ... }

        Get all mail messages of mail thread

        Copy link
        Copy to clipboard
        GET

        /v1/mailbox/mailThreads/{id}/mailMessages

        Get mail messages inside specified mail thread.

        Path parameters

        id

        integer

        required

        ID of the mail thread

        Response
        200

        Get mail messages from thread

        Expand all
        Copy code
          • true
          • [ ... ]

          Update mail thread details

          Copy link
          Copy to clipboard
          PUT

          /v1/mailbox/mailThreads/{id}

          Updates the properties of a mail thread.

          Path parameters

          id

          integer

          required

          ID of the mail thread

          Body parameters

          application/x-www-form-urlencoded

          deal_id

          integer

          The ID of the deal this thread is associated with

          lead_id

          string

          The ID of the lead this thread is associated with

          Format

          uuid

          shared_flag

          Whether this thread is shared with other users in your company

          Values

          0

          1

          read_flag

          Whether this thread read or unread

          Values

          0

          1

          archived_flag

          Whether this thread is archived or not. You can only archive threads that belong to Inbox folder. Archived threads will disappear from Inbox.

          Values

          0

          1

          Response
          200

          Updates the properties of a mail thread.

          Expand all
          Copy code
            • true
            • [ ... ]

            Delete mail thread

            Copy link
            Copy to clipboard
            DELETE

            /v1/mailbox/mailThreads/{id}

            Marks mail thread as deleted.

            Path parameters

            id

            integer

            required

            ID of the mail thread

            Response
            200

            Marks mail thread as deleted.

            Expand all
            Copy code
              • null
              • true
              • 2000
              • "Success"
              • "email-api"

            Subscribe to Pipedrive’s Developer Newsletter