Fetch an Email Operation

This operation fetches a single Email Operation using its ID.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <account_id:auth_token>.

AuthorizationBasic

Basic authentication of the form Basic <api_key:api_key_secret>.

Path parameters

operationIdstringRequired

Response

idstringformat: "^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}"

The Operation ID is an identifier that can be used to correlate all of the resources created in a request. Issue a GET request to the resource list location, using the Operation ID as a query parameter to retrieve the resources that correlate with the Operation.

statusenum

The status of an Operation.

Allowed values:

statsobject

Represents the stats of a sending operation of one or many Emails.

total is the total number of Email resources created in the Operation.
- To get the status for each individual Email, fetch the Email resource: GET /Email/{emailId}.
- For Emails with multiple recipients, use Receipts e.g. GET /Emails/{emailId}/Receipts.
recipients is the total number of recipients targeted in an Operation.
attempts is the total number of sending attempts made by Twilio.
scheduled is the number of Emails that are scheduled to be sent by Twilio in the future.
queued is the number of Emails that are queued in Twilio for sending.
sent is the number of Emails that have been sent by Twilio.
delivered is the number of Emails that have been successfully delivered to recipients.
opened is the number of Emails that have been opened by unique recipients.
undelivered is the number of Emails that were successfully sent by Twilio but have not been delivered to the recipient.
failed is the number of Emails that failed during processing by Twilio. Get Errors with GET /Emails/Operations/{operationId}/Errors fore more detail.
canceled is the number of Emails that were canceled via API request.

Represents the stats of a sending operation of one or many `Emails`. - `total` is the total number of `Email` resources created in the `Operation`. * To get the status for each individual `Email`, fetch the `Email` resource: `GET /Email/{emailId}`. * For `Emails` with multiple recipients, use `Receipts` e.g. `GET /Emails/{emailId}/Receipts`. - `recipients` is the total number of recipients targeted in an Operation. - `attempts` is the total number of sending attempts made by Twilio. - `scheduled` is the number of `Emails` that are scheduled to be sent by Twilio in the future. - `queued` is the number of `Emails` that are queued in Twilio for sending. - `sent` is the number of `Emails` that have been sent by Twilio. - `delivered` is the number of `Emails` that have been successfully delivered to recipients. - `opened` is the number of `Emails` that have been opened by unique recipients. - `undelivered` is the number of `Emails` that were successfully sent by Twilio but have not been delivered to the recipient. - `failed` is the number of `Emails` that failed during processing by Twilio. Get `Errors` with `GET /Emails/Operations/{operationId}/Errors` fore more detail. - `canceled` is the number of `Emails` that were canceled via API request.

createdAtstringformat: "date-time"

updatedAtstringformat: "date-time"

Errors

Represents the stats of a sending operation of one or many Emails.

total is the total number of Email resources created in the Operation.
- To get the status for each individual Email, fetch the Email resource: GET /Email/{emailId}.
- For Emails with multiple recipients, use Receipts e.g. GET /Emails/{emailId}/Receipts.
recipients is the total number of recipients targeted in an Operation.
attempts is the total number of sending attempts made by Twilio.
scheduled is the number of Emails that are scheduled to be sent by Twilio in the future.
queued is the number of Emails that are queued in Twilio for sending.
sent is the number of Emails that have been sent by Twilio.
delivered is the number of Emails that have been successfully delivered to recipients.
opened is the number of Emails that have been opened by unique recipients.
undelivered is the number of Emails that were successfully sent by Twilio but have not been delivered to the recipient.
failed is the number of Emails that failed during processing by Twilio. Get Errors with GET /Emails/Operations/{operationId}/Errors fore more detail.
canceled is the number of Emails that were canceled via API request.

1	{
2	"id": "comms_operation_01h2xcejqtf2nbrexx3vqjhp41",
3	"status": "COMPLETED",
4	"stats": {
5	"total": 1,
6	"recipients": 1,
7	"attempts": 1,
8	"queued": 0,
9	"sent": 0,
10	"scheduled": 0,
11	"delivered": 1,
12	"opened": 0,
13	"undelivered": 0,
14	"failed": 0,
15	"canceled": 0
16	},
17	"createdAt": "2024-04-05T06:20:00Z",
18	"updatedAt": "2024-04-05T06:20:00Z"
19	}

1	curl https://comms.twilio.com/v1/Emails/Operations/operationId \
2	-u "<accountId>:<authToken>"