addedOutput schema / additionalProperties
Added value: +false
changedOutput schema / description
Previous value: -"Envelope; the result is in data.data."New value: +"The managed inbox, its sender mailbox and its api_key."
addedOutput schema / properties / address
Added value: +{
+ "description": "Managed inbox domain, not a mailbox: send from sender_address.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / api_key
Added value: +{
+ "description": "Pass as api_key on later calls. Absent when it cannot be returned.",
+ "type": "string"
+}
addedOutput schema / properties / can_send_to
Added value: +{
+ "additionalProperties": false,
+ "description": "Who this account may email. Absent when no api_key is available.",
+ "properties": {
+ "address_rules_omitted": {
+ "description": "Address rules left out of rules; set when some were.",
+ "type": "integer"
+ },
+ "address_rules_partial": {
+ "description": "True when the address rules are a sample: an unlisted address may be allowed.",
+ "type": "boolean"
+ },
+ "any_recipient": {
+ "description": "True when any recipient is allowed. Set when known.",
+ "type": "boolean"
+ },
+ "known": {
+ "description": "False when the rules could not be read; then only summary is set.",
+ "type": "boolean"
+ },
+ "rules": {
+ "description": "Who you may email, one rule per kind of recipient. Set when known.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "address": {
+ "description": "address and org_member_email rules only: the address.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Who the rule allows, in words.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "your_domain rules only: the domain.",
+ "type": "string"
+ },
+ "last_received_at": {
+ "description": "address rules only: last mail from it.",
+ "type": "string"
+ },
+ "received_count": {
+ "description": "address rules only: emails received from it.",
+ "type": "integer"
+ },
+ "type": {
+ "description": "any_recipient, primitive_managed_domain, managed_zone, your_domain, address, org_member_email or opted_in_domains.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "managed_zone rules only: the zone.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "description"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "summary": {
+ "description": "Who this account can reach, to tell the user.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "known",
+ "summary"
+ ],
+ "type": "object"
+}
removedOutput schema / properties / data
Removed value: -{
- "description": "API response: the result in data, or error.",
- "properties": {
- "data": {
- "description": "The managed inbox and its api_key.",
- "properties": {
- "address": {
- "description": "Managed inbox domain.",
- "type": [
- "string",
- "null"
- ]
- },
- "api_key": {
- "description": "Pass as api_key on later calls; absent if unavailable.",
- "type": "string"
- },
- "can_send_to": {
- "description": "Who you may email.",
- "properties": {
- "any_recipient": {
- "description": "Any recipient is allowed.",
- "type": "boolean"
- },
- "rules": {
- "description": "Who is allowed: each has a type and a description.",
- "type": "array"
- },
- "summary": {
- "description": "What to tell the user.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "existing_account": {
- "description": "This host's existing inbox, returned again.",
- "type": "boolean"
- },
- "funding": {
- "description": "Link to fund credits.",
- "properties": {
- "description": {
- "type": "string"
- },
- "url": {
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- },
- "limits": {
- "description": "What the plan allows.",
- "properties": {
- "api_per_minute": {
- "type": [
- "number",
- "string"
- ]
- },
- "send_per_day": {
- "type": [
- "number",
- "string"
- ]
- },
- "send_per_hour": {
- "type": [
- "number",
- "string"
- ]
- },
- "storage_mb": {
- "type": [
- "number",
- "string"
- ]
- }
- },
- "type": "object"
- },
- "message": {
- "description": "For an existing inbox: what to tell the user.",
- "type": "string"
- },
- "org_id": {
- "description": "Account id.",
- "type": "string"
- },
- "plan": {
- "description": "Plan name: agent.",
- "type": "string"
- },
- "sender_address": {
- "description": "Mailbox to send from.",
- "type": "string"
- },
- "upgrade": {
- "description": "How to move to a full account.",
- "properties": {
- "claim_path": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "plan": {
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "type": [
- "object",
- "null"
- ]
- },
- "error": {
- "description": "Why the call was refused; absent on success.",
- "properties": {
- "code": {
- "description": "Error code to branch on.",
- "type": "string"
- },
- "message": {
- "description": "What went wrong, in words.",
- "type": "string"
- }
- },
- "type": [
- "object",
- "null"
- ]
- },
- "success": {
- "description": "True when data holds the result.",
- "type": "boolean"
- }
- },
- "type": "object"
-}
addedOutput schema / properties / existing_account
Added value: +{
+ "description": "True when this host already had an inbox and it was returned again.",
+ "type": "boolean"
+}
addedOutput schema / properties / funding
Added value: +{
+ "additionalProperties": false,
+ "description": "New account only: how to fund credits.",
+ "properties": {
+ "description": {
+ "description": "What funding does.",
+ "type": "string"
+ },
+ "url": {
+ "description": "Where to fund it; null if not available.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "description"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / limits
Added value: +{
+ "additionalProperties": false,
+ "description": "New account only: what the plan allows.",
+ "properties": {
+ "api_per_minute": {
+ "description": "API requests per minute.",
+ "type": "integer"
+ },
+ "send_per_day": {
+ "description": "Emails it may send per day.",
+ "type": "integer"
+ },
+ "send_per_hour": {
+ "description": "Emails it may send per hour.",
+ "type": "integer"
+ },
+ "storage_mb": {
+ "description": "Mail storage, in MB.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "send_per_hour",
+ "send_per_day",
+ "api_per_minute",
+ "storage_mb"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / message
Added value: +{
+ "description": "Existing inbox only: what to tell the user.",
+ "type": "string"
+}
addedOutput schema / properties / org_id
Added value: +{
+ "description": "Account id.",
+ "type": "string"
+}
addedOutput schema / properties / plan
Added value: +{
+ "description": "New account only: plan name, agent.",
+ "type": "string"
+}
addedOutput schema / properties / sender_address
Added value: +{
+ "description": "Mailbox to send from. Set when address is.",
+ "type": "string"
+}
removedOutput schema / properties / status
Removed value: -{
- "description": "HTTP status; 2xx on success.",
- "type": "number"
-}
removedOutput schema / properties / tool
Removed value: -{
- "description": "Tool that answered.",
- "type": "string"
-}
addedOutput schema / properties / upgrade
Added value: +{
+ "additionalProperties": false,
+ "description": "New account only: how to move to a full account.",
+ "properties": {
+ "claim_path": {
+ "description": "API path that claims the account.",
+ "type": "string"
+ },
+ "description": {
+ "description": "What upgrading does.",
+ "type": "string"
+ },
+ "plan": {
+ "description": "Plan it moves to.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "plan",
+ "description",
+ "claim_path"
+ ],
+ "type": "object"
+}
changedOutput schema / required
Previous value: -[
- "tool",
- "status",
- "data"
-]New value: +[
+ "org_id",
+ "address",
+ "existing_account"
+]