DevelopersHow to connect an assistantKeys
Reference/Reminders/Change

Snooze a reminder

POSThttps://api.getwerk.ai/api/v1/projects/{projectId}/cards/{cardId}/reminders/{reminderId}/snooze

Moves when a reminder on a card goes off for the key's person: an hour from now, or tomorrow.

It works on their own reminders and on ones shared with them, and changes the time for them alone.

Authorization

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Path parameters

projectIdstring, uuidRequired

The project's id.

cardIdstring, uuidRequired

The card's id.

reminderIdstring, uuidRequired

The reminder's id.

Body

clientRequestIdstring, uuidRequired

An id the caller makes for this request. Sent again with the same request, it returns the first answer and changes nothing twice; sent with a different request, it is refused.

expectedVersionintegerRequired

The reminder's version as last read; when it changed since, the change is refused.

At least 1
expectedTimeRevisionintegerRequired

The reminder's timeRevision as last read; when its time changed since, the change is refused.

At least 1
expectedSnoozeRevisionintegerRequired

The reminder's snoozeRevision as last read; when it was snoozed since, the change is refused.

At least 0
optionenumRequired

hour snoozes it one hour from now; tomorrow, to tomorrow at the time of the key's person's daily brief.

Allowed valueshourtomorrow

Response

200 What the request did.

kindenum

applied when the change was made, unchanged when it already held.

Allowed valuesappliedunchanged
idstring, uuid

The id of the thing changed.

versioninteger

Its version after the request.

At least 1

Errors

400invalid_queryThe query is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
400invalid_messageThe message or reminder request is not in the form its route takes, or names a card its reminder is not on; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).
400personal_reminder_invalid_timeThe reminder's time is not one a reminder can be set to.
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
404conversation_not_foundThe project the request names, or its chat, is not one the signed-in person is in.
404item_not_foundThe card the request names, or its list, is not one the signed-in person can see.
404personal_reminder_not_foundThe reminder the request names is not one the signed-in person can reach.
409session_changedThe session changed while the request was in flight.
409project_deletedThe project is being deleted.
409project_archivedThe project is archived, so it does not take this request.
409request_conflictThe request id was already used with another request, or the change it asks could not be made to the record it names.
409request_erasedThe request id belongs to a request whose record was erased.
409personal_reminder_staleThe reminder or its card changed after the version the request names.
413payload_too_largeThe request body has more bytes than the route takes.
rate_limitedMore requests of this kind were sent than Werk takes within the time it counts them over.
500server_errorThe server could not complete the request, and it is not known whether a write it holds was made.
curl
curl -X POST "https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48/reminders/7b4f2c91-5e8a-4d36-9a1c-3e7d0b5f2c84/snooze" \
  -H "Authorization: Bearer wk_key_..." \
  -H "Content-Type: application/json" \
  -d '{
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a09",
    "expectedVersion": 1,
    "expectedTimeRevision": 1,
    "expectedSnoozeRevision": 0,
    "option": "hour"
  }'
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards/3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48/reminders/7b4f2c91-5e8a-4d36-9a1c-3e7d0b5f2c84/snooze", {
  method: "POST",
  headers: {
    Authorization: "Bearer wk_key_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a09",
    "expectedVersion": 1,
    "expectedTimeRevision": 1,
    "expectedSnoozeRevision": 0,
    "option": "hour"
  }),
});
const answer = await res.json();
200JSON
{
  "kind": "applied",
  "id": "7b4f2c91-5e8a-4d36-9a1c-3e7d0b5f2c84",
  "version": 1
}