SMsmokeball
Events

Update a reminder for an event

Changed on

Updates an existing reminder for an event.

Offset must be between 0 and 100. OffsetType must be one of: Minute, Hourly, Daily, Weekly, Monthly. Daily means working days only, not every calendar day. Non-working days (weekends) are skipped, so a Daily reminder is never sent on a non-working day. OffsetTypeId is deprecated, use OffsetType instead. If OffsetTypeId is also supplied it must match OffsetType (1 = Minute, 2 = Hourly, 3 = Daily, 4 = Weekly, 5 = Monthly), otherwise the request is rejected. UserIds must contain at least one user id.

put/events/{eventId}/reminders/{reminderId}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/events/{eventId}/reminders/{reminderId}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

eventIdstring required
reminderIdstring required

Request body

offsetinteger
offsetTypeIdinteger
offsetTypestring nullable
isAllDayReminderboolean
userIdsstring[] nullable

Response

When request is accepted. Returns a 'Link' object for the updated reminder.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

  • 6e350cf667d4Revision changes
    • info

      added the new optional request property //// (media type: application/json-patch+json)

    • info

      added the new optional request property //// (media type: application/json)

    • info

      added the new optional request property //// (media type: application/*+json)

    • info

      added the non-success response with the status