Mobile

POST /v2/mobile/announcements

Changed on

Request

  • Base URL
    https://api.peer.xyz
  • URL
    https://api.peer.xyz/v2/mobile/announcements
  • Auth
    API key in header x-api-key

Request body

titlestring
headingstring required
bodystring
imageUrlstring
imageBackgroundColorstring
skippableboolean required
frequency'once' | 'until-dismissed' | 'every-launch' required
platformsstring[]
minAppVersionstring nullable
maxAppVersionstring nullable
startsAtstring nullable
endsAtstring nullable
prioritynumber required
idstring required
enabledboolean required

Response

Announcement created

successboolean required
messagestring required
statusCodenumber required
errorCodestring

Changes