changedInput schema / properties / cursor / description
Previous value: -"Where the next page starts: the meta.cursor of the page before."New value: +"Where the next page starts: the cursor of the page before."
changedInput schema / properties / full / description
Previous value: -"Return the stored record, with hashes, message ids and signing details, instead of the compact view for reading."New value: +"Return the stored record, with envelope addresses, the request id and every outcome field, instead of the compact view for reading."
changedInput schema / properties / limit / description
Previous value: -"How many sends this call returns; follow meta.cursor for more."New value: +"How many sends this call returns; follow cursor for more."
addedOutput schema / additionalProperties
Added value: +false
changedOutput schema / description
Previous value: -"Envelope; the result is in data.data."New value: +"A page of sent emails, and the cursor for the next."
addedOutput schema / properties / cursor
Added value: +{
+ "description": "Pass as cursor for the next page; null at the end.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
removedOutput schema / properties / data
Removed value: -{
- "description": "API response: the result in data, or error.",
- "properties": {
- "data": {
- "description": "A page of sent emails.",
- "items": {
- "description": "One send; full adds stored fields.",
- "properties": {
- "canceled_at": {
- "description": "When canceled.",
- "type": [
- "string",
- "null"
- ]
- },
- "created_at": {
- "description": "When it was sent or queued.",
- "type": "string"
- },
- "error_code": {
- "description": "Why not delivered.",
- "type": [
- "string",
- "null"
- ]
- },
- "error_message": {
- "description": "Detail of the error.",
- "type": [
- "string",
- "null"
- ]
- },
- "from": {
- "description": "Sender.",
- "type": "string"
- },
- "from_address": {
- "description": "Envelope sender.",
- "type": "string"
- },
- "gates": {
- "description": "Rules that refused it: name, reason.",
- "type": [
- "array",
- "null"
- ]
- },
- "id": {
- "description": "Sent email id, for getSentEmail.",
- "type": "string"
- },
- "in_reply_to_email_id": {
- "description": "Inbound email it answers.",
- "type": [
- "string",
- "null"
- ]
- },
- "request_id": {
- "description": "For support.",
- "type": [
- "string",
- "null"
- ]
- },
- "scheduled_at": {
- "description": "When it goes out.",
- "type": [
- "string",
- "null"
- ]
- },
- "smtp_response_code": {
- "description": "Remote server code.",
- "type": [
- "number",
- "string",
- "null"
- ]
- },
- "smtp_response_text": {
- "description": "Remote server reply.",
- "type": [
- "string",
- "null"
- ]
- },
- "snippet": {
- "description": "Start of the body.",
- "type": [
- "string",
- "null"
- ]
- },
- "status": {
- "description": "Delivery state, such as delivered or bounced.",
- "type": "string"
- },
- "subject": {
- "description": "Subject line.",
- "type": [
- "string",
- "null"
- ]
- },
- "thread_id": {
- "description": "Conversation it belongs to.",
- "type": [
- "string",
- "null"
- ]
- },
- "to": {
- "description": "Recipients.",
- "type": "string"
- },
- "to_address": {
- "description": "Envelope recipient.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": [
- "array",
- "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"
- ]
- },
- "meta": {
- "description": "cursor for the next page, and total.",
- "type": [
- "object",
- "null"
- ]
- },
- "success": {
- "description": "True when data holds the result.",
- "type": "boolean"
- }
- },
- "type": "object"
-}
addedOutput schema / properties / sent_emails
Added value: +{
+ "description": "The sends, newest first.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "canceled_at": {
+ "description": "When a scheduled send was canceled.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "created_at": {
+ "description": "When it was sent or queued.",
+ "type": "string"
+ },
+ "error_code": {
+ "description": "Set when it was not delivered: why, as a code.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "error_message": {
+ "description": "Set when it was not delivered: why, in words.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "from": {
+ "description": "Sender, as the From header shows it.",
+ "type": "string"
+ },
+ "from_address": {
+ "description": "full only: envelope sender address.",
+ "type": "string"
+ },
+ "gates": {
+ "description": "Set when rules refused it: which ones.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "message": {
+ "description": "Why, in words, when given.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Rule that refused it, such as send_to_known_addresses.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Why, as a code, when given.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "id": {
+ "description": "Sent email id, for getSentEmail.",
+ "type": "string"
+ },
+ "in_reply_to_email_id": {
+ "description": "Set when it answers an inbound email: its id, for getEmail.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "request_id": {
+ "description": "full only: id of the send request, for support.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "scheduled_at": {
+ "description": "When a scheduled send goes out.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "smtp_response_code": {
+ "description": "Remote server reply code, such as 550. Compact rows leave it out once delivered.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "smtp_response_text": {
+ "description": "Remote server reply text. Compact rows leave it out once delivered.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "snippet": {
+ "description": "Start of the body; null when there is none.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "status": {
+ "description": "queued, submitted_to_agent, delivered, bounced, deferred, wait_timeout, gate_denied, agent_failed, scheduled, canceled or unknown.",
+ "type": "string"
+ },
+ "subject": {
+ "description": "Subject line.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "thread_id": {
+ "description": "Conversation id; null when it is in none.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "to": {
+ "description": "Recipients, as the To header shows them.",
+ "type": "string"
+ },
+ "to_address": {
+ "description": "full only: envelope recipient address.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "thread_id",
+ "created_at",
+ "status",
+ "from",
+ "to",
+ "subject",
+ "snippet"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
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 / total
Added value: +{
+ "description": "Matches, when counted; absent when the count was skipped or ran out of time.",
+ "type": [
+ "integer",
+ "null"
+ ]
+}
addedOutput schema / properties / total_capped
Added value: +{
+ "description": "True when total stopped at its cap and is a lower bound.",
+ "type": "boolean"
+}
addedOutput schema / properties / total_unavailable
Added value: +{
+ "description": "Set, true, when the count did not fit its time budget, so total is absent.",
+ "type": "boolean"
+}
changedOutput schema / required
Previous value: -[
- "tool",
- "status",
- "data"
-]New value: +[
+ "sent_emails",
+ "cursor"
+]