Skip to main content
PUT
/
v1
/
reminders
/
{reminderId}
Update a reminder
curl --request PUT \
  --url https://api.prod.getdex.com/v1/reminders/{reminderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reminder": {
    "text": "<string>",
    "due_at_date": "2023-11-07T05:31:56Z",
    "due_at_time": "2023-11-07T05:31:56Z",
    "is_complete": true,
    "recurrence": "<string>",
    "reminders_contacts": [
      {
        "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contacts": "<unknown>"
      }
    ],
    "last_completed_at": "2023-11-07T05:31:56Z",
    "next_occurrence_at": "2023-11-07T05:31:56Z",
    "email_sent": true,
    "push_notification_sent": true
  }
}
'
{
  "error": true,
  "data": {
    "reminder": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "text": "<string>",
      "due_at_date": "<string>",
      "due_at_time": "<string>",
      "is_complete": true,
      "recurrence": "<string>",
      "last_completed_at": "<string>",
      "next_occurrence_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  }
}

Use cases

  • Reschedule a reminder to a different date
  • Mark a reminder as completed
  • Change the recurrence frequency of a keep-in-touch reminder
  • Reassign a reminder to a different contact

Authorizations

Authorization
string
header
required

Use your Dex API key (e.g. dex_abc123...) as the Bearer token.

Path Parameters

reminderId
string
required

Body

application/json
reminder
object
required

Response

Successful response

error
boolean
required
data
object
required