Update Reminder

PUT 
/api/reminders/:id

Update Reminder

Request

Path Parameters

id integerrequired

Header Parameters

X-Company-Slug stringrequired

application/json

Body

name stringrequired
sms_content string
email_content string
timezone string
frequency ReminderFrequencyEnum (string)required

Possible values: [once, daily, weekly, biweekly, monthly, yearly]

starts_at stringrequired
finishes_at date
next_run_at date
contact_id number

Responses

200

Successful response

application/json

Schema

Schema

id string
example
contact_id string
type stringnullable
name string
sms_content stringnullable
frequency ReminderFrequencyEnum (string)

Possible values: [once, daily, weekly, biweekly, monthly, yearly]

timezone string
starts_at date-time
finishes_at date-timenullable
next_run_at date-time
created_at date-time
updated_at date-time
email_content stringnullable

Example (from schema)

{
  "id": "string",
  "contact_id": "3",
  "type": null,
  "name": "test name 222",
  "sms_content": "sms ile gidecek mesaj",
  "frequency": "once",
  "timezone": "UTC+2",
  "starts_at": "2023-12-11T14:00:00.000+03:00",
  "finishes_at": "2023-12-11T14:00:00.000+03:00",
  "next_run_at": "2023-12-11T12:00:00.000+03:00",
  "created_at": "2024-08-02T14:37:00.969+03:00",
  "updated_at": "2024-08-02T14:37:00.969+03:00",
  "email_content": "email ile gidecek body"
}

Loading...