Master Inbox
Every reply to every campaign, from all your mailboxes, in one inbox.
Read campaign replies, answer them and archive them from your own tools, for example a helpdesk.
Authenticated with ?privateKey=YOUR_KEY (see Authentication).
| GET | /v3/inbox | List outreach inbox |
| GET | /v3/inbox/{emailId} | Read email thread |
| POST | /v3/inbox/{emailId}/reply | Reply to prospect |
| POST | /v3/inbox/{emailId}/archive | Archive inbox email |
GET
Try:
Parameters
Website IdWebsite id from list_websites.
StatusWhich view to list: inbox (replied, not archived; default), contacted (an email was sent), scheduled (an email is due and not sent yet) or archived.
PagePage number, starting at 1. Default 1.
LimitProspects per page. Default 20.
Search QueryOptional case-insensitive text matched against first name, last name and email address.
curl -X GET "https://rest-dash.revealid.xyz/v3/inbox?privateKey=YOUR_KEY&websiteId=64b7f0a1c2d3e4f5a6b7c8d9&page=1&limit=10"Response
Press Send request to try it with sample data.
What each field accepts
| Field | Type | Limits and format | Accepted values |
|---|---|---|---|
| websiteId* | string | — | any |
| status | string | — | any |
| page | number | — | any |
| limit | number | — | any |
| searchQuery | string | — | any |
Use case: Send replies to your helpdesk
Poll GET /v3/inbox (status=inbox lists people who replied; contacted, scheduled and archived are the other views), read each thread with GET /v3/inbox/{emailId}, and answer with POST /v3/inbox/{emailId}/reply. The reply goes out at once from the mailbox that sent the original email.