Skip to main content
PUT
/
v1
/
schedules
/
{scheduleId}
/
remove-recipients
Remove schedule recipients
curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/schedules/{scheduleId}/remove-recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "jsmith@example.com"
  ],
  "userIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "removedRecipientsCount": 123,
  "success": true
}

Authorizations

​
Authorization
string
header
required

Use 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

Schedule ID

Body

application/json
​
emails
string<email>[]

Email addresses to remove

​
userIds
string<uuid>[]

User IDs to remove

Response

Recipients removed successfully

​
removedRecipientsCount
integer
​
success
boolean