Skip to main content
POST
/
events
/
{eventId}
/
reminders
Create reminder for an event
curl --request POST \
  --url https://api.smokeball.com/events/{eventId}/reminders \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "offset": 10,
  "offsetTypeId": 1,
  "isAllDayReminder": false,
  "userIds": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
eventId
string
required

Body

​
offset
integer<int32>

Offset of the reminder.

Value must be between 0 and 100.

Example:

10

​
offsetTypeId
integer<int32>

Offset Type id of the reminder.

Possible values: 1 = Minute

2 = Hourly
        
3 = Daily
        
4 = Weekly
        
5 = Monthly
Example:

1

​
isAllDayReminder
boolean

Boolean flag indicating if the reminder is an all day reminder.

Example:

false

​
userIds
string[] | null

Array of unique identifier of the users of the reminder.

Response

When request is accepted. Returns a 'Link' object.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET