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

# Remove schedule recipients

`PUT /api/v1/schedules/{scheduleId}/remove-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

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

## Response `200`

Recipients removed successfully

- SchedulesRemoveRecipientsResponse
  - `removedGroupRecipientsCount` number, required — Number of user group recipients removed.
  - `removedRecipientsCount` number, required — Number of individual recipients removed.
  - `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)