Skip to main content
PUT
/
v1
/
schedules
/
{scheduleId}
/
transfer-ownership
Transfer schedule ownership
curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/schedules/{scheduleId}/transfer-ownership \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true
}
Transfers 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. How ownership transfer affects schedule execution depends on the type of destination the schedule uses, and for email destinations, whether the Personalize delivery with the recipient’s user attributes is enabled:
Slack, SFTP, & WebhooksEmail without personalizationEmail with personalization
Future jobs are executed by…New ownerNew ownerEach recipient
Permissions, data access, & user attributes are based on…New ownerNew ownerEach recipient
Output is generated using…New owner accessNew owner accessRecipient access

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 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
​
userId
string<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 the dashboard associated with the schedule

Response

Ownership transferred successfully

​
success
boolean
Example:

true