v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Schedules

Add schedule recipients

put/api/v1/schedules/{scheduleId}/add-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 email addresses to add as recipients.

userGroupIdsstring[]

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

userIdsstring[]

At least one email, userId, or userGroupId must be provided. Array of user UUIDs to add as recipients. 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 added successfully

addedGroupRecipientsCountnumber required

Number of user group recipients added.

addedRecipientsCountnumber required

Number of individual recipients added.

successboolean required

Whether the operation was successful.

Example response

{
  "addedGroupRecipientsCount": 1,
  "addedRecipientsCount": 2,
  "success": true
}