Remove schedule recipients
Remove one or more recipients from an existing scheduled email task. Recipients can be specified by email address or user 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 of a document.
- 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 or user ID must be provided. Array of recipient email addresses to remove from the scheduled task.
At least one email or user ID must be provided. Array of recipient membership IDs to remove from the scheduled task. Use the List users and List embed users endpoints to retrieve user IDs.
Each ID removes only the single recipient with that membership ID. This is applicable to embed users: multiple embed users in the same organization can share the same embed_email, but removing one by user ID won't remove other users that share the email address. To remove every recipient delivered to a given address, use emails instead.

