Skip to content
ReputeCastReputeCast Docs

One message: summary, timeline, request and attempts

GET
/api/v1/workspaces/{workspace}/transactional/messages/{messageId}
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/transactional/messages/example \
  --header 'Authorization: Bearer <token>'

Permission: transactional:view

Sensitive values show as ••••••. The rendered content is a separate call that needs transactional:content.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

messageId
required

The message ID the send API answered

string
<= 36 characters

The message ID the send API answered

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
at
required

When the call was accepted

string format: date-time
attachments
required
Array<object>
object
contentId
string
contentType
required
string
filename
required
string
size
required
integer format: int64
attempts
required
Array<object>
object
at
required
string format: date-time
down
boolean
error
string
gaveUp
boolean
ok
required
boolean
provider
required
string
temporary
boolean
bcc
required
Array<string>
bounce
object
class

Mailbox_unknown, mailbox_full, domain_invalid, policy_block, spam_block, reputation, temporary, other

string
diagnostic
string
kind
required
string
Allowed values: hard soft
canRemoveSuppression
required
boolean
category
string
categoryKind
string
cc
required
Array<string>
clickedAt
string format: date-time
contact
object
id
required
string
name
required
string
contactId
string
content
required
object
available
required
boolean
canView
required
boolean
expiresAt
string format: date-time
helpers
required
Array<string>
masked
required
Array<string>
metadataUntil
required
string format: date-time
removedAt
string format: date-time
retentionDays
required
integer format: int64
contentBytes
required
integer format: int64
deferrals
required
integer format: int64
deliveryMs
integer format: int64
dropped
required
Array<string>
email
required
string
error
string
failedOver
object
at
string format: date-time
from
required
string
to
required
string
from
required
string
id
required
string
idempotencyKey
string
ip
string
key
string
keyRef
object
id
required
string
name
required
string
languageInfo
object
contact
string
reason
string
Allowed values: match no_language not_offered missing draft held requested ""
sent
required
string
metadata
required
object
key
additional properties
string
name
string
openedAt
string format: date-time
provider
object
id
required
string
name
required
string
providerMessageId
string
raw
required
boolean
rejection
object
allowed
Array<string>
error
string
optOut
object
category
required
string
since
required
string format: date-time
source
required
string
Allowed values: preference_center unsubscribe_link one_click api member ""
reason
required
string
Allowed values: suppressed opted_out test_not_allowed provider
suppression
object
code
string
detail
string
id

The suppression as it is now; empty once it was removed

string
reason
required
string
scope
string
Allowed values: all marketing
since
required
string format: date-time
source
required
string
replyTo
string
request
required
object
body
required
idempotencyKey
string
method
required
string
path
required
string
smtp
required
boolean
resend
required
object
available
required
boolean
reason
string
Allowed values: sensitive attachments raw template permission not_sent ""
sensitive
Array<string>
resentFrom
string
roleAddress
required
boolean
route
required
object
failedOver
required
boolean
fallback
string
matched

The condition’s field: category or mailbox_provider

string
policy
string
primary
string
rule
required
string
value
string
sendAt
string format: date-time
sensitiveSent
required
Array<string>
sentBy
string
sizeBytes
required
integer format: int64
softBounceLimit
required
integer format: int64
softBounces
integer format: int64
source
required
string
status
required
string
Allowed values: queued sent delivered deferred bounced complained rejected failed test
subject
required
string
suppression
object
code
string
detail
string
id

The suppression as it is now; empty once it was removed

string
reason
required
string
scope
string
Allowed values: all marketing
since
required
string format: date-time
source
required
string
tags
required
Array<string>
template
object
key
required
string
name
required
string
version
integer format: int32
testDelivered
required
boolean
timeline
required
Array<object>
object
at
required
string format: date-time
code
string
detail
string
down
boolean
event
string
kind
required
string
Allowed values: accepted rendered scheduled routed handed retry failed_over failed rejected not_delivered delivered deferred bounced complained opened clicked provider_rejected webhook
machine
boolean
provider
string
providerMessageId
string
state
string
status
integer format: int64
to
string
url
string
tracked
required
boolean
variables
required
integer format: int64
webhooks
required
Array<object>
object
at
required
string format: date-time
deliveredAt
string format: date-time
event
required
string
state
required
string
statusCode
integer format: int32
url
required
string

Example 

{
  "bounce": {
    "diagnostic": "452 4.2.2 mailbox full",
    "kind": "hard"
  },
  "languageInfo": {
    "reason": "match"
  },
  "rejection": {
    "optOut": {
      "source": "preference_center"
    },
    "reason": "suppressed",
    "suppression": {
      "code": "550 5.1.1",
      "reason": "hard_bounce",
      "scope": "all",
      "source": "Postmark"
    }
  },
  "resend": {
    "reason": "sensitive"
  },
  "status": "queued",
  "suppression": {
    "code": "550 5.1.1",
    "reason": "hard_bounce",
    "scope": "all",
    "source": "Postmark"
  },
  "timeline": [
    {
      "kind": "accepted"
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0