v1

latestOpenAPI 3.0.1Apache 2.02026-07-13332183.6 KB
KKid

subscribes/unsubscribes/registers for apns push notifications

post/kkid/apns

Query parameters

kidUserIdinteger required

userID of the kid

tool'register' | 'subscribe' | 'unsubscribe' | 'send' required

tool you wish to talk to

tokenstring

device APNS token (required for register)

devicenamestring

Name of device to associate to token (required for register)

titlestring

title of APNS message (required for send)

messagestring

APNS message body (required for send)

badgeinteger

Number for badge icon (optional for send)

soundstring

Name of sound file to play for send notification (optional for send)

section'Chores' | 'Chores-New' | 'Chores-Reminders' | 'Allowance' | 'Allowance-New' | 'WishList'

Notification section name (required for send/subscribe/unsubscribe)

priority'passive' | 'active' | 'time-sensitive' | 'critical'

Notification section name (optional for send, default is active)

Response

search results matching criteria

successboolean
messagestring

Example response

{
  "success": true,
  "message": "success"
}