OMomniapp
Schedules

Remove schedule recipients

Changed on
put/api/v1/schedules/{scheduleId}/remove-recipients

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/schedules/{scheduleId}/remove-recipients
  • Auth
    HTTP bearer

Path parameters

scheduleIdstring uuid required

The UUID of the scheduled task. Can be found in the schedule's URL after /schedules/.

Example:123e4567-e89b-12d3-a456-426614174000

Request body

emailsstring[]

At least one email, userId, or userGroupId must be provided. Array of recipient email addresses to remove from the scheduled task.

userGroupIdsstring[]

At least one email, userId, or userGroupId must be provided. Array of user group IDs to remove as recipients.

userIdsstring[]

At least one email, userId, or userGroupId must be provided. Array of recipient user UUIDs to remove from the scheduled task. Use the List users and List embed users endpoints to retrieve user IDs. Each ID removes only that user, whereas an entry in emails removes every recipient delivered to that address.

Example request

{
  "emails": [
    "user@example.com"
  ],
  "userGroupIds": [
    "X9kQ2mPz"
  ],
  "userIds": [
    "987fcdeb-51a2-43d7-9b56-254415f67890"
  ]
}

Response

Recipients removed successfully

removedGroupRecipientsCountnumber required

Number of user group recipients removed.

removedRecipientsCountnumber required

Number of individual recipients removed.

successboolean required

Whether the operation was successful.

Example response

{
  "removedGroupRecipientsCount": 1,
  "removedRecipientsCount": 2,
  "success": true
}

Changes

  • dfcc576cd5f8Revision changes
    • breaking

      the / request property's minLength was increased from 0 to 1

    • info

      the / request property format was generalized from uuid to no format