Complete a reminder | Sample

1 parameter · 1 body field

tokenstringoptional

Authentication token with the `reminders:write` scope.

Form-encoded reminder completion details.

reminderstringoptional

The ID of the reminder to be marked as complete

2 status codes

200Confirms that the reminder was marked as complete.

okbooleanrequired

Allowed:true

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_foundcannot_complete_recurringcannot_complete_othersnot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arg

okbooleanrequired

Allowed:false

Error handling

The token must grant the reminders:write scope when authentication is required. reminder must identify the reminder to complete, and recurring reminders or reminders belonging to another user cannot be completed through this operation.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.remindersComplete.create({ reminder: "example" });

{
  "ok": true
}

Request

Response

Errors