---
title: "Add schedule recipients"
method: PUT
path: "/api/v1/schedules/{scheduleId}/add-recipients"
tags: ["Schedules"]
---

# Add schedule recipients

`PUT /api/v1/schedules/{scheduleId}/add-recipients`

## Path parameters

- `scheduleId` string, uuid, required — The UUID of the scheduled task. Can be found in the schedule's URL after /schedules/.

## Request body

- SchedulesAddRecipientsBody
  - `emails` string[] — At least one email, userId, or userGroupId must be provided. Array of email addresses to add as recipients.
  - `userGroupIds` string[] — At least one email, userId, or userGroupId must be provided. Array of user group UUIDs to add as recipients.
  - `userIds` string[] — At least one email, userId, or userGroupId must be provided. Array of user UUIDs to add as recipients. Use the List users and List embed users endpoints to retrieve user IDs.

## Response `200`

Recipients added successfully

- SchedulesAddRecipientsResponse
  - `addedGroupRecipientsCount` number, required — Number of user group recipients added.
  - `addedRecipientsCount` number, required — Number of individual recipients added.
  - `success` boolean, required — Whether the operation was successful.

## Other responses

- `400` — Invalid request body - at least one email, userId, or userGroupId required
- `401` — Authentication required
- `403` — Permission denied
- `404` — Schedule not found

---

[API](https://skmtc.net/omniapp/apis/omni-api.md) · [All operations](https://skmtc.net/omniapp/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omniapp/omni-api/versions/4701f292c621/schema)