Invite a member to Move daily warmup budget between workspaces
Sends an invitation email and returns the pending invite. The person becomes a member only after they accept, so they do not appear in the member list yet.
Invite a member
Sends an invitation email and returns the pending invite. The person becomes a member only after they accept, so they do not appear in the member list yet.
| Old API | New API | |
|---|---|---|
| Method + route | none - new | POST /v2/workspaces/{workspaceId}/members/invite |
| Key permission (scope) | none - new | workspace:manage (key must act as workspace admin or owner) |
| Rate bucket | none - new | write |
| Plan needed | none - new | paid plan feature (team members) |
What changed
- New endpoint.
- You cannot invite someone as
owner. Allowed roles areadmin,editor,viewer. - Inviting as
adminneeds a caller who is an organization owner or admin. A workspace key never is, so use a personal key for admin invites. - The invite expires after 48 hours (see
expiresAt).
Path and query parameters
| Name | In | Type | Required | Default / limits | What it means | Old name |
|---|---|---|---|---|---|---|
workspaceId | path | number | yes | - | The workspace to invite into. | - |
Request body
| New field | Type | Required | Allowed values / limits | What it means | Old field |
|---|---|---|---|---|---|
email | string | yes | valid email address | Who to invite. | - |
role | string | yes | admin, editor, viewer | Role they get when they accept. | - |
Example request (new)
curl -X POST "$TI_BASE_URL/v2/workspaces/412/members/invite" \
-H "Authorization: Bearer ti_pk_your_key" \
-H "Content-Type: application/json" \
-d '{
"email": "maria@acme.com",
"role": "editor"
}'Response (new)
201 Created.
| New field (inside data) | Type | What it means | Old field |
|---|---|---|---|
id | number | Invite id. | - |
email | string | Invited email. | - |
role | admin | editor | viewer | Role they will get. | - |
expiresAt | string (date-time) | When the invite stops working. | - |
{
"data": {
"id": 2071,
"email": "maria@acme.com",
"role": "editor",
"expiresAt": "2026-10-01T10:00:00.000Z"
},
"meta": {
"request_id": "req_e82f1a6c39",
"timestamp": "2026-09-29T10:00:00.000Z"
}
}Errors you should handle
| HTTP | error.code | When it happens | What to do |
|---|---|---|---|
| 400 | invalid_request | Bad email, or role is not admin, editor or viewer. | Fix the body. |
| 401 | unauthorized / invalid_api_key | Missing, wrong or revoked key. | Check the key. |
| 403 | insufficient_scope | Key lacks workspace:manage, or acts below admin. | Use a key with workspace:manage at admin level. |
| 403 | workspace_forbidden | Key cannot reach this workspace. | Use the right key or id. |
| 403 | forbidden | Inviting as admin without being an organization owner or admin; your plan does not include team members; or the key's creator is no longer a workspace admin. | Use a personal key of an organization owner or admin; upgrade the plan if needed. |
| 404 | not_found | No such workspace. | Check the id. |
| 409 | conflict | Already a member, an invite is already pending for this email, or the person belongs to another organization. | Do not retry. Check the member list. |
| 429 | rate_limit_exceeded | Write bucket is empty. | Wait error.retry_after seconds. |
Change a member's role
Sets a new role for an existing member.
| Old API | New API | |
|---|---|---|
| Method + route | none - new | PATCH /v2/workspaces/{workspaceId}/members/{userId} |
| Key permission (scope) | none - new | workspace:manage (key must act as workspace admin or owner) |
| Rate bucket | none - new | write |
| Plan needed | none - new | paid plan feature (team members) |
What changed
- New endpoint.
userIdis theuserIdfrom the member list, not an invite id.- Allowed roles are
admin,editor,viewer. You cannot make someoneownerhere. - A key cannot change the role of its own user.
- Organization owners (
isOrgOwner: true) cannot be changed here. - Giving the
adminrole, or changing someone who isadminnow, needs a caller who is an organization owner or admin. A workspace key cannot do this.
Path and query parameters
| Name | In | Type | Required | Default / limits | What it means | Old name |
|---|---|---|---|---|---|---|
workspaceId | path | number | yes | - | The workspace. | - |
userId | path | number | yes | - | The member's user id from the member list. | - |
Request body
| New field | Type | Required | Allowed values / limits | What it means | Old field |
|---|---|---|---|---|---|
role | string | yes | admin, editor, viewer | The new role. | - |
Example request (new)
curl -X PATCH "$TI_BASE_URL/v2/workspaces/412/members/131" \
-H "Authorization: Bearer ti_ws_your_key" \
-H "Content-Type: application/json" \
-d '{ "role": "viewer" }'Response (new)
200 OK. The updated member, same fields as one item of "List members".
{
"data": {
"userId": 131,
"email": "raj@acme.com",
"name": null,
"role": "viewer",
"isOrgOwner": false
},
"meta": {
"request_id": "req_4a7c0d9e21",
"timestamp": "2026-09-29T10:00:00.000Z"
}
}Errors you should handle
| HTTP | error.code | When it happens | What to do |
|---|---|---|---|
| 400 | invalid_request | role not allowed (for example owner), or you tried to change your own key user's role. | Fix the role, or use another admin's key. |
| 401 | unauthorized / invalid_api_key | Missing, wrong or revoked key. | Check the key. |
| 403 | insufficient_scope | Key lacks workspace:manage, or acts below admin. | Use a key with workspace:manage at admin level. |
| 403 | workspace_forbidden | Key cannot reach this workspace. | Use the right key or id. |
| 403 | forbidden | Target is an organization owner; admin involved without an organization owner or admin caller; plan lacks team members; or the key's creator is no longer a workspace admin. | Manage owners in the TrulyInbox app; use a personal key of an organization owner or admin for admin changes. |
| 404 | not_found | No such workspace, or that user is not a member. | Check ids with GET /v2/workspaces/{workspaceId}/members. |
| 429 | rate_limit_exceeded | Write bucket is empty. | Wait error.retry_after seconds. |
Remove a member
Removes a user from the workspace. The user keeps their TrulyInbox account and their other workspaces. Their email accounts stay in this workspace.
| Old API | New API | |
|---|---|---|
| Method + route | none - new | DELETE /v2/workspaces/{workspaceId}/members/{userId} |
| Key permission (scope) | none - new | workspace:manage (key must act as workspace admin or owner) |
| Rate bucket | none - new | write |
| Plan needed | none - new | paid plan feature (team members) |
What changed
- New endpoint.
- Returns 204 with no body.
- Removing a member whose role is
adminneeds a caller who is an organization owner or admin. - Careful: if
userIdis the key's own user, this is "leave workspace". The key then loses access to the workspace. - Organization owners are managed at organization level. Do not use this call for them; the last owner can never be removed.
Path and query parameters
| Name | In | Type | Required | Default / limits | What it means | Old name |
|---|---|---|---|---|---|---|
workspaceId | path | number | yes | - | The workspace. | - |
userId | path | number | yes | - | The member's user id from the member list. | - |
Request body
No body.
Example request (new)
curl -X DELETE "$TI_BASE_URL/v2/workspaces/412/members/131" \
-H "Authorization: Bearer ti_ws_your_key"Response (new)
204 No Content. No body, no meta.
Errors you should handle
| HTTP | error.code | When it happens | What to do |
|---|---|---|---|
| 401 | unauthorized / invalid_api_key | Missing, wrong or revoked key. | Check the key. |
| 403 | insufficient_scope | Key lacks workspace:manage, or acts below admin. | Use a key with workspace:manage at admin level. |
| 403 | workspace_forbidden | Key cannot reach this workspace. | Use the right key or id. |
| 403 | forbidden | Target is an admin and the caller is not an organization owner or admin; target is the last organization owner; plan lacks team members; or the key's creator is no longer a workspace admin. | Use a personal key of an organization owner or admin; manage owners in the TrulyInbox app. |
| 404 | not_found | No such workspace, or that user is not a member. | Treat as already removed. |
| 429 | rate_limit_exceeded | Write bucket is empty. | Wait error.retry_after seconds. |
Read budgets (quotas)
Shows the organization's total daily warmup cap, how much of it is given out, and each workspace's share.
| Old API | New API | |
|---|---|---|
| Method + route | none - new | GET /v2/workspaces/quotas |
| Key permission (scope) | none - new | workspace:quota. Personal key (ti_pk_) of an organization owner only. |
| Rate bucket | none - new | read |
| Plan needed | none - new | - |
What changed
- New endpoint. The old API had no per-workspace budget.
orgLimit: nullmeans unlimited, not zero. Do not treatnullas "no room".- Free room =
orgLimit - allocated(whenorgLimitis not null).
Path and query parameters
None.
Request body
No body.
Example request (new)
curl -X GET "$TI_BASE_URL/v2/workspaces/quotas" \
-H "Authorization: Bearer ti_pk_your_key"Response (new)
200 OK.
| New field (inside data) | Type | What it means | Old field |
|---|---|---|---|
orgLimit | number or null | Total daily warmup emails your plan allows across all workspaces. null = unlimited. | - |
allocated | number | Sum of every active workspace's dailyWarmupBudget. The same number the update call checks against orgLimit. | - |
workspaces[].workspaceId | number | Workspace id. | - |
workspaces[].dailyWarmupBudget | number | That workspace's daily share. | - |
{
"data": {
"orgLimit": 2500,
"allocated": 2000,
"workspaces": [
{ "workspaceId": 412, "dailyWarmupBudget": 1500 },
{ "workspaceId": 418, "dailyWarmupBudget": 500 }
]
},
"meta": {
"request_id": "req_0b6d3f8a55",
"timestamp": "2026-09-29T10:00:00.000Z"
}
}Errors you should handle
| HTTP | error.code | When it happens | What to do |
|---|---|---|---|
| 401 | unauthorized / invalid_api_key | Missing, wrong or revoked key. | Check the key. |
| 403 | insufficient_scope | Key lacks workspace:quota. | Add the scope. |
| 403 | workspace_forbidden | Workspace key used, or the personal key's creator is not an organization owner. | Use a personal key of an organization owner. |
| 429 | rate_limit_exceeded | Read bucket is empty. | Wait error.retry_after seconds. |
Move daily warmup budget between workspaces
Sets dailyWarmupBudget for the workspaces you list. Workspaces you do not list keep their budget. Use it to give a new workspace budget, or to move budget from one workspace to another.
| Old API | New API | |
|---|---|---|
| Method + route | none - new | PATCH /v2/workspaces/quotas |
| Key permission (scope) | none - new | workspace:quota. Personal key (ti_pk_) of an organization owner only. |
| Rate bucket | none - new | write |
| Plan needed | none - new | - |
What changed
- New endpoint.
- The cap is checked once for the whole request, before anything is saved. So to move budget, lower one workspace and raise another in the same call. This works even when the organization is fully allocated. Two separate calls would fail: the "raise" call alone goes over the cap.
- About
quota_exceeds_org_limit(400): the new total of all workspace budgets (listed ones with their new values, plus unlisted ones as they are) would be more thanorgLimit. Nothing is saved. Fix it by lowering another workspace in the same request, or by asking for less. Read the free room first withGET /v2/workspaces/quotas. IforgLimitisnull(unlimited), this error does not happen. - A lower budget applies at once. If a workspace already sent more today than its new budget, it stops sending warmup emails for the rest of the day.
- Listing the same workspace twice is a 400
invalid_request.
Path and query parameters
None.
Request body
| New field | Type | Required | Allowed values / limits | What it means | Old field |
|---|---|---|---|---|---|
quotas | array of objects | yes | at least 1 item; each workspaceId only once | The budgets to set. | - |
quotas[].workspaceId | integer | yes | a workspace in your organization | Which workspace. | - |
quotas[].dailyWarmupBudget | integer | yes | 0 or more | Its new daily budget. | - |
Example request (new)
Move 500 from workspace 412 to workspace 418 (total stays 2000):
curl -X PATCH "$TI_BASE_URL/v2/workspaces/quotas" \
-H "Authorization: Bearer ti_pk_your_key" \
-H "Content-Type: application/json" \
-d '{
"quotas": [
{ "workspaceId": 412, "dailyWarmupBudget": 1000 },
{ "workspaceId": 418, "dailyWarmupBudget": 1000 }
]
}'Response (new)
200 OK. data is the list of workspaces you updated, with their new budgets.
| New field (inside data) | Type | What it means | Old field |
|---|---|---|---|
[].workspaceId | number | Workspace id. | - |
[].dailyWarmupBudget | number | New daily budget. | - |
{
"data": [
{ "workspaceId": 412, "dailyWarmupBudget": 1000 },
{ "workspaceId": 418, "dailyWarmupBudget": 1000 }
],
"meta": {
"request_id": "req_f17b2c4e90",
"timestamp": "2026-09-29T10:00:00.000Z"
}
}Errors you should handle
| HTTP | error.code | When it happens | What to do |
|---|---|---|---|
| 400 | quota_exceeds_org_limit | The new total of all budgets is more than orgLimit. Nothing was saved. | Lower another workspace in the same call, or ask for less. Check GET /v2/workspaces/quotas. |
| 400 | invalid_request | Empty quotas, a workspace listed twice, a negative or non-whole budget, or unknown fields. | Fix the body. |
| 401 | unauthorized / invalid_api_key | Missing, wrong or revoked key. | Check the key. |
| 403 | insufficient_scope | Key lacks workspace:quota. | Add the scope. |
| 403 | workspace_forbidden | Workspace key used, or the personal key's creator is not an organization owner. | Use a personal key of an organization owner. |
| 404 | not_found | A listed workspaceId is not in your organization. Nothing was saved. | Check ids with GET /v2/workspaces. |
| 429 | rate_limit_exceeded | Write bucket is empty. | Wait error.retry_after seconds. |