Public APIv266 endpoints
Warm up mailboxes from your own code.
A REST surface over your TrulyInbox workspaces - email accounts, warmup, deliverability, reports and notifications. One bearer key authenticates all of it.
Every endpoint page carries a Try it panel that sends a real request with your key, so you can confirm a call works before writing any code.
/v2/workspaces/123/tags{
"success": true,
"data": [{ "id": 1, "name": "production" }],
"errorCode": null,
"errorMessage": null
}Migrating from v1
Moving from the old API?
The old API (/v1) is being replaced by this one. Four things change everywhere - the base URL, the path, the auth header and the response shape - and every old endpoint maps to a new route, with the old and new call side by side.
Three values you supply
Everything else in a request is fixed. These are the parts that are yours, and the order you get them in.
01
Create a key
Open Settings → API keys in the TrulyInbox app. Copy the key when it appears: it is shown once and cannot be retrieved again.
Key types and scopes →02
Find your workspace id
Every path is workspace-scoped - /v2/workspaces/{id}/… - so a call needs the numeric id of the workspace you are reading or changing.
Where to find it →03
Grant the scope
Each endpoint requires one scope, and the key’s role in the workspace caps it. A key without the scope gets a 403, not a 401.
Scope reference →
The whole surface
66 endpoints in 9 groups. Every path is prefixed with /v2/workspaces/{workspaceId}.
Email Accounts
- POSTBulk email account status
- POSTAssign or unassign tags in bulk
- GETList email accounts
- POSTConnect an email account
- POSTGenerate an OAuth connection URL
- POSTConnect a partner-managed OAuth mailbox (partner use only)
- GETGet a Microsoft single-mailbox consent link
- GETGet email account
- DELETEDelete an email account
- GETGet account overview
- POSTDisconnect an account
- GETList workspace tags
- POSTCreate workspace tag
- PUTSet account tags
DWD Workspaces
Workspace Settings
Warmup
Deliverability
Reports
Templates
- GETList templates
- POSTCreate a template
- GETGet a template
- PATCHUpdate a template
- DELETEDelete a template
- GETGet template usage
- POSTSubmit for review
- POSTRetry a delayed review
- POSTConfirm the improved version
- POSTDecline the improved version
- PUTSet template labels
- GETList template labels
- POSTCreate a template label
- PATCHRename a template label
- DELETEDelete a template label
- GETList merge tags
When a call fails
Every response uses one envelope. Failures carry a 6-digit code that names the cause - the full catalog, with the status each code returns.
Your request budget
Limits are counted per key, per minute, with separate read and write budgets - plus the headers that tell you what you have left.