Create Reminder | whizboard

curl -X POST https://prod-whizboard-be-680473615767.asia-southeast1.run.app/api/v1/firms/firm_slug/clients/1/reminders \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "title": "string",
  "due_at": "2024-01-15T09:30:00Z",
  "recipients": [
    {
      "user_id": 1
    }
  ]
}'

{
  "data": {
    "id": 1,
    "firm_id": 1,
    "client_membership_id": 1,
    "title": "string",
    "description_html": "string",
    "due_at": "2024-01-15T09:30:00Z",
    "recurrence_type": "NONE",
    "custom_interval_days": 1,
    "monthly_day": 1,
    "status": "ACTIVE",
    "created_by_user_id": 1,
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "recipients": [
      {
        "user_id": 1,
        "user_email": "string",
        "user_name": "string",
        "delivery_role": "string"
      }
    ]
  },
  "status": "success"
}

Authentication

Authorizationstring

API Key authentication via header

Path parameters

membership_idintegerRequired

firm_slugstringRequired3-64 characters

Request

This endpoint expects an object.

titlestringRequired1-160 characters

due_atdatetimeRequired

recipientslist of objectsRequired

description_htmlstring or nullOptional<=20000 characters

recurrence_typeenumOptional

Supported reminder recurrence rules.

custom_interval_daysinteger or nullOptional1-3660

monthly_dayinteger or nullOptional1-28

Response

Successful Response

dataobject

statusstringOptionalDefaults to success

Errors

422

Unprocessable Entity Error