OMomni
Schedules

Transfer schedule ownership

Changed on

Transfer ownership of a schedule from one user to another user in the same organization. New ownership will be immediate and can't be reversed using this endpoint.

put/v1/schedules/{scheduleId}/transfer-ownership

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/schedules/{scheduleId}/transfer-ownership
  • 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

userIdstring uuid required

The ID of the user to transfer schedule ownership to. Use the List users endpoint to retrieve user IDs.

The new owner must:

  • Be a member of the same organization
  • Not be the current owner
  • Have permission to view and schedule the document the schedule delivers (dashboard or workbook)

Response

Ownership transferred successfully

successboolean

Example response

{
  "success": true
}

Changes

  • 43290040f88fRevision changes
    • breaking

      added required request body

    • info

      the endpoint scheme security bearerAuth was added to the API

    • 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 non-success response with the status

    • info

      added the success response with the status