web_message_schedule_apply

publ Reference
# web_message_schedule_apply

Edit or deactivate an inactive web message schedule in the Web Message app (pApp F00001). Title/body/link/PWA/marketing options and a ONCE/DAILY/WEEKLY recurrence with explicit UTC time; the link must contain channels/{the channel code}; app push needs the branded app. Write; active schedules use web_delivery_apply. Cannot send. A lost receipt stays pending and is never resent; task_resume only observes, and prepared work needs the identical apply. Called without confirmToken it previews and returns a confirmToken; repeating the same input with it executes once.

## Inputs

| Field | Required here | Contract |
| --- | --- | --- |
| `settings` | Yes | one of: `deactivate`, `edit` (by `action`) |
| `settings.title` | No | When `settings.action` is `edit`: string; min length 1; max length 40 |
| `settings.body` | No | When `settings.action` is `edit`: string; min length 2; max length 200 |
| `settings.linkUri` | No | When `settings.action` is `edit`: `` or string; format `uri` |
| `settings.isSendPwaPush` | No | When `settings.action` is `edit`: boolean |
| `settings.isMarketingMessage` | No | When `settings.action` is `edit`: boolean |
| `settings.schedule` | No | When `settings.action` is `edit`: one of: `ONCE`, `DAILY`, `WEEKLY` (by `type`); ONCE, DAILY or WEEKLY recurrence; switching type replaces the previous type's fields, as in the console. Date-times carry an offset; scheduleTime and daysOfWeek are UTC (Sunday 0). |
| `settings.schedule.sendAt` | Yes | When `settings.action` is `edit` and `settings.schedule.type` is `ONCE`: string; pattern `^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$`; format `date-time` |
| `settings.schedule.startAt` | Yes | When `settings.action` is `edit` and `settings.schedule.type` is `DAILY`: string; pattern `^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$`; format `date-time` |
| `settings.schedule.endAt` | Yes | When `settings.action` is `edit` and `settings.schedule.type` is `DAILY`: string; pattern `^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$`; format `date-time` |
| `settings.schedule.scheduleTime` | Yes | When `settings.action` is `edit` and `settings.schedule.type` is `DAILY`: string; pattern `^(?:[01]\d\|2[0-3]):[0-5]\d$` |
| `settings.schedule.timeZone` | No | When `settings.action` is `edit` and `settings.schedule.type` is `DAILY`: string; max length 100; IANA timezone used for the source minimum-start-calendar-date rule. Defaults to UTC; scheduleTime and weekday values remain UTC. |
| `settings.schedule.startAt` | Yes | When `settings.action` is `edit` and `settings.schedule.type` is `WEEKLY`: string; pattern `^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$`; format `date-time` |
| `settings.schedule.endAt` | Yes | When `settings.action` is `edit` and `settings.schedule.type` is `WEEKLY`: string; pattern `^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$`; format `date-time` |
| `settings.schedule.scheduleTime` | Yes | When `settings.action` is `edit` and `settings.schedule.type` is `WEEKLY`: string; pattern `^(?:[01]\d\|2[0-3]):[0-5]\d$` |
| `settings.schedule.timeZone` | No | When `settings.action` is `edit` and `settings.schedule.type` is `WEEKLY`: string; max length 100; IANA timezone used for the source minimum-start-calendar-date rule. Defaults to UTC; scheduleTime and weekday values remain UTC. |
| `settings.schedule.daysOfWeek` | Yes | When `settings.action` is `edit` and `settings.schedule.type` is `WEEKLY`: array; items: integer; minimum 0; maximum 6; min items 1; max items 7 |
| `scheduleId` | Yes | integer; greater than 0 |
| `confirmToken` | No | string; pattern `^ct[a-f\d]{32}$`; The confirmToken from this tool's preview result. Omit it to preview; repeat the same input with it to execute. |