Add schedule recipients
Add one or more recipients to an existing scheduled email task. Recipients can be specified by email address, user ID, or user group ID.
This endpoint only works with schedules that have email destinations.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The ID of the schedule. To find a schedule's ID:
- Navigate to the dashboard or workbook.
- Click File > Deliveries & Alerts.
- Next to a schedule, click Edit.
The schedule's ID is in the page's URL, after /schedules/. For example, the schedule ID in this URL is 123e4567-e89b-12d3-a456-426614174000:
Body
At least one email, user ID, or user group ID must be provided. Array of email addresses to add as recipients.
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 endpoint to retrieve user group IDs.
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 and List embed users endpoints to retrieve user IDs.

