atlas

Create Inbox Message

Create Inbox Message

post/atlas/v1/inbox-messages

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/atlas/v1/inbox-messages
  • Auth: OAuth 2 (implicit, authorization URL "")

Request body

category'ANNOUNCEMENT' | 'CAMPAIGN' required
effectiveFromstring required
namestring required

Response

InboxMessage

category'ANNOUNCEMENT' | 'CAMPAIGN'
createdAtstring
createdBystring
effectiveFromstring
idstring
isEffectiveboolean
namestring
parentIdstring

ParentID for jumping to parent detail page

parentType'GLOBAL_BANNER' | 'POP_UP' | 'NO_PARENT'
status'DRAFT' | 'ACTIVE'
updatedAtstring
updatedBystring

Changes

No recorded changes to this operation across all 1 revision of this API.