v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Schedules

Remove schedule recipients

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

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

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

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

Example request

{
  "emails": [
    "user@example.com"
  ],
  "userGroupIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "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
}