Gets the delivery record for a single outbound message by its correlation id.
GET
/api/twilio/sms-log/by-correlation/{correlationId}
deprecated
Requires: Twilio.SmsLog.View, merchant scope.
This is the lookup a sending feature uses to reflect a delivery outcome on its own record: it holds the correlation id returned by the send, and asks here whether the message was delivered, blocked by the compliance gate, or failed at the carrier. The tenant and merchant ids must match the message's owning scope, and the caller's own scope is enforced on top. Returns no content when no record exists, which includes a message whose row has aged out of the 30-day retention window.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
correlationId
required |
path | string (uuid) | Correlation id returned by the send. |
tenantId
required |
query | string (uuid) | Tenant id that scopes the lookup. |
merchantId
required |
query | string (uuid) | Merchant id that scopes the lookup. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.