Update a notification schedule

Replaces the recipients, message, and time of a schedule that has not gone out yet.

PUT

https://api.portal.magicdoor.com/company-app/notifications/schedules/{notificationScheduleId}

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

notificationScheduleIdstringrequired

The schedule to change.

example: 1831310445621149696

Body

application/json

All three are replaced wholesale. There is no partial update.

targetobjectrequired

Who to send to.

templateobjectrequired

What to send.

timestring · date-timerequired

When to send it. Must be in the future.

example: 2026-08-28T09:00:00

Response

200 · The updated schedule.

idstring

The schedule.

sourceenum<string>

manual means someone set it up; system means MagicDoor created it itself, for example when onboarding finished.

systemmanual

targetobject

Who it will go to.

templateobject

What will be sent.

timestring · date-time

When it is due to go out.

statusenum<string>

pending means it has not run yet and can still be edited or deleted. skipped means MagicDoor decided not to send it.

pendingsentskippedfailed

sentstring · date-time

When it actually went out. Absent while pending.

failureReasonstring

Why it failed, when it did.

announcementIdstring

The announcement this schedule sends. Present on a schedule created by scheduling an announcement.

createdstring · date-time

When the schedule was set up.

400 · `time` is not in the future, `subject` is blank, neither `emailMessage` nor `textMessage` was given, or one of them uses placeholder syntax MagicDoor cannot parse.

401 · The access token is missing, expired, or not valid.

404 · No notification schedule with that id belongs to your company.

422 · The schedule has already run. Only a `pending` schedule can be changed.

curl --request PUT \ --url 'https://api.portal.magicdoor.com/company-app/notifications/schedules/1831310445621149696' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "target": { "type": "Tenant", "hasBalanceDue": true }, "template": { "subject": "Rent is due Monday", "emailMessage": "A reminder that rent is due on Monday.", "textMessage": "A reminder that rent is due on Monday." }, "time": "2026-08-28T09:00:00" }'

{ "target": { "type": "Tenant", "hasBalanceDue": true }, "template": { "subject": "Rent is due Monday", "emailMessage": "A reminder that rent is due on Monday.", "textMessage": "A reminder that rent is due on Monday." }, "time": "2026-08-28T09:00:00" }

{ "id": "1831310445621149696", "source": "manual", "target": { "type": "Tenant", "hasBalanceDue": true }, "template": { "subject": "Rent is due Monday", "emailMessage": "A reminder that rent is due on Monday.", "textMessage": "A reminder that rent is due on Monday." }, "time": "2026-08-28T09:00:00", "status": "pending", "created": "2026-08-17T14:52:11" }