SUsurense
Reminders

Create a reminder

Create a new reminder.

post/reminders

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/reminders
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: global:user

Request body

descriptionstring required

Reminder description

notesstring

Reminder additional notes

dueDatestring required

Due date and time

dueDateTimeSetboolean required

Whether the due date time is set

delegatedIdstring

Delegated user ID

notifyMode'Disabled' | 'OnDueDate' | 'TenMinutesBefore' | 'OneHourBefore'

Notification mode:<br/>Disabled - No notification<br/>OnDueDate - Notify on due date<br/>TenMinutesBefore - Notify 10 minutes before<br/>OneHourBefore - Notify 1 hour before

customerIdstring

Customer ID

Example request

{
  "description": "Follow up with client",
  "dueDate": "2024-12-31T15:30:00Z",
  "dueDateTimeSet": true,
  "delegatedId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

OK

tenantIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
descriptionstring
notesstring
dueAtstring date-time
dueAtTimeSetboolean
delegatedIdstring uuid
notifyMode'Disabled' | 'OnDueDate' | 'TenMinutesBefore' | 'OneHourBefore'
doneboolean
customerIdstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.