Reminders

All Reminders

You can get a list of all the entity-events of an entity by using the following endpoint.

{warning} Remember that all endpoints documented here need to be prefixed with 1.0/campaigns/{campaign.id}/.

Method URI Headers
GET/HEAD entities/{entity.id}/reminders Default

Results

{
    "data": [
        {
            "calendar_id": 7,
            "comment": "Recurring event",
            "created_at":  "2019-01-30T00:01:44.000000Z",
            "created_by": null,
            "date": "2-1-5",
            "remindable_id": 1085,
            "remindable_type": "App/Models/Entity",
            "id": 60,
            "is_private": false,
            "is_recurring": true,
            "recurring_periodicity": "yearly",
            "length": 1,
            "recurring_until": null,
            "type_id": null,
            "updated_at":  "2019-08-29T13:48:54.000000Z",
            "updated_by": null,
            "visibility_id": 1,
            "year": 1
        }
    ]
}

Reminder

To get the details of a single entity-event, use the following endpoint.

Method URI Headers
GET/HEAD entities/{entity.id}/entity_events/{entity_event.id} Default

Results

{
    "data": {
        "calendar_id": 7,
        "comment": "Recurring event",
        "created_at":  "2019-01-30T00:01:44.000000Z",
        "created_by": null,
        "date": "2-1-5",
        "remindable_id": 1085,
        "remindable_type": "App/Models/Entity",
        "id": 60,
        "is_private": false,
        "is_recurring": true,
        "recurring_periodicity": "yearly",
        "length": 1,
        "recurring_until": null,
        "type_id": null,
        "updated_at":  "2019-08-29T13:48:54.000000Z",
        "updated_by": null,
        "visibility_id": 1,
        "year": 1
    }
}

Create an Reminder

To create an entity-event, use the following endpoint.

Method URI Headers
POST entities/{entity.id}/entity_events Default

Body

Parameter Type Detail
name string (Required) Name of the reminder
day integer (Required) Day on which the event takes place
month integer (Required) Month (id) on which the event takes place
year integer (Required) Year on which the event takes place
length integer (Required) Duration in days of the event
recurring_periodicity string Null if the event isn't recurring. yearly, monthly or {moon.id}_(f |n) where f is full moon and n is new moon
recurring_until integer Year until the event reoccurs
colour string Colour of the reminder in the calendar
comment string Comment of the reminder
calendar_id integer (Required) The calendar\'s id
is_private boolean If the reminder is only visible to admin members of the campaign
type_id null or int Special field for calculating the age of a character. 2 for birthday, 3 for death.
visibility_id int The visibility ID: 1 for all, 2 self, 3 admin, 4 self-admin or 5 members.

Results

{success} Code 200 with JSON body of the new entity-event.

Update an Reminder

To update an entity-event, use the following endpoint.

Method URI Headers
PUT/PATCH entities/{entity.id}/entity_events/{entity_event.id} Default

Body

The same body parameters are available as for when creating an entity-event.

Results

{success} Code 200 with JSON body of the updated entity-event.

Delete an Reminder

To delete an entity-event, use the following endpoint.

Method URI Headers
DELETE entities/{entity.id}/entity_events/{entity_event.id} Default

Results

{success} Code 200 with JSON.