Setting a Reminder

You'll need:

• an access token
• an Account

Steps

1. Get entity Collaborators

List the Collaborators of the entity to which the Reminder should be linked (the "resource").

GET /api/v2/networks/sidedrawer/sidedrawer-id/{sidedrawerId}/networks

Here, the resource is: sidedrawer/{sidedrawerId} as the Reminder will be linked to a Drawer.

2. Create Reminder

Create the Reminder.

POST /api/v1/networks/reminders

Example Request Body

{
    "name": "My Reminder",
    "resource": "sidedrawer/{sidedrawerId}",
    "message": "This is what my reminder is about.",
    "schedule": {
        "startDate": "2024-08-27T12:16:00.000Z",
        "recurrent": {
            "frequency": "Daily",
            "iteration": 2,
            "pattern": "",
            "endDate": "2024-08-31T12:16:00.000Z",
            "skipCondition": "complete"
        }
    },
    "to": {
        "openIds": [
            "auth0|12345"
        ],
        "emails": []
    },
    "status": "active",
    "messageType": "scheduledReminder"
}

Example Response

{
    "resource": "sidedrawer/{sidedrawerId}",
    "user": "auth0|12345",
    "job": "string",
    "name": "My Reminder",
    "message": "This is what my reminder is about.",
    "messageType": "scheduledReminder",
    "status": "active",
    "statusDescription": [],
    "schedule": {
        "startDate": "2024-08-27T12:16:00.000Z",
        "recurrent": {
            "pattern": "",
            "iteration": 2,
            "frequency": "Daily",
            "endDate": "2024-08-31T12:16:00.000Z",
            "skipCondition": "complete"
        }
    },
    "to": {
        "openIds": [
            "auth0|12345"
        ],
        "emails": []
    },
    "_id": "{reminderId}",
    "createdAt": "2024-08-26T12:09:52.714Z",
    "updatedAt": "2024-08-26T12:09:52.714Z",
    "__v": 0
}

3. Get entity Collaborators (again)

List the Collaborators again.

GET /api/v2/networks/sidedrawer/sidedrawer-id/{sidedrawerId}/networks

4. List created Reminders

List the entity's Reminders.

GET /api/v1/networks/reminders?resource=sidedrawer/{resource}

Example Request Body

{
  "resource": "sidedrawer/{sidedrawerId}"
}

Example Response

[
    {
        "schedule": {
            "recurrent": {
                "pattern": "Fri",
                "iteration": 2,
                "frequency": "Weekly",
                "endDate": "2024-09-20T16:00:00.000Z",
                "skipCondition": "complete"
            },
            "startDate": "2024-08-09T16:00:00.000Z"
        },
        "to": {
            "openIds": [
                "auth0|12345"
            ],
            "emails": []
        },
        "resource": "sidedrawer/{sidedrawerId}",
        "user": "auth0|12345",
        "job": "string",
        "name": "My Reminder",
        "message": "This is what I want to be reminded of.",
        "messageType": "scheduledReminder",
        "status": "active",
        "statusDescription": [],
        "createdAt": "2024-08-08T19:28:58.530Z",
        "updatedAt": "2024-08-08T19:28:58.530Z",
        "id": "string",
        "active": true
    },
    {
        "schedule": {
            "recurrent": {
                "pattern": "",
                "iteration": 2,
                "frequency": "Daily",
                "endDate": "2024-08-31T12:16:00.000Z",
                "skipCondition": "complete"
            },
            "startDate": "2024-08-27T12:16:00.000Z"
        },
        "to": {
            "openIds": [
                "auth0|12345"
            ],
            "emails": []
        },
        "resource": "sidedrawer/{sidedrawerId}",
        "user": "auth0|12345",
        "job": "string",
        "name": "My Reminder",
        "message": "This is what my reminder is about.",
        "messageType": "scheduledReminder",
        "status": "active",
        "statusDescription": [],
        "createdAt": "2024-08-26T12:09:52.714Z",
        "updatedAt": "2024-08-26T12:09:52.714Z",
        "id": "{reminderId}",
        "active": true
    }
]