Notifications endpoints

Every endpoint in Notifications: 29 operations across 12 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.

Templates

GET/api/notifications/templates

List templates

curl -X GET https://app.jaicrm.ai/api/notifications/templates 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/notifications/templates/{id}

Read one template

curl -X GET https://app.jaicrm.ai/api/notifications/templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/notifications/templates

Create a template

curl -X POST https://app.jaicrm.ai/api/notifications/templates 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/notifications/templates/active

Create an active

curl -X POST https://app.jaicrm.ai/api/notifications/templates/active 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/notifications/templates/uninstall

Create an uninstall

curl -X POST https://app.jaicrm.ai/api/notifications/templates/uninstall 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/notifications/templates/{id}

Change a template

curl -X PATCH https://app.jaicrm.ai/api/notifications/templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/notifications/templates/{id}

Delete a template

curl -X DELETE https://app.jaicrm.ai/api/notifications/templates/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Queue

GET/api/notifications/queue

List queue

curl -X GET https://app.jaicrm.ai/api/notifications/queue 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/notifications/queue/hold

Create a hold

curl -X POST https://app.jaicrm.ai/api/notifications/queue/hold 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/notifications/queue/pause-all

Create a pause all

curl -X POST https://app.jaicrm.ai/api/notifications/queue/pause-all 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/notifications/queue/send

Create a send

curl -X POST https://app.jaicrm.ai/api/notifications/queue/send 
  -H 'Authorization: Bearer YOUR_API_KEY'

Inbox

GET/api/notifications/inbox

List inbox

curl -X GET https://app.jaicrm.ai/api/notifications/inbox 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/notifications/inbox/{id}/read

Create a read

curl -X POST https://app.jaicrm.ai/api/notifications/inbox/RECORD_ID/read 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/notifications/inbox/read-all

Create a read all

curl -X POST https://app.jaicrm.ai/api/notifications/inbox/read-all 
  -H 'Authorization: Bearer YOUR_API_KEY'

DELETE/api/notifications/inbox/{id}

Delete an inbox

curl -X DELETE https://app.jaicrm.ai/api/notifications/inbox/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Preferences

GET/api/notifications/preferences

List preferences

curl -X GET https://app.jaicrm.ai/api/notifications/preferences 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/notifications/preferences/mine

List mine

curl -X GET https://app.jaicrm.ai/api/notifications/preferences/mine 
  -H 'Authorization: Bearer YOUR_API_KEY'

PUT/api/notifications/preferences

Change a preference

curl -X PUT https://app.jaicrm.ai/api/notifications/preferences 
  -H 'Authorization: Bearer YOUR_API_KEY'

Library

GET/api/notifications/library

List library

curl -X GET https://app.jaicrm.ai/api/notifications/library 
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/api/notifications/library/install

Create an install

curl -X POST https://app.jaicrm.ai/api/notifications/library/install 
  -H 'Authorization: Bearer YOUR_API_KEY'

Log

GET/api/notifications/log

List log

curl -X GET https://app.jaicrm.ai/api/notifications/log 
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/notifications/log/{id}

Read one log

curl -X GET https://app.jaicrm.ai/api/notifications/log/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'

Settings

GET/api/notifications/settings

List settings

curl -X GET https://app.jaicrm.ai/api/notifications/settings 
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/notifications/settings

Change a setting

curl -X PATCH https://app.jaicrm.ai/api/notifications/settings 
  -H 'Authorization: Bearer YOUR_API_KEY'

Current

GET/api/announcements/current

List current

curl -X GET https://app.jaicrm.ai/api/announcements/current 
  -H 'Authorization: Bearer YOUR_API_KEY'

Dismiss

POST/api/announcements/{id}/dismiss

Create a dismiss

curl -X POST https://app.jaicrm.ai/api/announcements/RECORD_ID/dismiss 
  -H 'Authorization: Bearer YOUR_API_KEY'

Notifications

GET/api/notifications/

List notifications

curl -X GET https://app.jaicrm.ai/api/notifications/ 
  -H 'Authorization: Bearer YOUR_API_KEY'

Preview

POST/api/notifications/preview

Create a preview

curl -X POST https://app.jaicrm.ai/api/notifications/preview 
  -H 'Authorization: Bearer YOUR_API_KEY'

Tokens

GET/api/notifications/tokens/{moduleKey}

Read one token

curl -X GET https://app.jaicrm.ai/api/notifications/tokens/RECORD_ID 
  -H 'Authorization: Bearer YOUR_API_KEY'