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

# Add schedule recipients

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

## Request

- Base URL: `https://blobsrus.omniapp.co/api`
- URL: `https://blobsrus.omniapp.co/api/v1/schedules/{scheduleId}/add-recipients`
- Auth: HTTP bearer

Add one or more recipients to an existing scheduled email task. Recipients can be specified by email address, user ID, or user group ID.

<Note>
  This endpoint only works with schedules that have [email destinations](/share/deliveries/email).
</Note>

## Path parameters

- `scheduleId` string, uuid, required

## Request body

- object
  - `emails` string[]: **At least one email, user ID, or user group ID must be provided.** Array of email addresses to add as recipients.
  - `userGroupIds` string[]: **At least one email, user ID, or user group ID must be provided.** Array of user group IDs to add as recipients. Use the [List user groups](/api/user-groups/list-user-groups) endpoint to retrieve user group IDs.
  - `userIds` string[]: **At least one email, user ID, or user group ID must be provided.** Array of user UUIDs to add as recipients. Use the [List users](/api/users#list-users) and [List embed users](/api/users#list-embed-users) endpoints to retrieve user IDs.

## Response `200`

Recipients added successfully.

- object
  - `addedRecipientsCount` integer: The number of recipients added to the schedule.
  - `success` boolean: Indicates whether the operation was successful.

## Other responses

- `400`: Bad Request. Possible error messages include: - `userIds: Invalid uuid` - `userGroupIds: Invalid user group ID` - returned for an unknown ID, a full user group UUID, or an embed user group's ID - `emails: Invalid email address` - `Please provide either valid email addresses, valid user IDs, or both` - `At least one recipient must be provided` - `{parameter}: Array must contain at least 1 element(s)` - `Invalid recipient(s): The following members do not exist or do not have access to this organization: {userId}` - `Cannot add recipients to destination type {destinationType}`
- `404`: Not Found. Possible error messages include: - `Scheduled task with id {scheduleId} does not exist`
- `405`: Method Not Allowed - Invalid HTTP method for this endpoint
- `429`: Too Many Requests - Rate limit exceeded (60 requests/minute)

## Changes

- **2026-11-03** `43290040f88f`: 7 info
  - the endpoint scheme security `bearerAuth` was added to the API
  - added optional request body
  - added the non-success response with the status `400`
  - added the non-success response with the status `404`
  - …3 more

[Operation history](https://skmtc.dev/omni/apis/omni-api/changes/v1/schedules/:scheduleId/add-recipients/put.md)

---

[API](https://skmtc.dev/omni/apis/omni-api.md) - [All operations](https://skmtc.dev/omni/apis/omni-api/llms.txt) - [OpenAPI document](https://skmtc.dev/omni/apis/omni-api/revisions/43290040f88f?raw)