OMomni
Schedule recipients

Add schedule recipients

Changed on

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>
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

Path parameters

scheduleIdstring uuid required

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

  1. Navigate to the dashboard or workbook.
  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

Request body

emailsstring[]

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

userGroupIdsstring[]

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.

userIdsstring[]

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.

Example request

{
  "userGroupIds": [
    "X9kQ2mPz"
  ]
}

Response

Recipients added successfully.

addedRecipientsCountinteger

The number of recipients added to the schedule.

successboolean

Indicates whether the operation was successful.

Changes

  • 43290040f88fRevision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      added optional request body

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status