Report what happened to a message
report_sendReport one outbox message: sent (final: the person moves to the next step; reporting sent twice is fine, a different second report is 409 already_reported), refused_cap, refused_unsigned or failed_transient (the message stays in To send and gives its cap unit back), refused_suppressed (the person is suppressed and leaves the campaign). A later bounce is not a report: use add_suppression with reason bounced. Requires the manage_campaigns scope.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"campaign_id": "<campaign_id>",
"email_id": "<email_id>",
"outcome": "<outcome>"
},
"name": "report_send"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | Short reason for a refusal. | |
| outcome | Yes | sent, refused_cap, refused_unsigned, failed_transient or refused_suppressed. | |
| email_id | Yes | The email_id from get_outbox. | |
| campaign_id | Yes | Campaign id. | |
| provider_id | No | The sender's own message id, when it has one. | |
| idempotency_key | No | Optional. Repeating a call with the same key and the same arguments returns the first result instead of writing again, so retries are safe. |