Skip to main content
POST
Mark a Message as read

Authorizations

Authorization
string
header
required

Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.

Headers

idempotency-key
string
required
Pattern: ^[\x21-\x7e]{1,255}$

Path Parameters

id
string
required
Pattern: ^pho_prj_[0-7][0-9a-hjkmnp-tv-z]{25}$
messageId
string
required
Pattern: ^pho_msg_[0-7][0-9a-hjkmnp-tv-z]{25}$

Response

The read request was persisted for execution.

content
object
required
createdAt
string<date-time>
required

When Photon first persisted this resource.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
id
string
required
Pattern: ^pho_msg_[0-7][0-9a-hjkmnp-tv-z]{25}$
metadata
object
required
platform
enum<string>
required
Available options:
sms,
email,
whatsapp,
whatsapp_business,
imessage,
telegram
Allowed value: "sms"
projectId
string
required
Pattern: ^pho_prj_[0-7][0-9a-hjkmnp-tv-z]{25}$
sentBy
object
required
space
object
required
status
enum<string>
required
Available options:
dispatched,
accepted,
delivered,
failed
Allowed value: "received"
timestamps
object
required
updatedAt
string<date-time>
required

When Photon last persisted a change to this resource's public state.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
acceptance
any
addressedTo
object
failure
any
parentMessageId
string
Pattern: ^pho_msg_[0-7][0-9a-hjkmnp-tv-z]{25}$
receivedBy
object
timestamp
any