inChurch
inChurch API

Push Notification

Endpoint:https://inradar.com.br/public

List Push Notifications

GET
https://inradar.com.br/public
/v1/push/

Get a list of push notifications based on the user's access level.

List Push Notifications › query Parameters

  • limitinteger

    Number of results to return per page.

  • offsetinteger

    The initial index from which to return the results.

List Push Notifications › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

List Push Notifications › Responses

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

Create a Push Notification

POST
https://inradar.com.br/public
/v1/push/

Create a new push notification for a specific level or list of users.

Create a Push Notification › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

  • Content-Typestring · enum · required
    Enum values:
    application/json

Create a Push Notification › Request Body

  • messagestring · minLength: 1 · required
  • titlestring · minLength: 1 · maxLength: 160
  • imagestring | null · binary
  • redirect_urlstring | null · uri · maxLength: 2000
  • scheduled_datetimestring | null · date-time
  • recurrence_config | null
  • deeplink_conf | null
  • onesignal_idsstring | null
  • regional_idinteger | null
  • church_idinteger | null
  • targetsinteger[]

Create a Push Notification › Responses

  • idinteger · readOnly · required
  • messagestring · required
  • delivery_statusstring · readOnly · required
  • status_messagestring · readOnly · required
  • provider_responsereadOnly · required
  • titlestring · maxLength: 160
  • imagestring | null · uri
  • redirect_urlstring | null · uri · maxLength: 2000
  • scheduled_datetimestring | null · date-time
  • recurrence_config | null
  • deeplink_conf | null
  • onesignal_idsstring | null
  • regional_idinteger | null
  • church_idinteger | null
  • targetsinteger[]

Retrieve a Push Notification

GET
https://inradar.com.br/public
/v1/push/{id}/

Get detailed information about a specific push notification.

Retrieve a Push Notification › path Parameters

  • idinteger · required

    A unique integer value identifying this in church push notification.

Retrieve a Push Notification › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

Retrieve a Push Notification › Responses

  • idinteger · readOnly · required
  • messagestring · required
  • delivery_statusstring · readOnly · required
  • status_messagestring · readOnly · required
  • provider_responsereadOnly · required
  • titlestring · maxLength: 160
  • imagestring | null · uri
  • redirect_urlstring | null · uri · maxLength: 2000
  • scheduled_datetimestring | null · date-time
  • recurrence_config | null
  • deeplink_conf | null
  • onesignal_idsstring | null
  • regional_idinteger | null
  • church_idinteger | null
  • targetsinteger[]

Delete a Push Notification

DELETE
https://inradar.com.br/public
/v1/push/{id}/

Delete a push notification.

Delete a Push Notification › path Parameters

  • idinteger · required

    A unique integer value identifying this in church push notification.

Delete a Push Notification › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

Delete a Push Notification › Responses

No response body

No data returned

Update a Push Notification

PATCH
https://inradar.com.br/public
/v1/push/{id}/

Update information about a specific push notification.

Update a Push Notification › path Parameters

  • idinteger · required

    A unique integer value identifying this in church push notification.

Update a Push Notification › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

  • Content-Typestring · enum · required
    Enum values:
    application/json

Update a Push Notification › Request Body

  • titlestring · minLength: 1 · maxLength: 160
  • messagestring · minLength: 1
  • imagestring | null · binary
  • redirect_urlstring | null · uri · maxLength: 2000
  • scheduled_datetimestring | null · date-time
  • recurrence_config | null
  • deeplink_conf | null
  • onesignal_idsstring | null
  • regional_idinteger | null
  • church_idinteger | null
  • targetsinteger[]

Update a Push Notification › Responses

  • idinteger · readOnly · required
  • messagestring · required
  • delivery_statusstring · readOnly · required
  • status_messagestring · readOnly · required
  • provider_responsereadOnly · required
  • titlestring · maxLength: 160
  • imagestring | null · uri
  • redirect_urlstring | null · uri · maxLength: 2000
  • scheduled_datetimestring | null · date-time
  • recurrence_config | null
  • deeplink_conf | null
  • onesignal_idsstring | null
  • regional_idinteger | null
  • church_idinteger | null
  • targetsinteger[]
PeoplePayments - Subscription