|
4613 | 4613 | "200": { |
4614 | 4614 | "description": "", |
4615 | 4615 | "schema": { |
4616 | | - "schema": { |
4617 | | - "type": "array", |
4618 | | - "description": "an array of objects for each recipient containing the key \"email\" with the email address, and details of the message status for that recipient", |
4619 | | - "items": { |
4620 | | - "type": "object", |
4621 | | - "description": "the sending results for a single recipient", |
4622 | | - "properties": { |
4623 | | - "email": { |
4624 | | - "type": "string", |
4625 | | - "format": "email", |
4626 | | - "description": "the email address of the recipient", |
4627 | | - |
4628 | | - }, |
4629 | | - "status": { |
4630 | | - "type": "string", |
4631 | | - "description": "the sending status of the recipient", |
4632 | | - "enum": [ |
4633 | | - "sent", |
4634 | | - "queued", |
4635 | | - "scheduled", |
4636 | | - "rejected", |
4637 | | - "invalid" |
4638 | | - ], |
4639 | | - "example": "sent" |
4640 | | - }, |
4641 | | - "reject_reason": { |
4642 | | - "type": "string", |
4643 | | - "description": "the reason for the rejection if the recipient status is \"rejected\"", |
4644 | | - "enum": [ |
4645 | | - "hard-bounce", |
4646 | | - "soft-bounce", |
4647 | | - "spam", |
4648 | | - "unsub", |
4649 | | - "custom", |
4650 | | - "invalid-sender", |
4651 | | - "invalid", |
4652 | | - "test-mode-limit", |
4653 | | - "unsigned", |
4654 | | - "rule" |
4655 | | - ], |
4656 | | - "example": "hard-bounce" |
4657 | | - }, |
4658 | | - "queued_reason": { |
4659 | | - "type": "string", |
4660 | | - "description": "the reason for the email being queued if the response status is \"queued\"", |
4661 | | - "enum": [ |
4662 | | - "attachments", |
4663 | | - "multiple-recipients", |
4664 | | - "free-trial-sends-exhausted", |
4665 | | - "hourly-quota-exhausted", |
4666 | | - "monthly-limit-reached", |
4667 | | - "sending-paused", |
4668 | | - "sending-suspended", |
4669 | | - "account-suspended", |
4670 | | - "sending-backlogged" |
4671 | | - ], |
4672 | | - "example": "hourly-quota-exhausted" |
4673 | | - }, |
4674 | | - "_id": { |
4675 | | - "type": "string", |
4676 | | - "description": "the message's unique id", |
4677 | | - "example": "a92c74e4c5d74998ba690cd535483bb7" |
4678 | | - } |
| 4616 | + "type": "array", |
| 4617 | + "description": "an array of objects for each recipient containing the key \"email\" with the email address, and details of the message status for that recipient", |
| 4618 | + "items": { |
| 4619 | + "type": "object", |
| 4620 | + "description": "the sending results for a single recipient", |
| 4621 | + "properties": { |
| 4622 | + "email": { |
| 4623 | + "type": "string", |
| 4624 | + "format": "email", |
| 4625 | + "description": "the email address of the recipient", |
| 4626 | + |
| 4627 | + }, |
| 4628 | + "status": { |
| 4629 | + "type": "string", |
| 4630 | + "description": "the sending status of the recipient", |
| 4631 | + "enum": [ |
| 4632 | + "sent", |
| 4633 | + "queued", |
| 4634 | + "scheduled", |
| 4635 | + "rejected", |
| 4636 | + "invalid" |
| 4637 | + ], |
| 4638 | + "example": "sent" |
| 4639 | + }, |
| 4640 | + "reject_reason": { |
| 4641 | + "type": "string", |
| 4642 | + "description": "the reason for the rejection if the recipient status is \"rejected\"", |
| 4643 | + "enum": [ |
| 4644 | + "hard-bounce", |
| 4645 | + "soft-bounce", |
| 4646 | + "spam", |
| 4647 | + "unsub", |
| 4648 | + "custom", |
| 4649 | + "invalid-sender", |
| 4650 | + "invalid", |
| 4651 | + "test-mode-limit", |
| 4652 | + "unsigned", |
| 4653 | + "rule" |
| 4654 | + ], |
| 4655 | + "example": "hard-bounce" |
| 4656 | + }, |
| 4657 | + "queued_reason": { |
| 4658 | + "type": "string", |
| 4659 | + "description": "the reason for the email being queued if the response status is \"queued\"", |
| 4660 | + "enum": [ |
| 4661 | + "attachments", |
| 4662 | + "multiple-recipients", |
| 4663 | + "free-trial-sends-exhausted", |
| 4664 | + "hourly-quota-exhausted", |
| 4665 | + "monthly-limit-reached", |
| 4666 | + "sending-paused", |
| 4667 | + "sending-suspended", |
| 4668 | + "account-suspended", |
| 4669 | + "sending-backlogged" |
| 4670 | + ], |
| 4671 | + "example": "hourly-quota-exhausted" |
| 4672 | + }, |
| 4673 | + "_id": { |
| 4674 | + "type": "string", |
| 4675 | + "description": "the message's unique id", |
| 4676 | + "example": "a92c74e4c5d74998ba690cd535483bb7" |
4679 | 4677 | } |
4680 | 4678 | } |
4681 | 4679 | } |
|
0 commit comments