api-docs v5.116.0

API Docs

Table of contents

Reminder

Account Reminder - Delete

Back to top

Delete a specific account reminder. Can only delete user owned.

DELETE /reminders/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/reminders/<reminder-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
schedule number

one-time scheduled date
interval string/number

cron-style format, number (ms), or human-readable interval
notifyPush string
notifyEmail string
templateId string

[Mailer]
title string
body string
type string Allowed values: account
account string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "account"
}

Account Reminder - Find

Back to top

Get list of account reminders

GET /reminders

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/reminders?type=account" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
reminders object[]

array of reminder
reminders.id string
reminders.createdAt number
reminders.createdBy string
reminders.schedule number

one-time scheduled date
reminders.interval string/number

cron-style format, number (ms), or human-readable interval
reminders.notifyPush string
reminders.notifyEmail string
reminders.templateId string

[Mailer]
reminders.title string
reminders.body string
reminders.type string Allowed values: account
reminders.account string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "type": "account"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid",
    "type": "account"
  }
]

Account Reminder - Get

Back to top

Get a specific account reminder

GET /reminders/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/reminders/<reminder-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
schedule number

one-time scheduled date
interval string/number

cron-style format, number (ms), or human-readable interval
notifyPush string
notifyEmail string
templateId string

[Mailer]
title string
body string
type string Allowed values: account
account string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "account"
}

Account Reminder - Patch

Back to top

Update account reminder

PATCH /reminders/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
notifyPush boolean optional
notifyEmail boolean optional
templateId string optional
title string optional
body string optional
type string Allowed values: account

Examples

Example usage:

curl "https://yourdomain.com/reminders/<reminder-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "title": "some title"
  }'

Parameters examples

json - Request-Example

{
  "title": "some title"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
schedule number

one-time scheduled date
interval string/number

cron-style format, number (ms), or human-readable interval
notifyPush string
notifyEmail string
templateId string

[Mailer]
title string
body string
type string Allowed values: account
account string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "account"
}

Account Reminder - Post

Back to top

Create account reminder

POST /reminders

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
schedule number optional
interval string/number optional
notifyPush boolean optional
notifyEmail boolean optional
templateId string optional
title string optional
body string optional
type string Allowed values: account
account string

Examples

Example usage:

curl "https://yourdomain.com/reminders" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "account",
    "title": "some title"
  }'

Parameters examples

json - Request-Example

{
  "type": "account",
  "title": "some title"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
schedule number

one-time scheduled date
interval string/number

cron-style format, number (ms), or human-readable interval
notifyPush string
notifyEmail string
templateId string

[Mailer]
title string
body string
type string Allowed values: account
account string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid",
  "type": "account"
}

results matching ""

    No results matching ""