Skip to main content
POST
Check email message sent

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Body

application/json

Request body of check_email_message_sent.

email_account_sid
string
required

The mailbox the send ran on.

Required string length: 18
Pattern: ^em_ac_
client_reference
string | null

The key of the send. Exactly one of client_reference and activity_log_sid.

Maximum string length: 255
activity_log_sid
string | null

The attempt an earlier answer named. Never with to, cc or bcc.

Required string length: 18
Pattern: ^em_al_
to
string<email>[] | null

The recipient set the send named, to tell apart sends under one key.

Maximum array length: 50
Maximum string length: 320
cc
string<email>[] | null
Maximum array length: 50
Maximum string length: 320
bcc
string<email>[] | null
Maximum array length: 50
Maximum string length: 320

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required