Reminders

Retrieve a reminder

GET

https://api.lelemon.cl

/v2/reminders/{id}

Bearer (API key)

Returns one reminder by id. Read only. 404 not_found when the id does not exist or belongs to another organization. You can repeat it safely: it has no side effects.

Required scope: cases:read.

Retrieve a reminder › path Parameters

id

string · pattern: ^rem_[0-9A-Za-z]{22}… · required

The id of the reminder (rem_…).

Retrieve a reminder › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Retrieve a reminder › Responses

Reminder

object

string · enum · required

Enum values:

reminder

id

string · required

caseId

string · required

title

string · required

description

string | null · required

type

string · enum · required

Enum values:

call

meeting

follow_up

task

other

priority

string · enum · required

Enum values:

low

medium

high

urgent

status

string · enum · required

pending until someone completes or dismisses it. overdue when its time passed and nobody did.

Enum values:

pending

in_progress

overdue

completed

dismissed

dueAt

string · date-time · required

assigneeId

string · required

completedAt

string | null · date-time · required

completionNote

string | null · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

Delete a reminder

DELETE

https://api.lelemon.cl

/v2/reminders/{id}

Bearer (API key)

Deletes the reminder. The effect is permanent through the API. Repeating the call returns 404 not_found, because the reminder no longer exists, so do not retry a 404 as a failure.

Required scope: cases:write.

Delete a reminder › path Parameters

id

string · pattern: ^rem_[0-9A-Za-z]{22}… · required

The id of the reminder (rem_…).

Delete a reminder › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Delete a reminder › Responses

No data returned

Edit a reminder

PATCH

https://api.lelemon.cl

/v2/reminders/{id}

Bearer (API key)

Changes the title, description, type, priority, due time or assignee. Applying the same body twice leaves the same result.

Required scope: cases:write.

Edit a reminder › path Parameters

id

string · pattern: ^rem_[0-9A-Za-z]{22}… · required

The id of the reminder (rem_…).

Edit a reminder › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Edit a reminder › Request Body optional

UpdateReminder

title

string · minLength: 1 · maxLength: 255

description

string · maxLength: 2000

type

string · enum

Enum values:

call

meeting

follow_up

task

other

priority

string · enum

Enum values:

low

medium

high

urgent

dueAt

string · date-time

assigneeId

string

Reassigns it. A reminder tied to a meeting made in the dashboard cannot be reassigned: 400 on assigneeId.

Edit a reminder › Responses

Reminder

object

string · enum · required

Enum values:

reminder

id

string · required

caseId

string · required

title

string · required

description

string | null · required

type

string · enum · required

Enum values:

call

meeting

follow_up

task

other

priority

string · enum · required

Enum values:

low

medium

high

urgent

status

string · enum · required

pending until someone completes or dismisses it. overdue when its time passed and nobody did.

Enum values:

pending

in_progress

overdue

completed

dismissed

dueAt

string · date-time · required

assigneeId

string · required

completedAt

string | null · date-time · required

completionNote

string | null · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

PATCH/v2/reminders/{id}

curl https://api.lelemon.cl/v2/reminders/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "dueAt": "2030-01-16T14:00:00.000Z"
}'

Example Request Body

{
  "dueAt": "2030-01-16T14:00:00.000Z"
}

json

application/json

Example Responses

{
  "object": "reminder",
  "id": "rem_4Zq0x8bVw1TqS9mYp3RkLd",
  "caseId": "cse_4Zq0x8bVw1TqS9mYp3RkLd",
  "title": "title",
  "description": "description",
  "type": "call",
  "priority": "low",
  "status": "pending",
  "dueAt": "2024-08-25T15:00:00Z",
  "assigneeId": "mbr_4Zq0x8bVw1TqS9mYp3RkLd",
  "completedAt": "2024-08-25T15:00:00Z",
  "completionNote": "completionNote",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Complete a reminder

POST

https://api.lelemon.cl

/v2/reminders/{id}/complete

Bearer (API key)

Marks it done, with an optional note of what happened. The key is saved as who completed it.

Required scope: cases:write.

Complete a reminder › path Parameters

id

string · pattern: ^rem_[0-9A-Za-z]{22}… · required

The id of the reminder (rem_…).

Complete a reminder › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Idempotency-Key

string · minLength: 1 · maxLength: 255

Makes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.

Complete a reminder › Request Body optional

CompleteReminder

completionNote

string · maxLength: 2000

What happened. It is saved with the reminder.

Complete a reminder › Responses

Reminder

object

string · enum · required

Enum values:

reminder

id

string · required

caseId

string · required

title

string · required

description

string | null · required

type

string · enum · required

Enum values:

call

meeting

follow_up

task

other

priority

string · enum · required

Enum values:

low

medium

high

urgent

status

string · enum · required

pending until someone completes or dismisses it. overdue when its time passed and nobody did.

Enum values:

pending

in_progress

overdue

completed

dismissed

dueAt

string · date-time · required

assigneeId

string · required

completedAt

string | null · date-time · required

completionNote

string | null · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

POST/v2/reminders/{id}/complete

curl https://api.lelemon.cl/v2/reminders/:id/complete \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "completionNote": "Talked to them."
}'

Example Request Body

{
  "completionNote": "Talked to them."
}

json

application/json

Example Responses

{
  "object": "reminder",
  "id": "rem_4Zq0x8bVw1TqS9mYp3RkLd",
  "caseId": "cse_4Zq0x8bVw1TqS9mYp3RkLd",
  "title": "title",
  "description": "description",
  "type": "call",
  "priority": "low",
  "status": "pending",
  "dueAt": "2024-08-25T15:00:00Z",
  "assigneeId": "mbr_4Zq0x8bVw1TqS9mYp3RkLd",
  "completedAt": "2024-08-25T15:00:00Z",
  "completionNote": "completionNote",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Dismiss a reminder

POST

https://api.lelemon.cl

/v2/reminders/{id}/dismiss

Bearer (API key)

The task is not needed anymore. It stays in the list.

Required scope: cases:write.

Dismiss a reminder › path Parameters

id

string · pattern: ^rem_[0-9A-Za-z]{22}… · required

The id of the reminder (rem_…).

Dismiss a reminder › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Idempotency-Key

string · minLength: 1 · maxLength: 255

Dismiss a reminder › Responses

Reminder

object

string · enum · required

Enum values:

reminder

id

string · required

caseId

string · required

title

string · required

description

string | null · required

type

string · enum · required

Enum values:

call

meeting

follow_up

task

other

priority

string · enum · required

Enum values:

low

medium

high

urgent

status

string · enum · required

pending until someone completes or dismisses it. overdue when its time passed and nobody did.

Enum values:

pending

in_progress

overdue

completed

dismissed

dueAt

string · date-time · required

assigneeId

string · required

completedAt

string | null · date-time · required

completionNote

string | null · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

Case reminders Presence