Skip to main content
PUT
/
v1
/
schedules
/
{scheduleId}
/
add-recipients
Add schedule recipients
curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/schedules/{scheduleId}/add-recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "[email protected]"
  ],
  "userIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "addedRecipientsCount": 2,
  "success": true
}
Adds one or more recipients to 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

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
scheduleId
string<uuid>
required

The ID of the schedule to add recipients to. To find a schedule's ID:

  1. Navigate to the dashboard of a document.
  2. Click File > Deliveries & Alerts.
  3. 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:

https://blobsrus.omniapp.co/dashboards/e23ebaa0/schedules/123e4567-e89b-12d3-a456-426614174000

Body

application/json
​
emails
string<email>[]

At least one email or user ID must be provided. Array of email addresses to add as recipients.

​
userIds
string<uuid>[]

At least one email or user 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.

Response

Recipients added successfully.

​
addedRecipientsCount
integer

The number of recipients added to the schedule.

​
success
boolean

Indicates whether the operation was successful.